scopesim.effects.psfs.discrete.FieldConstantPSF

scopesim.effects.psfs.discrete.FieldConstantPSF#

class scopesim.effects.psfs.discrete.FieldConstantPSF(**kwargs)#

Bases: DiscretePSF

A PSF that is constant across the field.

For spectroscopy, a wavelength-dependent PSF cube is built, where for each wavelength the reference PSF is scaled proportional to wavelength.

Changed in version 0.10.0: PSF interpolation can now be limited to the central wavelength by setting the “!OBS.interp_psf” keyword to False.

Changed in version 0.11.2: Fixed handling of background level and rounded edges to avoid visible “squares” in the image.

__init__(**kwargs)#

Methods

__init__(**kwargs)

apply_to(obj, **kwargs)

Apply the PSF.

get_from_meta(item)

get_kernel(fov)

Find nearest wavelength and build PSF kernel from file.

info()

Print basic information on the effect, notably the description.

make_psf_cube(fov)

Create a wavelength-dependent psf cube.

plot()

report([filename, output, rst_title_chars])

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

update([pupil_mask, filename])

Update the PSF.

Attributes

data

display_name

include

meta_string

report_plot_include

report_table_include

required_keys

table

z_order

apply_to(obj, **kwargs)#

Apply the PSF.

get_kernel(fov)#

Find nearest wavelength and build PSF kernel from file.

info() → None#

Print basic information on the effect, notably the description.

make_psf_cube(fov)#

Create a wavelength-dependent psf cube.

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
update(pupil_mask=None, filename=None)#

Update the PSF.

Parameters:

  • pupil_mask (str) – Name of the pupil mask. The filename is constructed from this and the existing self.meta[“filename_format”].

  • filename (str) – Full name of the file with the new PSF. Ignored if pupil_mask is not None.

  • versionadded: (..) – 0.11.2:

Contents