EmiCorrStep

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

Bases: JwstStep

Correct MIRI ramp data for EMI noise.

Create a Step instance.

Parameters:
namestr

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.

parentStep

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_filestr 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_kwdsbool

Validate given kws against specs/config.

**kwsdict

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(step_input)

Apply EMI correction to input data.

Attributes Documentation

class_alias = 'emicorr'
reference_file_types: ClassVar = ['emicorr']
spec = "\n        algorithm = option('sequential', 'joint', default='joint')  # EMI fitting algorithm\n        nints_to_phase = integer(default=None)  # Number of integrations to phase\n        nbins = integer(default=None)  # Number of bins in one phased wave\n        scale_reference = boolean(default=True)  # If True, the reference wavelength will be scaled to the data's phase amplitude\n        onthefly_corr_freq = float_list(default=None)  # Frequencies to use for correction\n        use_n_cycles = integer(default=3)  # Use N cycles to calculate the phase, to use all integrations set to None\n        fit_ints_separately = boolean(default=False)  # If True and algorithm is 'joint', each integration is separately fit.\n        user_supplied_reffile = string(default=None)  # ASDF user-supplied reference file\n        save_intermediate_results = boolean(default=False)  # If True and a reference file is created on the fly, save it to disk\n        skip = boolean(default=True)  # Skip the step\n    "

Methods Documentation

process(step_input)[source]

Apply EMI correction to input data.

Parameters:
step_inputstr or RampModel

Input ramp filename or datamodel.

Returns:
resultRampModel

EMI corrected output datamodel.