KlipStep

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

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:

  • 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 or pathlib.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

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)[source]

Execute the KLIP calibration step.

Parameters:

  • target (str or CubeModel) – CubeModel or file containing science target exposure

  • psfrefs (str or CubeModel) – CubeModel or file containing PSF Reference exposures

Returns:

psf_sub – Science target CubeModel with the PSF subtracted

Return type:

CubeModel