PixelReplaceStep

class jwst.pixel_replace.PixelReplaceStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Replace flagged bad pixels prior to spectral extraction.

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(input_data)

Execute the step.

Attributes Documentation

class_alias = 'pixel_replace'
spec
algorithm = option("fit_profile", "mingrad", "N/A", default="fit_profile") # Replacement algorithm
n_adjacent_cols = integer(default=3) # Number of adjacent columns to use in profile creation
skip = boolean(default=True) # Step must be turned on by parameter reference or user
output_use_model = boolean(default=True) # Use input filenames in the output models

Methods Documentation

process(input_data)[source]

Execute the step.

Parameters:
input_datastr or JwstDataModel

The file name or input datamodel containing spectral data in need of pixel replacement.

Returns:
output_modelJwstDataModel

This will be the same as the input model if the step was skipped; otherwise, it will be a model containing data arrays with estimated fluxes for any bad pixels, now flagged as FLUX_ESTIMATED.