AmiAnalyzeStep

class jwst.ami.ami_analyze_step.AmiAnalyzeStep(name=None, parent=None, config_file=None, _validate_kwds=True, **kws)[source]

Bases: JwstStep

Performs analysis of an AMI mode exposure by applying the LG algorithm.

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

reference_file_types

spec

Methods Summary

process(input)

Performs analysis of an AMI mode exposure by applying the LG algorithm.

Attributes Documentation

class_alias = 'ami_analyze'
reference_file_types = ['throughput']
spec = "\n        oversample = integer(default=3, min=1)  # Oversampling factor\n        rotation = float(default=0.0)           # Rotation initial guess [deg]\n        psf_offset = string(default='0.0 0.0') # Psf offset values to use to create the model array\n        rotation_search = string(default='-3 3 1') # Rotation search parameters: start, stop, step\n    "

Methods Documentation

process(input)[source]

Performs analysis of an AMI mode exposure by applying the LG algorithm.

Parameters

input (string) – input file name

Returns

result – AMI image to which the LG fringe detection has been applied

Return type

AmiLgModel object