OutlierDetectionStep

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

Bases: JwstStep

Flag outlier bad pixels and cosmic rays in DQ array of each input image.

Input images can be listed in an input association file or already opened with a ModelContainer. DQ arrays are modified in place.

Parameters:

input_data (asn file or ModelContainer) – Single filename association table, or a datamodels.ModelContainer.

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

check_input()

Use this method to determine whether input is valid or not.

process(input_data)

Perform outlier detection processing on input data.

Attributes Documentation

class_alias = 'outlier_detection'
spec = '\n        weight_type = option(\'ivm\',\'exptime\',default=\'ivm\')\n        pixfrac = float(default=1.0)\n        kernel = string(default=\'square\') # drizzle kernel\n        fillval = string(default=\'INDEF\')\n        nlow = integer(default=0)\n        nhigh = integer(default=0)\n        maskpt = float(default=0.7)\n        grow = integer(default=1)\n        snr = string(default=\'5.0 4.0\')\n        scale = string(default=\'1.2 0.7\')\n        backg = float(default=0.0)\n        save_intermediate_results = boolean(default=False)\n        resample_data = boolean(default=True)\n        good_bits = string(default="~DO_NOT_USE")  # DQ flags to allow\n        scale_detection = boolean(default=False)\n        search_output_file = boolean(default=False)\n        allowed_memory = float(default=None)  # Fraction of memory to use for the combined image.\n        in_memory = boolean(default=False)\n    '

Methods Documentation

check_input()[source]

Use this method to determine whether input is valid or not.

process(input_data)[source]

Perform outlier detection processing on input data.