Inheritance diagram for lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask:

Public Member Functions
	run (self, maskedImage)

Static Public Attributes
	ConfigClass = pexConfig.Config

Protected Attributes
	_statsControl

Static Protected Attributes
str	_DefaultName = "exampleSimpleStats"

Detailed Description

Example task to compute mean and standard deviation of an image.

This was designed to be run as a subtask by ExampleCmdLineTask.
It is about as simple as a task can be; it has no configuration parameters
and requires no special initialization. See also
ExampleSigmaClippedStatsTask as a variant that is slightly more
complicated.

The main method is ExampleSimpleTask.run "run".

pipeTasks_ExampleSimpleStatsTask_Config    Configuration parameters

This task has no configuration parameters.

pipeTasks_ExampleSimpleStatsTask_Debug     Debug variables

This task has no debug variables.

Definition at line 113 of file exampleStatsTasks.py.

Member Function Documentation

◆ run()

lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask.run	(		self,
			maskedImage )

Compute and return statistics for a masked image.

Parameters
----------
maskedImage : `lsst.afw.MaskedImage`
    Masked image to compute statistics on.

Returns
-------
stats : `lsst.pipe.base.Struct`
    Statistics as a struct with attributes:

    ``mean``
        Mean of image plane (`float`).
    ``meanErr``
        Uncertainty in mean (`float`).
    ``stdDev``
        Standard deviation of image plane (`float`).
    ``stdDevErr``
        Uncertainty in standard deviation (`float`).

Definition at line 147 of file exampleStatsTasks.py.

    def run(self, maskedImage):
        """Compute and return statistics for a masked image.
 
        Parameters
        ----------
        maskedImage : `lsst.afw.MaskedImage`
            Masked image to compute statistics on.
 
        Returns
        -------
        stats : `lsst.pipe.base.Struct`
            Statistics as a struct with attributes:
 
            ``mean``
                Mean of image plane (`float`).
            ``meanErr``
                Uncertainty in mean (`float`).
            ``stdDev``
                Standard deviation of image plane (`float`).
            ``stdDevErr``
                Uncertainty in standard deviation (`float`).
        """
        self._statsControl = afwMath.StatisticsControl()
        statObj = afwMath.makeStatistics(maskedImage, afwMath.MEAN | afwMath.STDEV | afwMath.ERRORS,
                                         self._statsControl)
        mean, meanErr = statObj.getResult(afwMath.MEAN)
        stdDev, stdDevErr = statObj.getResult(afwMath.STDEV)
        self.log.info("simple mean=%0.2f; meanErr=%0.2f; stdDev=%0.2f; stdDevErr=%0.2f",
                      mean, meanErr, stdDev, stdDevErr)
 
        return pipeBase.Struct(
            mean=mean,
            meanErr=meanErr,
            stdDev=stdDev,
            stdDevErr=stdDevErr,
        )

Member Data Documentation

◆ _DefaultName

str lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask._DefaultName = "exampleSimpleStats"

staticprotected

Definition at line 139 of file exampleStatsTasks.py.

◆ _statsControl

lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask._statsControl

protected

Definition at line 169 of file exampleStatsTasks.py.

◆ ConfigClass

lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask.ConfigClass = pexConfig.Config

static

Definition at line 133 of file exampleStatsTasks.py.

The documentation for this class was generated from the following file:

/j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/gc07e1c2157+a98bf949bb/python/lsst/pipe/tasks/exampleStatsTasks.py

Public Member Functions

Static Public Attributes

Protected Attributes