Skip to content

Commit

Permalink
Minor changes for version 2.0.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
indranilsinharoy committed Jan 4, 2016
1 parent 1000c7a commit 1b6e1df
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 11 deletions.
Binary file added Doc/Images/apr_interactive_session_video_img.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Doc/Jupyter gallery raw text.mdown
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This page showcases examples of using PyZDDE with Zemax within Jupyter. Please n
|--------------------------------|---------------------------------------------|
|[![](https://raw.githubusercontent.com/indranilsinharoy/PyZDDE/master/Doc/Images/articlePic_00_usingZemax.png)](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/00%20Using%20ZEMAX%20and%20PyZDDE%20with%20IPython%20notebook.ipynb) |1. [Using ZEMAX and PyZDDE with IPython notebook] (http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/00%20Using%20ZEMAX%20and%20PyZDDE%20with%20IPython%20notebook.ipynb) -- introduces basic capabilities of PyZDDE.|
|[![](https://raw.githubusercontent.com/indranilsinharoy/PyZDDE/master/Doc/Images/articlePic_01_ipzcapturewindow.png)](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/01%20Notes%20on%20ipzCaptureWindow%20functions.ipynb) |2. [Notes on ``ipzCaptureWindow()`` and ``ipzCaptureWindowLQ()`` functions for embedding Zemax graphics into notebooks](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/01%20Notes%20on%20ipzCaptureWindow%20functions.ipynb) -- shows how to use the two functions to directly import graphics windows from Zemax into the notebook.|
|[![](https://raw.githubusercontent.com/indranilsinharoy/PyZDDE/master/Doc/Images/articlePic_04_acqnanaImageSim.png)](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/04%20Acquisition%20and%20analysis%20Image%20Simulation%20data%20from%20Zemax.ipynb)|3. [Acquisition and analysis Image Simulation data from Zemax](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/04%20Acquisition%20and%20analysis%20Image%20Simulation%20data%20from%20Zemax.ipynb) -- demonstrates how to use the Image Simulation feature of Zemax using PyZDDE.|
|[![](https://raw.githubusercontent.com/indranilsinharoy/PyZDDE/master/Doc/Images/articlePic_04_acqnanaImageSim.png)](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/04%20Acquisition%20and%20analysis%20Image%20Simulation%20data%20from%20Zemax.ipynb)|3. [Acquisition and analysis of Image Simulation data from Zemax](http://nbviewer.ipython.org/github/indranilsinharoy/PyZDDE/blob/master/Examples/IPNotebooks/04%20Acquisition%20and%20analysis%20Image%20Simulation%20data%20from%20Zemax.ipynb) -- demonstrates how to use the Image Simulation feature of Zemax using PyZDDE.|



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Acquisition and analysis Image Simulation data from Zemax"
"# Acquisition and analysis of Image Simulation data from Zemax"
]
},
{
Expand Down Expand Up @@ -63,9 +63,13 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"**Summary**\n",
"\n",
"### Summary"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Here are a set of general guidelines.\n",
"\n",
"1. The simulated image is produced essentially in the following three steps:\n",
Expand All @@ -77,9 +81,9 @@
"\n",
"3. The fidelity of the PSFs in the object space is determined by the object side pixel size (i.e. the resolution of the discrete object space grid). It is not affected by the detector pixel size and dimensions specifications.\n",
"\n",
"4. In order to produce accurate image simulations, we must ensure that there are sufficient numer of pixels per PSF in the PSF-grid. This can be done visually using the image simulation tool by checking the quality of the PSF and increasing the oversampling or decreasing the field height if required. Alternatively, we can compute the maximum allowable field height or minimum required oversampling based on a criterion of ensuring a minimum number of pixels (typically over 50 along a chosen direction) within the RMS spot size or 98% ensquared spot size. Note that if possible, decreasing the field height should chosen over oversampling, because the computation time increases drastically with oversampling.\n",
"4. In order to produce accurate image simulations, we must ensure that there are sufficient numer of pixels per PSF in the PSF-grid. This can be done visually using the image simulation tool by checking the quality of the PSF and increasing the oversampling or decreasing the field height if required. Alternatively, we can compute the maximum allowable field height or minimum required oversampling based on a criterion of ensuring a minimum number of pixels within the RMS spot size or 98% ensquared spot size. This computation must be done on the \"best\" PSF--having smallest spot diameter. Doing so, will guarantee the minimum samples in the smallest (and hence also the largest/worst) PSF. Note that if possible, decreasing the field height should chosen over oversampling, because the computation time increases drastically with oversampling.\n",
"\n",
"5. The Image Sampling parameter doesn't affect the resolution of the PSF grid. However, the Image Sampling determines the \"portion\" of the computed PSF that will be used for the convolution.\n",
"5. The appropriate value of the \"Image Sampling\" parameter can be determined based on the worst-case PSF, such that the Image Sampling grid is at least as large as the worst case PSF. Note that the Image sampling doesn't affect the resolution of the PSF grid. However, the Image Sampling determines the \"portion\" of the computed PSF that will be used for the convolution.\n",
"\n",
"6. The Pupil Sampling parameter controls the fidelity of the PSFs in terms of how accurately the PSFs represent system aberrations."
]
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ PyZDDE: Python Zemax Dynamic Data Exchange
Current revision
'''''''''''''''''

2.0.2-alpha (Last significant update on 01/01/2016)
2.0.2 (Last significant update on 01/03/2016)

Change log
~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions pyzdde/zdde.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# Licence: MIT License
# This file is subject to the terms and conditions of the MIT License.
# For further details, please refer to LICENSE.txt
# Revision: 2.0.2-alpha
# Revision: 2.0.2
#-------------------------------------------------------------------------------
"""PyZDDE, which is a toolbox written in Python, is used for communicating
with ZEMAX using the Microsoft's Dynamic Data Exchange (DDE) messaging
Expand Down Expand Up @@ -427,7 +427,7 @@ class PyZDDE(object):
__server = 0
__appNameDict = _createAppNameDict(_MAX_PARALLEL_CONV) # {'ZEMAX': False, 'ZEMAX1': False}

version = '2.0.2-alpha'
version = '2.0.2'

# Other class variables
# Surface data codes for getting and setting surface data
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

setup(
name='PyZDDE',
version='2.0.2-alpha',
version='2.0.2',
description='Zemax / OpticStudio standalone extension using Python',
long_description=long_description,
author='Indranil Sinharoy',
Expand All @@ -28,6 +28,7 @@
packages=find_packages(),
include_package_data=True,
classifiers=[
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Science/Research',
'Natural Language :: English',
'Environment :: Win32 (MS Windows)',
Expand Down

0 comments on commit 1b6e1df

Please sign in to comment.