lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask Class Reference

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__
	Construct an ExampleSigmaClippedStatsTask. More...
def	run
	Compute and return statistics for a masked image. More...

Static Public Attributes
	ConfigClass = ExampleSigmaClippedStatsConfig

Private Attributes
	_badPixelMask
	_statsControl

Static Private Attributes
string	_DefaultName = "exampleSigmaClippedStats"

Detailed Description

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

Contents

• Description
• Configuration parameters
• Debug variables
• A complete example of using ExampleSigmaClippedStatsTask

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 run.

Configuration parameters

See ExampleSigmaClippedStatsConfig

Debug variables

This task has no debug variables.

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]

Definition at line 62 of file exampleStatsTasks.py.

Constructor & Destructor Documentation

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 100 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 = MaskU.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)