scopesim.effects.obs_strategies.ChopNodCombiner

scopesim.effects.obs_strategies.ChopNodCombiner#

class scopesim.effects.obs_strategies.ChopNodCombiner(**kwargs)#

Bases: Effect

Creates and combines 4 images for each of the chop/nod positions.

  • AA : original position (dx, dy) = (0, 0)

  • AB : chop position (dx, dy) = chop_offsets

  • BA : nod position (dx, dy) = nod_offsets

  • BB : chop-nod position (dx, dy) = nod_offsets + chop_offsets

Images are combined using:

im_combined = (AA - AB) - (BA - BB)

If no nod_offset is given, it is set to the inverse of chop_offset.

ChopNodCombiner is a detector effect and should be placed last in the

detector yaml (after the noise effects).

Keyword Arguments:

  • chop_offsets (tuple, optional) – [arcsec] (dx, dy) offset of chop position relative to AA

  • nod_offsets (tuple, optional) – [arcsec] (dx, dy) offset of nod position relative to AA

  • entry (Example yaml)

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

  • :: –

    name: perpendicular_chop_nod_slanted_pattern description: chop throw to (+5, 0) and nod throw to (-7, +10) arcsec class: ChopNodCombiner include: True kwargs:

    pixel_scale : “!INST.pixel_scale” chop_offsets : (5, 0) nod_offsets : (-7, 10)

__init__(**kwargs)#

Methods

__init__(**kwargs)

apply_to(obj, **kwargs)

Apply the effect to the corresponding object.

get_from_meta(item)

info()

Print basic information on the effect, notably the description.

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

required_keys

table

z_order

apply_to(obj, **kwargs)#

Apply the effect to the corresponding object.

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