HlspStep

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

Bases: JwstStep

HlspStep: Make High-Level Science Products (HLSP’s) from the results of coronagraphic exposure that’s had KLIP processing applied to it.

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

spec

Methods Summary

process(target)

This is where real work happens.

Attributes Documentation

class_alias = 'hlsp'
spec
annuli_width = integer(default=2, min=1) # Width of contrast annuli
save_results = boolean(default=true) # Save results

Methods Documentation

process(target)[source]

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