EmiCorrStep

class jwst.emicorr.EmiCorrStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

EmiCorrStep: Apply MIRI EMI correction to a science image.

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

class_alias

reference_file_types

spec

Methods Summary

process(input)

This is where real work happens.

Attributes Documentation

class_alias = 'emicorr'
reference_file_types: ClassVar = ['emicorr']
spec
save_intermediate_results = boolean(default=False)
user_supplied_reffile = string(default=None)  # ASDF user-supplied reference file
nints_to_phase = integer(default=None)  # Number of integrations to phase
nbins = integer(default=None)  # Number of bins in one phased wave
scale_reference = boolean(default=True)  # If True, the reference wavelength will be scaled to the data's phase amplitude
skip = boolean(default=True)  # Skip the step
onthefly_corr_freq = float_list(default=None)  # Frequencies to use for correction

Methods Documentation

process(input)[source]

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