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
, orModelContainer
) – 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 aModelContainer
.- Returns:
output_models – The models with flux applied.
- Return type:
roman_datamodels.datamodels.DataModel
, orModelContainer
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, optional) – 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 instance, optional) – 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, optional) – The path to the config file that this step was initialized with. Use to determine relative path names of other config files.
**kws (dict) – Additional parameters to set. These will be set as member variables on the new Step instance.
Attributes Summary
Methods Summary
process
(input)This is where real work happens.
Attributes Documentation
- reference_file_types: ClassVar = []¶
- spec¶
Methods Documentation