scopesim.effects.shifts.AtmosphericDispersionCorrection

scopesim.effects.shifts.AtmosphericDispersionCorrection#

class scopesim.effects.shifts.AtmosphericDispersionCorrection(**kwargs)#

Bases: Shift3D

Alters the position on the detector for a FOV object (WCS_prefix=”D”).

Only acts on FOVs during the main effects loop in OpticalTrain. For the sake of computational efficiency, the ADC can be instructed to counteract the atmospheric diffraction during the OpticalTrain setup phase, by passing the kwarg: quick_adc=True

Parameters:

kwargs

__init__(**kwargs)#

Methods

__init__(**kwargs)

apply_to(fov, **kwargs)

See parent docstring.

fov_grid([which])

See parent docstring.

get_from_meta(item)

get_table(**kwargs)

info()

Print basic information on the effect, notably the description.

plot()

report([filename, output, rst_title_chars])

For Effect objects, generates a report based on the data and meta-data.

Attributes

data

display_name

include

meta_string

report_plot_include

report_table_include

required_keys

table

z_order

apply_to(fov, **kwargs)#

See parent docstring.

fov_grid(which='shifts', **kwargs)#

See parent docstring.

info() → None#

Print basic information on the effect, notably the description.

report(filename=None, output='rst', rst_title_chars='*+', **kwargs)#

For Effect objects, generates a report based on the data and meta-data.

This is to aid in the automation of the documentation process of the instrument packages in the IRDB.

Note

If the Effect can generate a plot, this will be saved to disc

Parameters:

  • filename (str, optional) – Where to save the RST file

  • output (str, optional) – [“rst”, “latex”] Output file format

  • rst_title_chars (2-str, optional) – Two unique characters used to denote rst subsection headings. Options: = - ` : ‘ “ ~ ^ _ * + # < >

  • parameters (Additional)

  • ---------------------

  • **kwargs (Either from the self.meta["report"] dictionary or via)

  • "report_table_include" (False)

  • "report_table_caption"

  • "report_plot_caption"

  • "report_plot_include" (False)

  • "report_plot_file_formats" (["png"]) – Multiple formats can be saved. The last entry is used for the RST.

  • "report_plot_filename" (None) – If None, uses self.meta[“name”] as the filename

  • "file_description" (str) – Taken from the header of a file, if available

  • "class_description" (str) – Taken from the docstring of the subclass

  • "changes_str" (list of str) – Take from the header of a file, if available

Returns:

rst_str – The full reStructureText string

Return type:

str

Notes

The format of the RST output is as follows:

<ClassType>: <effect name>
**************************
File Description: <description for file meta data>
Class Description: <description from class docstring>
Changes: <list of changes from file meta data>

Data
++++
.. figure:: <Figure_name>.png
    If the <Effect> object contains a ``.plot()`` function, add
    plot and write it to disc
Figure caption

Table caption
Table
    If the <Effect> object contains a ``.table()`` function, add
    a pprint version of the table

Meta-data
+++++++++
::
    A code block print out of the ``.meta`` dictionary
Contents