AlignRefsStep

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

Bases: JwstStep

Align coronagraphic PSF images with science target images.

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

Execute the AlignRefs calibration step.

Attributes Documentation

class_alias = 'align_refs'

reference_file_types: ClassVar = ['psfmask']

spec

median_box_length = integer(default=3,min=0) # box size for the median filter
bad_bits = string(default="DO_NOT_USE") # the DQ bit values of bad pixels

Methods Documentation

process(target, psf)

Execute the AlignRefs calibration step.

Parameters:

targetstr or CubeModel

CubeModel or file containing science target data

psfstr or CubeModel

CubeModel or file containing PSF image stack

Returns:

resultCubeModel

CubeModel containing stack of PSF reference images shifted to the first science target image.