scopesim.effects.fits_headers.SimulationConfigFitsKeywords

scopesim.effects.fits_headers.SimulationConfigFitsKeywords#

class scopesim.effects.fits_headers.SimulationConfigFitsKeywords(cmds=None, **kwargs)#

Bases: ExtraFitsKeywords

Adds parameters from all config dictionaries to the FITS headers.

Parameters:

  • ext_number (int, list of ints, optional) – Default 0. The numbers of the extensions to which the header keywords should be added

  • resolve (bool) – Default True. If True, all !-strings and #-strings are resolved via from_currsys before being add to the header. If False, the unaltered !-strings or #-strings are added to the header.

  • keyword_prefix (str, optional) – Default “HIERARCH SIM”. Custom FITS header keyword prefix. Effect meta dict entries will appear in the header as: <keyword_prefix> SRCn <key> : <value>

Examples

Yaml file entry:

name: source_descriptor
class: SimulationConfigFitsKeywords
description: adds info from all config dicts to the FITS header
kwargs:
  ext_number: [0]
  resolve: False
  keyword_prefix: HIERARCH SIM
__init__(cmds=None, **kwargs)#

Methods

__init__([cmds])

apply_to(hdul, **kwargs)

See parent docstring.

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(hdul, **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