Core API Reference

lsst.images Package

Functions

get_legacy_visit_image_mask_planes()

Return a mapping from legacy mask plane name to MaskPlane instance for LSST visit images, c.

Classes

AbsoluteSliceProxy(parent)	A proxy object for obtaining a generalized image subset using absolute slicing.
Bounds(*args, **kwargs)	A protocol for objects that represent the validity region for a function defined in 2-d pixel coordinates.
BoundsError	Exception raised when an object is evaluated outside its bounds.
Box(y, x)	An axis-aligned 2-d rectangular region.
BoxSliceFactory(y, x)	A factory for Box objects using array-slice syntax.
CameraFrameSet(instrument, ast)	A FrameSet that manages the coordinate systems of a camera.
CameraFrameSetSerializationModel(*, ...)	Serialization model for CameraFrameSet.
ColorImage(array, /, *[, bbox, start, ...])	An RGB image with an optional Projection.
DetectorFrame(*, metadata, MetadataValue] =, ...)	A coordinate frame for a particular detector's pixels.
FieldAngleFrame(*, metadata, ...)	An angular coordinate frame that maps a camera onto the sky about its boresight.
FocalPlaneFrame(*, metadata, ...)	A Euclidean coordinate frame for the focal plane of a camera.
Frame(*args, **kwargs)	A description of a coordinate system.
FrameLookupError	Exception raised when a frame cannot be found in a FrameSet.
FrameSet()	A container or factory for Transform objects that relates frames.
GeneralFrame(*, metadata, MetadataValue] =, ...)	An arbitrary Euclidean coordinate system.
GeneralizedImage([metadata])	A base class for types that represent one or more 2-d image-like arrays with the same pixel grid and projection.
Image([array_or_fill, bbox, start, shape, ...])	A 2-d array that may be augmented with units and a nonzero origin.
ImageSerializationModel(*, metadata, ...)	Pydantic model used to represent the serialized form of an Image.
Interval(start, stop)	A 1-d integer interval with positive size.
IntervalSliceFactory([parent, is_local])	A factory for Interval objects using array-slice syntax.
LocalSliceProxy(parent)	A proxy object for obtaining a generalized image subset using local slicing.
Mask([array_or_fill, bbox, start, shape, ...])	A 2-d bitmask image backed by a 3-d byte array.
MaskPlane(name, description)	Name and description of a single plane in a mask array.
MaskPlaneBit(index, mask)	The nested array index and mask value associated with a single mask plane.
MaskSchema(planes, dtype, ...)	A schema for a bit-packed mask array.
MaskSerializationModel(*, metadata, ...)	Pydantic model used to represent the serialized form of a Mask.
MaskedImage(image, *[, mask, variance, ...])	A multi-plane image with data (image), mask, and variance planes.
MaskedImageSerializationModel(*, metadata, ...)	A Pydantic model used to represent a serialized MaskedImage.
NoOverlapError	Exception raised when intervals or bounds do not overlap.
ObservationSummaryStats(*, version, ...)
Projection(pixel_to_sky[, fits_approximation])	A transform from pixel coordinates to sky coordinates.
ProjectionAstropyView(ast_pixel_to_sky, bbox)	An Astropy-interface view of a Projection.
ProjectionSerializationModel(*, metadata, ...)	Serialization model for projetions.
SkyFrame(value[, names, module, qualname, ...])	The special frame that represents the sky, in ICRS coordinates.
TractFrame(*, metadata, MetadataValue] =, ...)	The pixel coordinates of a tract: a region on the sky used for coaddition, defined by a 'skymap' and split into 'patches' that share a common pixel grid.
Transform(in_frame, out_frame, ast_mapping)	A transform that maps two coordinate frames.
TransformCompositionError	Exception raised when two transforms cannot be composed.
TransformSerializationModel(*, metadata, ...)	Serialization model for coordinate transforms.
VisitImage(image, *[, mask, variance, ...])	A calibrated single-visit image.
VisitImageSerializationModel(*, metadata, ...)	A Pydantic model used to represent a serialized VisitImage.
XY(x, y)	A pair of per-dimension objects, ordered (x, y).
YX(y, x)	A pair of per-dimension objects, ordered (y, x).