ExampleSimpleStatsTask

class lsst.pipe.tasks.exampleStatsTasks.ExampleSimpleStatsTask(config: Config | None = None, *, name: str | None = None, parentTask: Task | None = None, log: logging.Logger | lsst.utils.logging.LsstLogAdapter | None = None)

Bases: Task

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

This was designed to be run as a subtask by ExampleCmdLineTask. It is about as simple as a task can be; it has no configuration parameters and requires no special initialization. See also ExampleSigmaClippedStatsTask as a variant that is slightly more complicated.

The main method is ExampleSimpleTask.run “run”.

pipeTasks_ExampleSimpleStatsTask_Config Configuration parameters

This task has no configuration parameters.

pipeTasks_ExampleSimpleStatsTask_Debug Debug variables

This task has no debug variables.

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