CameraFrameSet#

class lsst.images.CameraFrameSet(instrument: str, ast: FrameSet)#

Bases: FrameSet

A FrameSet that manages the coordinate systems of a camera.

The CameraFrameSet class constructor is considered a private implementation detail. At present, instances can only be obtained by loading them from storage (deserialize) or converting a legacy lsst.afw.cameraGeom object (from_legacy).

Attributes Summary

instrument

Name of the instrument (str).

Methods Summary

`deserialize`(model, archive)	Deserialize a frame set from an archive.
`detector`(detector, *[, visit])	Return a detector pixel-coordinate frame for this instrument.
`field_angle`([visit])	Return a field angle frame for this instrument.
`focal_plane`([visit])	Return a focal plane frame for this instrument.
`from_legacy`(camera)	Construct a transform from a legacy `lsst.afw.cameraGeom.Camera`.
`get`(in_frame, out_frame)	Return the `Transform` that maps the two frames, or `None` if at least one is not known to the `FrameSet`.
`serialize`(archive)	Serialize the frame set to an archive.

Attributes Documentation

instrument#: Name of the instrument (str).

Methods Documentation

static deserialize(model: CameraFrameSetSerializationModel, archive: InputArchive[Any]) → CameraFrameSet#

Deserialize a frame set from an archive.

Parameters#

model: Seralized form of the frame set.
archive: Archive to read from.

detector(detector: int, *, visit: int | None = None) → DetectorFrame#

Return a detector pixel-coordinate frame for this instrument.

Parameters#

detector: ID of the detector.
visit: ID for the visit this frame will correspond to. This only needs to be provided in contexts where camera frames will be related to the sky via a Projection.

field_angle(visit: int | None = None) → FieldAngleFrame#

Return a field angle frame for this instrument.

Parameters#

visit: ID for the visit this frame will correspond to. This only needs to be provided in contexts where camera frames will be related to the sky via a Projection.

focal_plane(visit: int | None = None) → FocalPlaneFrame#

Return a focal plane frame for this instrument.

Parameters#

visit: ID for the visit this frame will correspond to. This only needs to be provided in contexts where camera frames will be related to the sky via a Projection.

classmethod from_legacy(camera: Any) → CameraFrameSet#

Construct a transform from a legacy lsst.afw.cameraGeom.Camera.

Parameters#

camera: An lsst.afw.cameraGeom.Camera instance to convert.

get(in_frame: I, out_frame: O) → Transform | None#: Return the Transform that maps the two frames, or None if at least one is not known to the FrameSet.

serialize(archive: OutputArchive[Any]) → CameraFrameSetSerializationModel#

Serialize the frame set to an archive.

Parameters#

archive: Archive to serialize to.

Returns#

CameraFrameSetSerializationModel: Serialized form of the frame set.