scopesim.effects.ter_curves.TopHatFilterCurve

scopesim.effects.ter_curves.TopHatFilterCurve#

class scopesim.effects.ter_curves.TopHatFilterCurve(cmds=None, **kwargs)#

Bases: FilterCurve

A simple Top-Hat filter profile.

Parameters:

  • transmission (float) – [0..1] Peak transmission of filter

  • blue_cutoff (float) – [um] Blue and Red cutoff wavelengths

  • red_cutoff (float) – [um] Blue and Red cutoff wavelengths

  • wing_transmission (float, optional) – [0..1] Default 0. Wing transmission of filter outside the cutoff range

Examples

name: J_band_tophat
class: TopHatFilterCurve
kwargs:
    transmission : 0.9
    wing_transmission : 0.001
    blue_cutoff : 1.15
    red_cutoff : 1.35
__init__(cmds=None, **kwargs)#

Methods

__init__([cmds])

apply_to(obj, **kwargs)

Apply the effect to the corresponding object.

fov_grid([which])

get_from_meta(item)

info()

Print basic information on the effect, notably the description.

plot([which, wavelength, axes])

Plot TER curves.

report([filename, output, rst_title_chars])

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

Attributes

background_source

center

centre

data

display_name

emission

fwhm

include

meta_string

report_plot_include

report_table_include

required_keys

table

throughput

z_order

apply_to(obj, **kwargs)#

Apply the effect to the corresponding object.

info() → None#

Print basic information on the effect, notably the description.

plot(which='x', wavelength=None, *, axes=None, **kwargs)#

Plot TER curves.

Parameters:

  • which ({"x", "t", "e", "r"}, optional) – “x” plots throughput. “t”,”e”,”r” plot trans/emission/refl. Can be a combination, e.g. “tr” or “tex” to plot each.

  • wavelength (array_like, optional) – Wavelength on x-axis, taken from currsys if None (default).

  • axes (matplotlib axes, optional) – If given, plot into existing axes. The default is None.

Returns:

fig – Figure containing plots.

Return type:

matplotlib figure

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