CameraFrameSet

class lsst.images.CameraFrameSet(instrument, ast)

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 (via deserialize) or converting a legacy lsst.afw.cameraGeom object (from_legacy).

Parameters:

• instrument (str) – Short (butler dimension) name of the instrument.

• ast (FrameSet) – AST frame set describing the camera’s coordinate systems.

Attributes Summary

instrument

Name of the instrument (str).

Methods Summary

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

detector(detector, *, visit=None)

Return a detector pixel-coordinate frame for this instrument.

Parameters:

• detector (int) – ID of the detector.

• visit (int | None, default: None) – 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 SkyProjection.

Return type:

DetectorFrame

field_angle(visit=None)

Return a field angle frame for this instrument.

Parameters:

visit (int | None, default: None) – 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 SkyProjection.

Return type:

FieldAngleFrame

focal_plane(visit=None)

Return a focal plane frame for this instrument.

Parameters:

visit (int | None, default: None) – 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 SkyProjection.

Return type:

FocalPlaneFrame

classmethod from_legacy(camera)

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

Parameters:

camera (Any) – An lsst.afw.cameraGeom.Camera instance to convert.

Return type:

CameraFrameSet

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.

Parameters:

• in_frame (TypeVar(I, bound= Frame)) – Frame to transform from.

• out_frame (TypeVar(O, bound= Frame)) – Frame to transform to.

Return type:

Optional[Transform[TypeVar(I, bound= Frame), TypeVar(O, bound= Frame)]]

serialize(archive)

Serialize the frame set to an archive.

Parameters:

archive (OutputArchive[Any]) – Archive to serialize to.

Returns:

Serialized form of the frame set.

Return type:

CameraFrameSetSerializationModel