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.

  • 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




Methods Summary


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

save_model(model, *args, **kwargs)

Saves the given model using the step/pipeline's naming scheme

Attributes Documentation

class_alias = 'ami_analyze'
reference_file_types: ClassVar = ['throughput', 'nrm']
oversample = integer(default=3, min=1)  # Oversampling factor
rotation = float(default=0.0)           # Rotation initial guess [deg]
psf_offset = string(default='0.0 0.0') # PSF offset values to use to create the model array
rotation_search = string(default='-3 3 1') # Rotation search parameters: start, stop, step
bandpass = any(default=None) # Synphot spectrum or array to override filter/source
usebp = boolean(default=True) # If True, exclude pixels marked DO_NOT_USE from fringe fitting
firstfew = integer(default=None) # If not None, process only the first few integrations
chooseholes = string(default=None) # If not None, fit only certain fringes e.g. ['B4','B5','B6','C2']
affine2d = any(default=None) # None or user-defined Affine2d object
run_bpfix = boolean(default=True) # Run Fourier bad pixel fix on cropped data

Methods Documentation


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


input (string) – input file name


  • oifitsmodel (AmiOIModel object) – AMI tables of median observables from LG algorithm fringe fitting in OIFITS format

  • oifitsmodel_multi (AmiOIModel object) – AMI tables of observables for each integration from LG algorithm fringe fitting in OIFITS format

  • amilgmodel (AmiLGFitModel object) – AMI cropped data, model, and residual data from LG algorithm fringe fitting

save_model(model, *args, **kwargs)[source]

Saves the given model using the step/pipeline’s naming scheme

  • model (a instance of AbstractDataModel) – The model to save.

  • suffix (str) – The suffix to add to the filename.

  • idx (object) – Index identifier.

  • output_file (str) – Use this file name instead of what the Step default would be.

  • force (bool) – Regardless of whether save_results is False and no output_file is specified, try saving.

  • format (str) – The format of the file name. This is a format string that defines where suffix and the other components go in the file name. If False, it will be presumed output_file will have all the necessary formatting.

  • components (dict) – Other components to add to the file name.


output_paths – List of output file paths the model(s) were saved in.

Return type:

[str[, …]]