lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask Class Reference

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

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

Public Member Functions
def	run (self, maskedImage)
	Compute and return statistics for a masked image. More...

Static Public Attributes
	ConfigClass = pexConfig.Config

Detailed Description

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

\section pipeTasks_ExampleSimpleStatsTask_Contents Contents

 - \ref pipeTasks_ExampleSimpleStatsTask_Purpose
 - \ref pipeTasks_ExampleSimpleStatsTask_Config
 - \ref pipeTasks_ExampleSimpleStatsTask_Debug
 - \ref pipeTasks_ExampleSimpleStatsTask_Example

\section pipeTasks_ExampleSimpleStatsTask_Purpose Description

\copybrief ExampleSimpleStatsTask

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 \ref ExampleSimpleTask.run "run".

\section pipeTasks_ExampleSimpleStatsTask_Config    Configuration parameters

This task has no configuration parameters.

\section pipeTasks_ExampleSimpleStatsTask_Debug     Debug variables

This task has no debug variables.

\section pipeTasks_ExampleSimpleStatsTask_Example A complete example of using ExampleSimpleStatsTask

This code is in examples/exampleStatsTask.py (this one example runs both
ExampleSigmaClippedStatsTask and ExampleSimpleStatsTask), and can be run as:
\code
examples/exampleStatsTask.py [fitsFile]
\endcode

Definition at line 144 of file exampleStatsTasks.py.

Member Function Documentation

run()

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

Compute and return statistics for a masked image.

    @param[in] maskedImage: masked image (an lsst::afw::MaskedImage)
    @return a pipeBase Struct containing:
    - mean: mean of image plane
    - meanErr: uncertainty in mean
    - stdDev: standard deviation of image plane
    - stdDevErr: uncertainty in standard deviation

Definition at line 193 of file exampleStatsTasks.py.

    def run(self, maskedImage):
        """!Compute and return statistics for a masked image
 
        @param[in] maskedImage: masked image (an lsst::afw::MaskedImage)
        @return a pipeBase Struct containing:
        - mean: mean of image plane
        - meanErr: uncertainty in mean
        - stdDev: standard deviation of image plane
        - stdDevErr: uncertainty in standard deviation
        """
        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

ConfigClass

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

static

Definition at line 181 of file exampleStatsTasks.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/exampleStatsTasks.py