BinImageDataTask

class lsst.ip.isr.BinImageDataTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: dict[str, Any] | None = None, **kwargs: Any)

Bases: PipelineTask

Perform an nxn binning of an image or image-like dataset.

The binning factor is the same in both spatial dimensions (i.e., an nxn binning is performed). In the case of MaskedImages and Exposures, each of the input image planes are binned by the same factor.

Methods Summary

run(inputData[, binFactor])

Perform an nxn binning of image and image-like data.

Methods Documentation

run(inputData, binFactor=None)

Perform an nxn binning of image and image-like data.

Parameters:

inputDatalsst.afw.image.Image or lsst.afw.image.MaskedImage or

lsst.afw.image.Exposure or one of their sub-types.

Data to spatially bin

binFactorint, optional.

nxn binning factor. If not provided then self.config.binFactor is used.

Returns:

resultlsst.pipe.base.Struct

Results as a struct with attributes:

outputData

Binned data (lsst.afw.image.Image or lsst.afw.image.MaskedImage or lsst.afw.image.Exposure or one of their sub-types. The type matches that of the input.).