AlignRefsStep

class jwst.coron.align_refs_step.AlignRefsStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

AlignRefsStep: Align coronagraphic PSF images with science target images.

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(target, psf)

This is where real work happens.

Attributes Documentation

class_alias = 'align_refs'
reference_file_types = ['psfmask']
spec = '\n        median_box_length = integer(default=3,min=0) # box size for the median filter\n        bad_bits = string(default="DO_NOT_USE") # the DQ bit values of bad pixels\n    '

Methods Documentation

process(target, psf)[source]

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