ResidualFringeStep

class jwst.residual_fringe.residual_fringe_step.ResidualFringeStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

ResidualFringeStep: Apply residual fringe correction to a science image using a residual fringe reference image.

Parameters

input_data (asn file or ModelContainer) – Single filename association table or a datamodels.ModelContainer

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 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 = 'residual_fringe'
reference_file_types = ['fringefreq', 'regions']
spec = "\n        save_intermediate_results  = boolean(default = False)\n        search_output_file = boolean(default = False)\n        ignore_region_min = list(default = None)\n        ignore_region_max = list(default = None)\n        suffix = string(default = 'residual_fringe')\n    "

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.