Core API Reference

lsst.images Package

Functions

get_legacy_deep_coadd_mask_planes()	Return a mapping from legacy mask plane name to MaskPlane instance for LSST deep coadds, c.
get_legacy_difference_image_mask_planes()	Return a mapping from legacy mask plane name to MaskPlane instance for LSST difference images, c.
get_legacy_non_cell_coadd_mask_planes()	Return a mapping from legacy mask plane name to MaskPlane instance for LSST non-cell coadds such as template_coadd in DP2, and all DP1 coadds.
get_legacy_optional_mask_planes()	Return a mapping from legacy mask plane name to MaskPlane instance for the planes that only some images carry.
get_legacy_template_mask_planes()	Return a mapping from legacy mask plane name to MaskPlane instance for image differencing template images.
get_legacy_visit_image_mask_planes()	Return a mapping from legacy mask plane name to MaskPlane instance for LSST visit images, c.
obs_info_from_legacy(visit_info, ...[, ...])	Recover the observation info struct of a legacy lsst.afw.image.Exposure.

Classes

AbsoluteSliceProxy(parent)	A proxy object for obtaining a generalized image subset using absolute slicing.
Background(name, field[, description])	A named background model and optional description.
BackgroundMap([backgrounds, subtracted])	A mapping of background models associated with an image.
BackgroundMapSerializationModel	Serialization model for background maps.
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.
ColorImage(array, /, *[, bbox, yx0, ...])	An RGB image with an optional SkyProjection.
Describable(*args, **kwargs)	An object that can produce a Report describing itself.
DescribableMixin()	Mixin that wires repr, str, rich, and HTML rendering to _describe.
DescribeOptions([brief, detail, exclude])	Rendering options threaded through a tree of Report objects.
DetectorFrame	A coordinate frame for a particular detector's pixels.
DifferenceImage(image, *[, mask, variance, ...])	An image that is the PSF-matched difference of two other images.
DifferenceImageSerializationModel	A Pydantic model used to represent a serialized DifferenceImage.
DifferenceImageTemplateInfo	Information about how a template image contributed to a difference image.
FieldAngleFrame	An angular coordinate frame that maps a camera onto the sky about its boresight.
FieldRole(value[, names, module, qualname, ...])	Where a report field appears: in repr, in the expanded report, or both.
FocalPlaneFrame	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	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 sky projection.
Image([array_or_fill, bbox, yx0, shape, ...])	A 2-d array that may be augmented with units and a nonzero origin.
ImageSerializationModel	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, yx0, 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	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	A Pydantic model used to represent a serialized MaskedImage.
MetadataView(native, external)	Combined view of an image's native and external metadata.
NoOverlapError	Exception raised when intervals or bounds do not overlap.
NotContainedError	Exception raised when intervals or bounds are not fully contained by another.
ObservationSummaryStats	Various statistics obtained from a single observation.
Polygon(*, x_vertices, y_vertices)	A simple 2-d polygon in Euclidean coordinates, with no holes.
Region(geometry)	A 2-d Euclidean region represented as one or more polygons with optional holes.
RegionSerializationModel	Serialization model for Region and Polygon.
Report(type_name[, title, summary, fields, ...])	A renderer-agnostic description of an object.
ReportField(label, value[, unit, ...])	A single labeled value in a Report.
ReportTable(title, columns, rows[, role])	Homogeneous columnar data rendered as an aligned table.
ReportValueGroup(values[, role])	Short labeled values packed several to a rendered line.
SkyFrame(value[, names, module, qualname, ...])	The special frame that represents the sky, in ICRS coordinates.
SkyProjection(pixel_to_sky[, fits_approximation])	A transform from pixel coordinates to sky coordinates.
SkyProjectionAstropyView(ast_pixel_to_sky, bbox)	An Astropy-interface view of a SkyProjection.
SkyProjectionSerializationModel	Serialization model for projetions.
TractFrame	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	Serialization model for coordinate transforms.
VisitImage(image, *[, mask, variance, ...])	A calibrated single-visit image.
VisitImageSerializationModel	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).