CoordinateConverterConfig

class lsst.cbp.CoordinateConverterConfig(*, telPupilOffset, telPupilDiameter, telPupilObscurationDiameter, telFocalPlaneDiameter, telFlipX, telAzimuthOffsetDeg, telAzimuthScale, telAltitudeOffsetDeg=0, telAltitudeScale=1, telAltitudeLimitsDeg, telRotOffsetDeg, telRotScale, defaultDetector, cbpPosition, cbpFocalLength, cbpFlipX, cbpAzimuthOffsetDeg, cbpAzimuthScale, cbpAltitudeOffsetDeg=0, cbpAltitudeScale=1, cbpAltitudeLimitsDeg)

Bases: object

Configuration for the CoordinateConverter.

Configuration for the lsst.cbp.CoordinateConverter.

Parameters:
telPupilOffset : float

Offset of the telescope pupil plane from the center of the telescope (mm, positive if closer to the sky).

telPupilDiameter : float

Diameter of telescope pupil (mm).

telPupilObscurationDiameter : float

Diameter of the telescope central obscuration at the pupil plane (mm).

telFocalPlaneDiameter : float

Diameter of telescope flocal plane (mm).

telFlipX : bool

True if the x axis of the telescope focal plane is flipped with respect to the pupil frame.

telAzimuthOffsetDeg : float

Azimuth offset (degrees).

telAzimuthScale : float

Azimuth scale; must be ±1 (in order to handle wrap correctly).

telAltitudeOffsetDeg : float (optional)

Telescope altitude offset (degrees); defaults to 0.

telAltitudeScale : float (optional)

Telescope altitude scale; defaults to 1.

telAltitudeLimitsDeg : pair of float

Telescope minimum, maximum allowed observed altitude (degrees).

telRotOffsetDeg : float

Telescope camera rotator offset (degrees).

telRotScale : float

Telescope camera rotator scale; must be ±1 (in order to handle wrap correctly).

defaultDetector : str

Name of default detector.

cbpPosition : triplet of float

CBP x, y, z position of center of CBP relative to the center of the telescope, in the base frame (mm).

cbpFocalLength : float

Effective focal length of the CBP (mm); 635 mm is an estimate for the LSST’s CBP.

cbpFlipX : bool

True if the x axis of the CBP focal plane is flipped with respect to the pupil frame?

cbpAzimuthOffsetDeg : float

CBP azimuth offset (degrees).

cbpAzimuthScale : float

CBP azimuth scale; must be ±1 (in order to handle wrap correctly).

cbpAltitudeOffsetDeg : float (optional)

CBP altitude offset (degrees); defaults to 0.

cbpAltitudeScale : float (optional)

CBP altitude scale; defaults to 1.

cbpAltitudeLimitsDeg : pair of float

CBP minimum, maximum allowed observed altitude (degrees).

Raises:
ValueError

Raised if telAzimuthScale, cbpAzimuthScale and/or telRotScale is not ±1.

ValueError

Raised if items with multiple values have the wrong length.

Notes

Offset and Scale:

Azimuth, altitude and rotator offset and scale define the mapping between internal angle and observed angle as follows:

observed angle = internal angle * scale + offset

Attributes

telPupilOffset : float
Offset of the telescope pupil plane from the center of the telescope (mm, + if closer to the sky).
telPupilDiameter : float
Diameter of telescope pupil (mm).
telPupilObscurationDiameter : float
Diameter of the telescope central obscuration at the pupil plane (mm).
telFocalPlaneDiameter : float
Diameter of telescope flocal plane (mm).
telFlipX : bool
True if the x axis of the telescope focal plane is flipped with respect to the pupil frame.
telAzAltOffset : pair of lsst.geom.Angle
Telescope azimuth and altitude offset (degrees).
telAzAltScale : pair of float
Telescope azimuth and altitude scale; azimuth scale is ±1.
telAltitudeLimits : pair of lsst.geom.Angle
Telescope minimum, maximum allowed observed altitude.
telRotOffset : lsst.geom.Angle
Telescope camera rotator offset.
telRotScale : float
Telescope camera rotator scale; must be ±1.
defaultDetector : str
Name of default detector.
cbpFocalLength : float
Effective focal length of the CBP (mm); 635 mm is an estimate for the LSST’s CBP.
cbpFlipX : bool
True if the x axis of the CBP focal plane is flipped with respect to the pupil frame?
cbpAzAltOffset : pair of lsst.geom.Angle
CBP azimuth and altitude offset (degrees).
cbpAzAltScale : pair of float
CBP azimuth and altitude scale; azimuth scale is ±1.
cbpAltitudeLimits : pair of lsst.geom.Angle
CBP minimum, maximum allowed observed altitude.

Attributes Summary

cbpDistance The distance from the telescope to the CBP (mm, read only).
cbpPosition The position of the CBP in the base frame (mm, read/write).

Attributes Documentation

cbpDistance

The distance from the telescope to the CBP (mm, read only).

cbpPosition

The position of the CBP in the base frame (mm, read/write).