lsst.pipe.tasks g5e700ac387+7c0a0cd613
Loading...
Searching...
No Matches
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.

Notes
-----
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 50 of file exampleStatsTasks.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 66 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.image.MaskedImage`
    Masked image to compute statistics on.

Returns
-------
stats : `lsst.pipe.base.Struct`
    Statistics as a struct with attributes:

    ``mean``
        Mean of image plane (`float`).
    ``meanErr``
        Uncertainty in mean (`float`).
    ``stdDev``
        Standard deviation of image plane (`float`).
    ``stdDevErr``
        Uncertainty in standard deviation (`float`).

Definition at line 77 of file exampleStatsTasks.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 63 of file exampleStatsTasks.py.


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