lsst.ip.isr.binImageDataTask Namespace Reference

Classes
class	BinImageDataConnections

Typedefs
type	binFactor = self.config.binFactor

Functions
	binImageData (inputData, binFactorbinFactor=8)

Variables
	config : `BinExposureConfig`
	Parameters :
	inputData : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` or
	Returns :
	result : `lsst.pipe.base.Struct`

Typedef Documentation

binFactor

lsst.ip.isr.binImageDataTask.binFactor = self.config.binFactor

Definition at line 153 of file binImageDataTask.py.

Function Documentation

binImageData()

binImageData	(		inputData,
			binFactor = 8 )

Bin image and image-like data to reduce its spatial dimensions.

Performs an nxn binning of the input data, reducing both spatial
dimensions of each of the input image data by the provided
factor.

Parameters:
-----------
inputData:  `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` or
            `lsst.afw.image.Exposure` or one of their sub-types.
    Input data to bin.
binFactor:  `int`
    Binning factor to apply to each input exposure's image data.
    Default 8.

Returns:
--------
binnedImage or binnedExposure: `lsst.afw.image.Image` or
    `lsst.afw.image.MaskedImage` or `lsst.afw.image.Exposure` or one of
    their sub-types.
    Binned version of input image.

Raises
------
TypeError
    Raised if either the binning factor is not of type `int`, or if the
    input data to be binned is not of type `lsst.afw.image.Exposure`
    or one of its sub-types.

Definition at line 160 of file binImageDataTask.py.

Variable Documentation

config

lsst.ip.isr.binImageDataTask.config : `BinExposureConfig`

Definition at line 59 of file binImageDataTask.py.

inputData

lsst.ip.isr.binImageDataTask.inputData : `lsst.afw.image.Image` or `lsst.afw.image.MaskedImage` or

Definition at line 138 of file binImageDataTask.py.

Parameters

lsst.ip.isr.binImageDataTask.Parameters :

super().__init__(config=config)
if config and config.inputDimensions != self.inputData.dimensions:
    self.dimensions.clear()
    self.dimensions.update(config.inputDimensions)
    self.inputData = cT.Input(
        name=self.inputData.name,
        doc=self.inputData.doc,
        storageClass=self.inputData.storageClass,
        dimensions=frozenset(config.inputDimensions),
    )
    self.outputData = cT.Output(
        name=self.outputData.name,
        doc=self.outputData.doc,
        storageClass=self.outputData.storageClass,
        dimensions=frozenset(config.inputDimensions),
    )
if config and config.inputStorageClass != self.inputData.storageClass:
    self.inputData = cT.Input(
        name=self.inputData.name,
        doc=self.inputData.doc,
        storageClass=config.inputStorageClass,
        dimensions=self.inputData.dimensions,
    )
    self.outputData = cT.Output(
        name=self.outputData.name,
        doc=self.outputData.doc,
        storageClass=config.inputStorageClass,
        dimensions=self.outputData.dimensions,
    )


class BinImageDataConfig(
pipeBase.PipelineTaskConfig, pipelineConnections=BinImageDataConnections
):

inputDimensions = pexConfig.ListField(
# Sort to ensure default order is consistent between runs
default=sorted(BinImageDataConnections.dimensions),
dtype=str,
doc="Override for the dimensions of the input and output data.",
)
inputStorageClass = pexConfig.Field(
default="ExposureF",
dtype=str,
doc=(
    "Override the storageClass of the input and output data. "
    "Must be of type `Image`, `MaskedImage`, or `Exposure`, "
    "or one of their subtypes."
),
)
binFactor = pexConfig.Field(
dtype=int,
doc="Binning factor applied to both spatial dimensions.",
default=8,
check=lambda x: x > 1,
)


class BinImageDataTask(pipeBase.PipelineTask):

ConfigClass = BinImageDataConfig
_DefaultName = "binImageData"

@timeMethod
def run(self, inputData, binFactor=None):

Definition at line 136 of file binImageDataTask.py.

result

lsst.ip.isr.binImageDataTask.result : `lsst.pipe.base.Struct`

Definition at line 147 of file binImageDataTask.py.

Returns

lsst.ip.isr.binImageDataTask.Returns :

Definition at line 145 of file binImageDataTask.py.