DetectorFrame

pydantic model lsst.images.DetectorFrame

A coordinate frame for a particular detector’s pixels.

Notes

This frame is only used for post-assembly images (i.e. not those with overscan regions still present).

Parameters:

data (Any)

Fields:

• bbox (lsst.images._geom.Box)

• detector (int)

• frame_type (Literal['DETECTOR'])

• instrument (str)

• visit (int | None)

field bbox: Box [Required]

Bounding box of the detector.

field detector: int [Required]

ID of the detector.

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

Discriminator for the frame type.

field instrument: str [Required]

Name of the instrument.

field visit: int | None = None

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

deserialize()

Convert a serialized frame to an in-memory one.

Return type:

DetectorFrame

serialize()

Return a Pydantic-serializable version of this Frame.

Return type:

DetectorFrame

standardize_x(x)

Coerce x coordinates into their standard range.

Parameters:

x (TypeVar(T, bound= float | ndarray)) – x coordinate values 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)) – y coordinate values to standardize.

Return type:

TypeVar(T, bound= float | ndarray)

property unit: UnitBase

Units of the coordinates in this frame (astropy.units.UnitBase).