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

Public Member Functions

def __init__ (self, *args, **kwargs)
 
def run (self, maskedImage)
 

Static Public Attributes

 ConfigClass = ExampleSigmaClippedStatsConfig
 

Detailed Description

Example task to compute sigma-clipped mean and standard deviation of an
image

This is a simple example task designed to be run as a subtask by
ExampleCmdLineTask. See also ExampleSimpleStatsTask as a variant that is
even simpler.

The main method is ExampleSigmaClippedStatsTask.run "run".

pipeTasks_ExampleSigmaClippedStatsTask_Config  Configuration parameters

See ExampleSigmaClippedStatsConfig

pipeTasks_ExampleSigmaClippedStatsTask_Debug   Debug variables

This task has no debug variables.

pipeTasks_ExampleSigmaClippedStatsTask_Example A complete example
of using ExampleSigmaClippedStatsTask

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

The init method may compute anything that that does not require data.
In this case we create a statistics control object using the config
(which cannot change once the task is created).

Definition at line 66 of file exampleStatsTasks.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask.__init__ (   self,
args,
**  kwargs 
)

Definition at line 98 of file exampleStatsTasks.py.

Member Function Documentation

◆ run()

def lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask.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 109 of file exampleStatsTasks.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask.ConfigClass = ExampleSigmaClippedStatsConfig
static

Definition at line 95 of file exampleStatsTasks.py.


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