lsst.pipe.tasks g8b9e2231ea+fa07cb600e
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Attributes | Static Protected 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.
 

Static Public Attributes

pexConfig 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.

Contents

Description

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 run.

Configuration parameters

This task has no configuration parameters.

Debug variables

This task has no debug variables.

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:

examples/exampleStatsTask.py [fitsFile]

Definition at line 145 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 195 of file exampleStatsTasks.py.

Member Data Documentation

◆ _DefaultName

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

Definition at line 188 of file exampleStatsTasks.py.

◆ _statsControl

lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask._statsControl
protected

Definition at line 205 of file exampleStatsTasks.py.

◆ ConfigClass

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

Definition at line 183 of file exampleStatsTasks.py.


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