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

Inheritance diagram for lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask:

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

Detailed Description

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.

Constructor & Destructor Documentation

◆ init()

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 __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).
         """
         pipeBase.Task.__init__(self, *args, **kwargs)
  
         self._badPixelMask = afwImage.Mask.getPlaneBitMask(self.config.badMaskPlanes)
  
         self._statsControl = afwMath.StatisticsControl()
         self._statsControl.setNumSigmaClip(self.config.numSigmaClip)
         self._statsControl.setNumIter(self.config.numIter)
         self._statsControl.setAndMask(self._badPixelMask)
  

Member Function Documentation

◆ run()

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.

     def 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
         """
         statObj = afwMath.makeStatistics(maskedImage, afwMath.MEANCLIP | afwMath.STDEVCLIP | afwMath.ERRORS,
                                          self._statsControl)
         mean, meanErr = statObj.getResult(afwMath.MEANCLIP)
         stdDev, stdDevErr = statObj.getResult(afwMath.STDEVCLIP)
         self.log.info("clipped mean=%0.2f; meanErr=%0.2f; stdDev=%0.2f; stdDevErr=%0.2f",
                       mean, meanErr, stdDev, stdDevErr)
         return pipeBase.Struct(
             mean=mean,
             meanErr=meanErr,
             stdDev=stdDev,
             stdDevErr=stdDevErr,
         )
  
  

Member Data Documentation

◆ ConfigClass

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

static

Definition at line 100 of file exampleStatsTasks.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/exampleStatsTasks.py

Public Member Functions

Static Public Attributes