SaturationStep

class romancal.saturation.SaturationStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: RomanStep

This Step sets saturation flags.

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

Methods Summary

process(dataset)

This is where real work happens.

Attributes Documentation

class_alias = 'saturation'
reference_file_types: ClassVar = ['saturation']

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.