ImageMapReduceConfig

class lsst.ip.diffim.ImageMapReduceConfig

Bases: lsst.pex.config.config.Config

Configuration parameters for the ImageMapReduceTask

Attributes Summary

adjustGridOption Whether and how to adjust grid to fit evenly within, and cover entire
borderSizeX Dimensions of grid cell border in +/- x direction, to be used for generating expandedSubExposure.
borderSizeY Dimensions of grid cell border in +/- y direction, to be used for generating expandedSubExposure.
cellCentroidsX Input X centroids around which to place subimages.
cellCentroidsY Input Y centroids around which to place subimages.
cellSizeX Dimensions of each grid cell in x direction (float, default 10.0)
cellSizeY Dimensions of each grid cell in y direction (float, default 10.0)
gridStepX Spacing between subsequent grid cells in x direction.
gridStepY Spacing between subsequent grid cells in y direction.
ignoreMaskPlanes Mask planes to ignore for sigma-clipped statistics (List, default ('INTRP', 'EDGE', 'DETECTED', 'SAT', 'CR', 'BAD', 'NO_DATA', 'DETECTED_NEGATIVE'))
mapper Task to run on each subimage (ConfigurableInstance, default <class 'lsst.ip.diffim.imageMapReduce.ImageMapperConfig'>)
reducer Task to combine results of mapper task (ConfigurableInstance, default <class 'lsst.ip.diffim.imageMapReduce.ImageReducerConfig'>)
returnSubImages Return the input subExposures alongside the processed ones (for debugging) (bool, default False)
scaleByFwhm Scale cellSize/gridStep/borderSize/overlapSize by PSF FWHM rather than pixels? (bool, default True)

Attributes Documentation

adjustGridOption
Whether and how to adjust grid to fit evenly within, and cover entire
image (str, default 'spacing')

Allowed values:

'spacing'
adjust spacing between centers of grid cells (allowing overlaps)
'size'
adjust the sizes of the grid cells (disallowing overlaps)
'none'
do not adjust the grid sizes or spacing
'None'
Field is optional
borderSizeX

Dimensions of grid cell border in +/- x direction, to be used for generating expandedSubExposure. (float, default 5.0)

borderSizeY

Dimensions of grid cell border in +/- y direction, to be used for generating expandedSubExposure. (float, default 5.0)

cellCentroidsX

Input X centroids around which to place subimages. If None, use grid config options below. (List, default None)

cellCentroidsY

Input Y centroids around which to place subimages. If None, use grid config options below. (List, default None)

cellSizeX

Dimensions of each grid cell in x direction (float, default 10.0)

cellSizeY

Dimensions of each grid cell in y direction (float, default 10.0)

gridStepX

Spacing between subsequent grid cells in x direction. If equal to cellSizeX, then there is no overlap in the x direction. (float, default 10.0)

gridStepY

Spacing between subsequent grid cells in y direction. If equal to cellSizeY, then there is no overlap in the y direction. (float, default 10.0)

ignoreMaskPlanes

Mask planes to ignore for sigma-clipped statistics (List, default ('INTRP', 'EDGE', 'DETECTED', 'SAT', 'CR', 'BAD', 'NO_DATA', 'DETECTED_NEGATIVE'))

mapper

Task to run on each subimage (ConfigurableInstance, default <class 'lsst.ip.diffim.imageMapReduce.ImageMapperConfig'>)

reducer

Task to combine results of mapper task (ConfigurableInstance, default <class 'lsst.ip.diffim.imageMapReduce.ImageReducerConfig'>)

returnSubImages

Return the input subExposures alongside the processed ones (for debugging) (bool, default False)

scaleByFwhm

Scale cellSize/gridStep/borderSize/overlapSize by PSF FWHM rather than pixels? (bool, default True)