ExampleSigmaClippedStatsTask

class lsst.pipe.tasks.exampleStatsTasks.ExampleSigmaClippedStatsTask(*args, **kwargs)

Bases: Task

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

Methods Summary

run(maskedImage)

Compute and return statistics for a masked image.

Methods Documentation

run(maskedImage)

Compute and return statistics for a masked image.

Parameters

maskedImagelsst.afw.image.MaskedImage

Masked image to compute statistics on.

Returns

statslsst.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).