scopesim.effects.metis_ifu_simple.ifu_simple.LineSpreadFunction

scopesim.effects.metis_ifu_simple.ifu_simple.LineSpreadFunction#

class scopesim.effects.metis_ifu_simple.ifu_simple.LineSpreadFunction(**kwargs)#

Bases: Effect

Compute and apply line spread function to IFU cube.

The effect can be instantiated either with the single parameter

  • lsfwidthfloat

    Width of the line-spread function in pixels

or with the following set of parameters:

  • wavelenfloat

    Central wavelength of the LMS setting [um]

  • fit_slope, fit_interceptfloat

    Parameters of a linear fit of the mean dispersion (Delta lambda per pixel on the LMS detector) as a function of central wavelength. For METIS LMS, these values are obtained from TRACE_LMS.fits with the script fit_ifu_dispersion.py in irdb/METIS/code.

  • slice_widthfloat

    On-sky width of a slice of the LMS slicer [arcsec]

  • pixel_scalefloat

    On-sky angle covered by a pixel of the LMS detector array [arcsec]

  • spec_binwidthfloat

    Spectral bin width of the 3D detector of the lms_cube mode.

These values are set in METIS_LMS_SMPL.yaml.

Added in version 0.10.0.

__init__(**kwargs)#

Methods

__init__(**kwargs)

apply_to(obj, **kwargs)

Apply the LSF.

get_from_meta(item)

get_kernel()

Build LSF kernel: box kernel smoothed with narrow Gauss.

get_lsf_width()

Determine width of the LSF kernel at central wavelength.

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

report_plot_include

report_table_include

required_keys

table

z_order

apply_to(obj, **kwargs)#

Apply the LSF.

get_kernel()#

Build LSF kernel: box kernel smoothed with narrow Gauss.

get_lsf_width()#

Determine width of the LSF kernel at central wavelength.

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