lsst.pipe.tasks gec3662e80e+8f8c708f41
|
Example task to compute sigma-clipped mean and standard deviation of an image. More...
Public Member Functions | |
def | __init__ (self, *args, **kwargs) |
Construct an ExampleSigmaClippedStatsTask. More... | |
def | run (self, maskedImage) |
Compute and return statistics for a masked image. More... | |
Static Public Attributes | |
ConfigClass = ExampleSigmaClippedStatsConfig | |
Example task to compute sigma-clipped mean and standard deviation of an image.
\section pipeTasks_ExampleSigmaClippedStatsTask_Contents Contents - \ref pipeTasks_ExampleSigmaClippedStatsTask_Purpose - \ref pipeTasks_ExampleSigmaClippedStatsTask_Config - \ref pipeTasks_ExampleSigmaClippedStatsTask_Debug - \ref pipeTasks_ExampleSigmaClippedStatsTask_Example \section pipeTasks_ExampleSigmaClippedStatsTask_Purpose Description \copybrief ExampleSigmaClippedStatsTask 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 \ref ExampleSigmaClippedStatsTask.run "run". \section pipeTasks_ExampleSigmaClippedStatsTask_Config Configuration parameters See \ref ExampleSigmaClippedStatsConfig \section pipeTasks_ExampleSigmaClippedStatsTask_Debug Debug variables This task has no debug variables. \section 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: \code examples/exampleStatsTask.py [fitsFile] \endcode
Definition at line 64 of file exampleStatsTasks.py.
def lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask.__init__ | ( | self, | |
* | args, | ||
** | kwargs | ||
) |
Construct an ExampleSigmaClippedStatsTask.
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 103 of file exampleStatsTasks.py.
def lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask.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 120 of file exampleStatsTasks.py.
|
static |
Definition at line 100 of file exampleStatsTasks.py.