Skip to content

Commit 4be4182

Browse files
committed
minor docs tweaks for 0.7 [ci skip]
1 parent 5081e63 commit 4be4182

2 files changed

Lines changed: 23 additions & 9 deletions

File tree

docs/fresnel.rst

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ Particular credit is due to `Ewan Douglas <http://blogs.bu.edu/douglase/>`_ for
88
initially developing this code. This substantial upgrade to ``poppy`` enables
99
calculation of wavefronts propagated arbitrary distances in free space, for applications
1010
such as Gaussian beam propagation and modeling of Talbot effect mixing between phase and
11-
amplitude aberrations.
11+
amplitude aberrations.
1212

1313

1414
.. caution::
1515
The Fresnel code has
1616
been cross-checked against the `PROPER library by John Krist
1717
<http://proper-library.sourceforge.net>` to verify accuracy and correctness of
1818
output. A test suite is provided along with ``poppy`` in the tests subdirectory
19-
and users are encouraged to run these tests themselves. However this is still
19+
and users are encouraged to run these tests themselves. However this is still
2020
a relatively new addition to ``poppy``, and it is possible there may still be
21-
some bugs.
21+
some bugs.
2222

2323

2424

@@ -28,11 +28,11 @@ Usage of the Fresnel code
2828

2929
The API has been kept as similar as possible to the original Fraunhofer mode of
3030
poppy. There are FresnelWavefront and FresnelOpticalSystem classes, which can
31-
be used for the most part similar to the Wavefront and OpticalSystem classes.
31+
be used for the most part similar to the Wavefront and OpticalSystem classes.
3232

3333
Users are encouraged to consult the Jupyter notebook `Fresnel_Propagation_Demo
3434
<https://github.com/mperrin/poppy/blob/master/notebooks/Fresnel_Propagation_Demo.ipynb>`_
35-
for examples of how to use the Fresnel code.
35+
for examples of how to use the Fresnel code.
3636

3737
Key Differences from Fraunhofer mode
3838
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -76,26 +76,39 @@ For more details and examples of code usage, consult the Jupyter notebook
7676
<https://github.com/mperrin/poppy/blob/master/notebooks/Fresnel_Propagation_Demo.ipynb>`_.
7777

7878
A worked example of a compound microscope in POPPY is available
79-
`here <https://github.com/douglase/poppy_example_notebooks/blob/master/Fresnel/Microscope_Example.ipynb>`_,
79+
`here <https://github.com/douglase/poppy_example_notebooks/blob/master/Fresnel/Microscope_Example.ipynb>`_,
8080
reproducing the microscope example case provided in the PROPER manual.
8181

82+
Fresnel calculations with Physical units
83+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
84+
85+
A subclass, `PhysicalFresnelWavefront`, enables calculations using wavefronts
86+
scaled to physical units, i.e. volts/meter for electric field and watts for
87+
total intensity (power). This code was developed and contributed by `Phillip
88+
Springer <https://github.com/DaPhil>`_.
89+
90+
See `this notebook
91+
<https://github.com/mperrin/poppy/blob/master/notebooks/Physical%20Units%20Demo.ipynb>`_
92+
for examples and further discussion.
93+
94+
8295
References
8396
-------------
8497

85-
The following references were helpful in the development of this code.
98+
The following references were helpful in the development of this code.
8699

87100
- Goodman, `Fourier Optics <http://www.amazon.com/Introduction-Fourier-Optics-Joseph-Goodman/dp/0974707724>`_
88101

89102
- Lawrence, G. N. (1992), Optical Modeling, in Applied Optics and Optical Engineering., vol. XI,
90103
edited by R. R. Shannon and J. C. Wyant., Academic Press, New York.
91104

92-
- IDEX Optics and Photonics(n.d.),
105+
- IDEX Optics and Photonics(n.d.),
93106
`Gaussian Beam Optics <https://marketplace.idexop.com/store/SupportDocuments/All_About_Gaussian_Beam_OpticsWEB.pdf>`_
94107

95108
- Krist, J. E. (2007), `PROPER: an optical propagation library for IDL <http://dx.doi.org/10.1117/12.731179>`_
96109
vol. 6675, p. 66750P-66750P-9.
97110

98-
- Andersen, T., and A. Enmark (2011),
111+
- Andersen, T., and A. Enmark (2011),
99112
`Integrated Modeling of Telescopes <http://www.amazon.com/Integrated-Modeling-Telescopes-Astrophysics-Science/dp/1461401488>`_,
100113
Springer Science & Business Media.
101114

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ telescopes. POPPY was developed as part of a simulation package for `JWST
1212
imaging simulations.
1313

1414

15+
.. image:: figures/readme_fig.png
1516

1617
Summary
1718
------------

0 commit comments

Comments
 (0)