summaryrefslogtreecommitdiff
path: root/beam_tracing/python/README.txt
diff options
context:
space:
mode:
authorEugeniy Mikhailov <evgmik@gmail.com>2013-02-28 14:59:55 -0500
committerEugeniy Mikhailov <evgmik@gmail.com>2013-02-28 14:59:55 -0500
commite4360a48435cc762855d356b208b5544e6f40c4b (patch)
tree71c6c83c247cb07495265b93ec062eefc3e928a8 /beam_tracing/python/README.txt
parenta08ed173692ce16b79002733003049ec32a02485 (diff)
downloadwgmr-e4360a48435cc762855d356b208b5544e6f40c4b.tar.gz
wgmr-e4360a48435cc762855d356b208b5544e6f40c4b.zip
Added python version of mode-matching code by Bain Bronner
Diffstat (limited to 'beam_tracing/python/README.txt')
-rw-r--r--beam_tracing/python/README.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/beam_tracing/python/README.txt b/beam_tracing/python/README.txt
new file mode 100644
index 0000000..75faf8a
--- /dev/null
+++ b/beam_tracing/python/README.txt
@@ -0,0 +1,20 @@
+Original author: Eugeniy Mikhailov
+Conversion from Octave to Python: Bain Bronner
+
+Language: Python 2.7xx
+Requires: numpy 1.6.x and scipy 0.10.x
+
+prismDiskCoupling.py calculates and draws the critical angle for a given prism geometry and indexes of refraction for the prism and disk
+demoPrismDiskCoupling.py is an example call of the above function
+
+beamTrace.py traces the beam according to Fresnel equations with lighter colors indicating less intensity
+exampleBeamTrace.py is an example call of the above function
+
+the rest of the functions serve as helpers to the above
+
+changes:
+ 1) in converting to Python, the beams initial travel angle and start position for the exampleBeamTrace were determined by a slightly modified prismDiskCoupling.py
+ 2) slightly different annotation styles, including the use of arrows, for the angles in prismDiskCoupling
+ 3) variable and files converted to python naming standard, i.e. this_is_a_file.m --> thisIsAFile.py
+ 4) more or less same logic and mathematics as previously
+ 5) disk placement was added, so now the disk is not always assumed to be in the center