prysm.conf¶
Configuration for this instance of prysm.
-
prysm.conf.
sanitize_unit
(unit, wavelength)¶ Sanitize a unit token, either an astropy unit or a string.
- Parameters
unit (astropy.Unit or str) – unit or string version of unit
wavelength (astropy.Unit) – a wavelength unit generated by mkwvl or equivalent code
- Returns
an astropy unit
- Return type
astropy.Unit
-
prysm.conf.
format_unit
(unit_or_quantity, fmt)¶ (string) format a unit or quantity
- Parameters
unit_or_quantity (astropy.units.Unit or astropy.units.Quantity) – a unit or quantity
fmt (str, {‘latex’, ‘unicode’}) – a string format
- Returns
string
- Return type
str
-
class
prysm.conf.
Labels
(xy_base, z, xy_additions=['X', 'Y'], xy_addition_side='right', addition_joiner=' ', unit_prefix='[', unit_suffix=']', unit_joiner=' ')¶ Bases:
object
Labels holder for data instances.
-
x
(xy_unit, z_unit)¶ X label.
-
y
(xy_unit, z_unit)¶ Y label.
-
z
(xy_unit, z_unit)¶ Z label.
-
generic
(xy_unit, z_unit)¶ Generic label without extra X/Y annotation.
-
-
class
prysm.conf.
Config
(precision=64, backend=<module 'numpy' from '/home/docs/checkouts/readthedocs.org/user_builds/prysm/envs/v0.18/lib/python3.7/site-packages/numpy/__init__.py'>, zernike_base=1, Q=2, wavelength=Unit("wave"), phase_cmap='inferno', image_cmap='Greys_r', lw=3, zorder=3, alpha=1, interpolation='lanczos', unit_format='latex_inline', show_units=True, phase_xy_unit=Unit("mm"), phase_z_unit=Unit("nm"), image_xy_unit=Unit("um"), image_z_unit=Unit("adu"), mtf_xy_unit=Unit("1 / mm"), mtf_z_unit=Unit("rel"), ptf_xy_unit=Unit("1 / mm"), ptf_z_unit=Unit("deg"), pupil_labels=<prysm.conf.Labels object>, interferogram_labels=<prysm.conf.Labels object>, convolvable_labels=<prysm.conf.Labels object>, mtf_labels=<prysm.conf.Labels object>, ptf_labels=<prysm.conf.Labels object>, psd_labels=<prysm.conf.Labels object>)¶ Bases:
object
Global configuration of prysm.
-
precision_complex
¶ Precision used for complex array computations.
- Returns
`object` – precision used for complex arrays
- Return type
numpy.complex64 or numpy.complex128
-
precision
¶ Precision used for computations.
- Returns
`object` – precision used
- Return type
numpy.float32 or numpy.float64
-
backend
¶ Backend used.
- Returns
{‘np’} only
- Return type
str
-
zernike_base
¶ Zernike base.
- Returns
{0, 1}
- Return type
int
-