FluxStep

class romancal.flux.flux_step.FluxStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: RomanStep

Apply flux scaling to count-rate data

Parameters:

input (str, roman_datamodels.datamodels.DataModel, or ModelLibrary) – If a string is provided, it should correspond to either a single ASDF filename or an association filename. Alternatively, a single DataModel instance can be provided instead of an ASDF filename. Multiple files can be processed via either an association file or wrapped by a ModelLibrary.

Returns:

output_models – The models with flux applied.

Return type:

roman_datamodels.datamodels.DataModel, or ModelLibrary

Notes

Currently, the correction is done in-place; the inputs are directly modified if in-memory DataModels are input.

Create a Step instance.

Parameters:

  • name (str) – The name of the Step instance. Used in logging messages and in cache filenames. If not provided, one will be generated based on the class name.

  • parent (Step) – The parent step of this step. Used to determine a fully-qualified name for this step, and to determine the mode in which to run this step.

  • config_file (str or pathlib.Path) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.

  • _validate_kwds (bool) – Validate given kws against specs/config.

  • **kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.

Attributes Summary

class_alias

reference_file_types

spec

Methods Summary

process(dataset)

This is where real work happens.

Attributes Documentation

class_alias = 'flux'
reference_file_types: ClassVar = []
spec

Methods Documentation

process(dataset)[source]

This is where real work happens. Every Step subclass has to override this method. The default behaviour is to raise a NotImplementedError exception.