Source code for jwst.ami.ami_average_step

import warnings

from jwst.ami import ami_average
from jwst.stpipe import Step

__all__ = ["AmiAverageStep"]




class AmiAverageStep(Step):
    """
    Average LG results for multiple NIRISS AMI mode exposures.

    .. deprecated:: 1.18.1
        The `AmiAverageStep` has been deprecated and will be removed
        in a future release.
    """

    class_alias = "ami_average"

    spec = """
    skip = boolean(default=True) # Do not run this step
    """  # noqa: E501

    def __init__(self, *args, **kwargs):
        warnings.warn(
            "'AmiAverageStep' has been deprecated since 1.18.1 and "
            "will be removed in a future release. ",
            DeprecationWarning,
            stacklevel=2,
        )
        super().__init__(*args, **kwargs)



    def flatten_input(self, input_items):
        """Return generator to provide iterable simple list with no nested structure."""
        for item in input_items:
            if isinstance(item, (list | tuple)):
                yield from self.flatten_input(item)
            else:
                yield item




    def process(self, *input_list):
        """
        Average the results of LG analysis for a set of multiple NIRISS AMI mode exposures.

        Parameters
        ----------
        *input_list : list
            Input file names

        Returns
        -------
        result : `~jwst.datamodels.AmiLgModel`
            Averaged AMI data model
        """
        # Input may be a simple list if run in interactive environment,
        # but processing from command line wraps list of inputs in a tuple.
        # Flatten this object into a simple list.
        input_list = list(self.flatten_input(input_list))

        # Call the LG average routine for the list of inputs
        result = ami_average.average_lg(input_list)

        result.meta.cal_step.ami_average = "COMPLETE"

        return result