RomanStep¶

class romancal.stpipe.RomanStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]¶

Bases: Step

Base class for Roman calibration pipeline steps.

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

`finalize_result`(model, reference_files_used)	Hook that allows the Step to set metadata on the output model before save.
`record_step_status`(model, step_name[, success])	Record step completion status in the model's metadata.
`remove_suffix`(name)	Remove any Roman step-specific suffix from the given filename.

Attributes Documentation

spec¶

output_ext =  string(default='.asdf')    # Default type of output

Methods Documentation

finalize_result(model, reference_files_used)[source]¶

Hook that allows the Step to set metadata on the output model before save.

Parameters:

model (roman_datamodels.datamodels.DataModel) – Output model.
reference_files_used (list of tuple(str, str)) – List of reference files used. The first element of each tuple is the reftype code, the second element is the filename.

record_step_status(model, step_name, success=True)[source]¶

Record step completion status in the model’s metadata.

Parameters:

remove_suffix(name)[source]¶

Remove any Roman step-specific suffix from the given filename.