lsst.pipe.tasks g6a99470703+d978885a28
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask Class Reference
Inheritance diagram for lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask:

Public Member Functions

def run (self, maskedImage)
 

Static Public Attributes

 ConfigClass = pexConfig.Config
 

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.

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: examples/exampleStatsTask.py [fitsFile]

Definition at line 140 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

Parameters
----------
maskedImage : `lsst.afw.MaskedImage`
    masked image

Returns
-------
retStruct : `~lsst.pipe.base.Struct`
    A struct containing following attributes
    - mean: mean of image plane
    - meanErr: uncertainty in mean
    - stdDev: standard deviation of image plane
    - stdDevErr: uncertainty in standard deviation

Definition at line 182 of file exampleStatsTasks.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 168 of file exampleStatsTasks.py.


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