rail.creation.degraders.photometric_errors module

The Photometric error Model LSST, Roman, and Euclid. Based on photometric error models defined in the package photerr

Author: John Franklin Crenshaw, Tianqing Zhang

class rail.creation.degraders.photometric_errors.EuclidDeepErrorModel

Bases: PhotoErrorModel

The Euclid Deep Error model, defined by peEuclidDeepErrorParams and peEuclidDeepErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'euclid_deep_error_model'

name = 'EuclidDeepErrorModel'

class rail.creation.degraders.photometric_errors.EuclidErrorModel

Bases: PhotoErrorModel

The Euclid Error model, defined by peEuclidErrorParams and peEuclidErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'euclid_error_model'

name = 'EuclidErrorModel'

class rail.creation.degraders.photometric_errors.EuclidWideErrorModel

Bases: PhotoErrorModel

The Euclid Wide Error model, defined by peEuclidWideErrorParams and peEuclidWideErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'euclid_wide_error_model'

name = 'EuclidWideErrorModel'

class rail.creation.degraders.photometric_errors.LSSTErrorModel

Bases: PhotoErrorModel

The LSST Error model, defined by peLsstErrorParams and peLsstErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'lsst_error_model'

name = 'LSSTErrorModel'

class rail.creation.degraders.photometric_errors.PhotoErrorModel

Bases: Noisifier

The Base Model for photometric errors.

This is a wrapper around the error model from PhotErr. The parameter docstring below is dynamically added by the installed version of PhotErr:

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'photo_error_model'

name = 'PhotoErrorModel'

reload_pars(args)

This is needed b/c the parameters are dynamically defined, so we have to reload them _after_ then have been defined

set_params(peparams)

Set the photometric error parameters from photerr to the ceci config

class rail.creation.degraders.photometric_errors.RomanDeepErrorModel

Bases: PhotoErrorModel

The Roman Deep Error model, defined by peRomanDeepErrorParams and peRomanDeepErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'roman_deep_error_model'

name = 'RomanDeepErrorModel'

class rail.creation.degraders.photometric_errors.RomanErrorModel

Bases: PhotoErrorModel

The Roman Error model, defined by peRomanErrorParams and peRomanErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'roman_error_model'

name = 'RomanErrorModel'

class rail.creation.degraders.photometric_errors.RomanMediumErrorModel

Bases: PhotoErrorModel

The Roman Medium Error model, defined by peRomanMediumErrorParams and peRomanMediumErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'roman_medium_error_model'

name = 'RomanMediumErrorModel'

class rail.creation.degraders.photometric_errors.RomanUltraDeepErrorModel

Bases: PhotoErrorModel

The Roman UltraDeep Error model, defined by peRomanUltraDeepErrorParams and peRomanUltraDeepErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'roman_ultra_deep_error_model'

name = 'RomanUltraDeepErrorModel'

class rail.creation.degraders.photometric_errors.RomanWideErrorModel

Bases: PhotoErrorModel

The Roman WideError model, defined by peRomanWideErrorParams and peRomanWideErrorModel

Parameters:

• output_mode ([str] default=default) – What to do with the outputs. The options are ‘default’, where outputs will be written to files and some returned, and ‘return’, where outputs will only be returned and not written.

• seed ([type not specified] default=None) – Set to an int to force reproducible results.

• input (PqHandle (INPUT))

• output (PqHandle (OUTPUT))

__init__(args, **kwargs)

Constructor: Do RailStage specific initialization

entrypoint_function: str | None = '__call__'

interactive_function: str | None = 'roman_wide_error_model'

name = 'RomanWideErrorModel'