KlipStep

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

Bases: JwstStep

Performs KLIP processing on a science target coronagraphic exposure.

The input science exposure is assumed to be a fully calibrated level-2b image. The processing is performed using a set of reference PSF images observed in the same coronagraphic mode.

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
spec

Methods Summary

process(target, psfrefs)

Execute the KLIP calibration step.

Attributes Documentation

class_alias = 'klip'

spec

truncate = integer(default=50,min=0) # The number of KL transform rows to keep

Methods Documentation

process(target, psfrefs)

Execute the KLIP calibration step.

Parameters:

targetstr or CubeModel

CubeModel or file containing science target exposure

psfrefsstr or CubeModel

CubeModel or file containing PSF Reference exposures

Returns:

psf_subCubeModel

Science target CubeModel with the PSF subtracted