WfssContamStep

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

Bases: JwstStep

This Step performs contamination correction of WFSS spectra.

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_model, *args, **kwargs)

This is where real work happens.

Attributes Documentation

class_alias = 'wfss_contam'
reference_file_types = ['photom', 'wavelengthrange']
spec = "\n        save_simulated_image = boolean(default=False)  # Save full-frame simulated image\n        save_contam_images = boolean(default=False)  # Save source contam estimates\n        maximum_cores = option('none', 'quarter', 'half', 'all', default='none')\n        skip = boolean(default=True)\n    "

Methods Documentation

process(input_model, *args, **kwargs)[source]

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