Inheritance diagram for lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask:
Public Member Functions | |
| __init__ (self, *args, **kwargs) | |
| run (self, maskedImage) | |
Static Public Attributes | |
| ConfigClass = ExampleSigmaClippedStatsConfig | |
Protected Attributes | |
| _badPixelMask | |
| _statsControl | |
Static Protected Attributes | |
| str | _DefaultName = "exampleSigmaClippedStats" |
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__()
| lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask.__init__ | ( | self, | |
| * | args, | ||
| ** | kwargs ) |
Definition at line 66 of file exampleStatsTasks.py.
66 def __init__(self, *args, **kwargs):
67 pipeBase.Task.__init__(self, *args, **kwargs)
68
69 self._badPixelMask = afwImage.Mask.getPlaneBitMask(self.config.badMaskPlanes)
70
71 self._statsControl = afwMath.StatisticsControl()
72 self._statsControl.setNumSigmaClip(self.config.numSigmaClip)
73 self._statsControl.setNumIter(self.config.numIter)
74 self._statsControl.setAndMask(self._badPixelMask)
75
Member Function Documentation
◆ run()
| 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.
77 def run(self, maskedImage):
78 """Compute and return statistics for a masked image.
79
80 Parameters
81 ----------
82 maskedImage : `lsst.afw.image.MaskedImage`
83 Masked image to compute statistics on.
84
85 Returns
86 -------
87 stats : `lsst.pipe.base.Struct`
88 Statistics as a struct with attributes:
89
90 ``mean``
91 Mean of image plane (`float`).
92 ``meanErr``
93 Uncertainty in mean (`float`).
94 ``stdDev``
95 Standard deviation of image plane (`float`).
96 ``stdDevErr``
97 Uncertainty in standard deviation (`float`).
98 """
99 statObj = afwMath.makeStatistics(maskedImage, afwMath.MEANCLIP | afwMath.STDEVCLIP | afwMath.ERRORS,
100 self._statsControl)
101 mean, meanErr = statObj.getResult(afwMath.MEANCLIP)
102 stdDev, stdDevErr = statObj.getResult(afwMath.STDEVCLIP)
103 self.log.info("clipped mean=%0.2f; meanErr=%0.2f; stdDev=%0.2f; stdDevErr=%0.2f",
104 mean, meanErr, stdDev, stdDevErr)
105 return pipeBase.Struct(
106 mean=mean,
107 meanErr=meanErr,
108 stdDev=stdDev,
109 stdDevErr=stdDevErr,
110 )
111
112
Statistics makeStatistics(lsst::afw::image::Image< Pixel > const &img, lsst::afw::image::Mask< image::MaskPixel > const &msk, int const flags, StatisticsControl const &sctrl=StatisticsControl())
Handle a watered-down front-end to the constructor (no variance)
Definition Statistics.h:361
Member Data Documentation
◆ _badPixelMask
|
protected |
Definition at line 69 of file exampleStatsTasks.py.
◆ _DefaultName
|
staticprotected |
Definition at line 64 of file exampleStatsTasks.py.
◆ _statsControl
|
protected |
Definition at line 71 of file exampleStatsTasks.py.
◆ ConfigClass
|
static |
Definition at line 63 of file exampleStatsTasks.py.
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/pipe_tasks/g14a832a312+9d12ad093c/python/lsst/pipe/tasks/exampleStatsTasks.py
