lsst.pipe.tasks  21.0.0-121-gecf9ee78+b64c36337a
Public Member Functions | Static Public Attributes | List of all members
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 143 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 192 of file exampleStatsTasks.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 180 of file exampleStatsTasks.py.


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