StraylightStep

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

Bases: jwst.stpipe.Step

StraylightStep: Performs straylight correction image using a Mask file.

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

reference_file_types

spec

Methods Summary

process(input)

This is where real work happens.

Attributes Documentation

reference_file_types = ['regions']
spec = "\n method = option('Nearest','ModShepard',default='ModShepard') #Algorithm method\n roi = integer(2, 1024, default = 50) # Region of interest given as even integer\n power = float(0.1, 5, default = 1.0) # Power of weighting function\n\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.