FocalPlaneFrame

pydantic model lsst.images.FocalPlaneFrame

A Euclidean coordinate frame for the focal plane of a camera.

Parameters:

data (Any)

Fields:

• frame_type (Literal['FOCAL_PLANE'])

• instrument (str)

• unit (Unit)

• visit (int | None)

field frame_type: Literal['FOCAL_PLANE'] = 'FOCAL_PLANE'

Discriminator for the frame type.

field instrument: str [Required]

Name of the instrument.

field unit: Unit [Required]

Units of the coordinates in this frame.

field visit: int | None = None

ID of the visit. May be unset in contexts where there is no visit or only a relevant single visit.

deserialize()

Convert a serialized frame to an in-memory one.

Return type:

FocalPlaneFrame

serialize()

Return a Pydantic-serializable version of this Frame.

Return type:

FocalPlaneFrame

standardize_x(x)

Coerce x coordinates into their standard range.

Parameters:

x (TypeVar(T, bound= float | ndarray)) – Coordinates to standardize.

Return type:

TypeVar(T, bound= float | ndarray)

standardize_y(y)

Coerce y coordinates into their standard range.

Parameters:

y (TypeVar(T, bound= float | ndarray)) – Coordinates to standardize.

Return type:

TypeVar(T, bound= float | ndarray)