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) – 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

spec

Methods Summary

`finalize_result`(model, reference_files_used)	Hook that allows the Step to set metadata on the output model before save.
`get_stpipe_loggers`()	Get names of loggers stpipe will configure
`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
update_version = boolean(default=False) # Update old versions of datamodels to newest version

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.

static get_stpipe_loggers()[source]

Get names of loggers stpipe will configure

List the names of all loggers that might emit messages useful to display or record to the datamodel.

Since messages are often propagated up the logging heirarchy the names here can be the names of packages that might emit useful log messages.

Returns:: Tuple of log names for stpipe to configure
Return type:: tuple of str

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

Record step completion status in the model’s metadata.

Parameters:

model (roman_datamodels.datamodels.DataModel) – Output model.
step_name (str) – Calibration step name.
success (bool) – If True, then the step was run successfully.

remove_suffix(name)[source]

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

Parameters:: name (str) – Filename.
Returns:: Filename with step suffix removed.
Return type:: str