SingleCellCoadd

class lsst.cell_coadds.SingleCellCoadd(outer: OwnedImagePlanes, *, psf: ImageD, inner_bbox: Box2I, inputs: Iterable[ObservationIdentifiers], common: CommonComponents, identifiers: CellIdentifiers, aperture_correction_map: SingleCellCoaddApCorrMap = {})

Bases: CommonComponentsProperties

A single coadd cell, built only from input images that completely overlap that cell.

Parameters:
outerOwnedImagePlanes

The actual coadded images.

psfImageD

The coadded PSF image.

inner_bboxBox2I

The bounding box of the inner region of this cell; must be disjoint with but adjacent to all other cell inner regions.

inputsIterable [ObservationIdentifiers]

Identifiers of observations that contributed to this cell.

commonCommonComponents

Image attributes common to all cells in a patch.

identifiersCellIdentifiers

Struct of identifiers for this cell.

aperture_correction_mapfrozendict [str, float], optional

Mapping of algorithm name to aperture correction value for this cell.

Notes

At present we assume a single PSF image per cell is sufficient to capture spatial variability, which seems adequate given the results we have so far and the cell sizes we intend to use.

Attributes Summary

aperture_corrected_algorithms

An iterable of algorithm names that have aperture correction values.

aperture_correction_map

Mapping of algorithm name to aperture correction values.

band

String label for the filter bandpass.

common

Struct of image components common to all cells in a patch.

identifiers

Struct of unique identifiers for this cell.

inner

Image planes within the inner region of this cell that is disjoint with all other cell inner regions.

inputs

Identifiers for the input images that contributed to this cell, sorted by their visit attribute first, and then by detector.

outer

Image planes within the full outer region of this cell.

psf_image

The coadded PSF image.

units

Units of the coadd's data pixels.

visit_count

Number of visits that contributed to this cell.

wcs

World Coordinate System object that maps the pixel grid to sky coordinates.

Methods Summary

make_view(image[, bbox])

Make a view of an image, optionally within a given bounding box.

Attributes Documentation

aperture_corrected_algorithms

An iterable of algorithm names that have aperture correction values.

Returns:
aperture_corrected_algorithmstuple [str, …]

List of algorithms that have aperture correction values.

aperture_correction_map

Mapping of algorithm name to aperture correction values.

Returns:
aperture_correction_mapfrozendict [str, float]

Mapping of algorithm name to aperture correction values.

band

String label for the filter bandpass.

May be None only for coadds that represent a combination of multiple passbands (e.g. chi^2 detection coadds), not just to indicate absence of knowledge.

common
identifiers

Struct of unique identifiers for this cell.

inner

Image planes within the inner region of this cell that is disjoint with all other cell inner regions.

inputs

Identifiers for the input images that contributed to this cell, sorted by their visit attribute first, and then by detector.

outer

Image planes within the full outer region of this cell.

psf_image

The coadded PSF image.

units

Units of the coadd’s data pixels.

visit_count

Number of visits that contributed to this cell.

wcs

World Coordinate System object that maps the pixel grid to sky coordinates.

Methods Documentation

make_view(image: ImageLike, bbox: Box2I | None = None) ImageLike

Make a view of an image, optionally within a given bounding box.

Parameters:
imageImageLike

The image to make a view of.

bboxBox2I, optional

The bounding box within which to make the view.

Returns:
image_view: ImageLike

The view of the image.