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:
telPupilOffsetfloat

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

telPupilDiameterfloat

Diameter of telescope pupil (mm).

telPupilObscurationDiameterfloat

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

telFocalPlaneDiameterfloat

Diameter of telescope flocal plane (mm).

telFlipXbool

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

telAzimuthOffsetDegfloat

Azimuth offset (degrees).

telAzimuthScalefloat

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

telAltitudeOffsetDegfloat (optional)

Telescope altitude offset (degrees); defaults to 0.

telAltitudeScalefloat (optional)

Telescope altitude scale; defaults to 1.

telAltitudeLimitsDegpair of float

Telescope minimum, maximum allowed observed altitude (degrees).

telRotOffsetDegfloat

Telescope camera rotator offset (degrees).

telRotScalefloat

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

defaultDetectorstr

Name of default detector.

cbpPositiontriplet of float

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

cbpFocalLengthfloat

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

cbpFlipXbool

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

cbpAzimuthOffsetDegfloat

CBP azimuth offset (degrees).

cbpAzimuthScalefloat

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

cbpAltitudeOffsetDegfloat (optional)

CBP altitude offset (degrees); defaults to 0.

cbpAltitudeScalefloat (optional)

CBP altitude scale; defaults to 1.

cbpAltitudeLimitsDegpair 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

telPupilOffsetfloat

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

telPupilDiameterfloat

Diameter of telescope pupil (mm).

telPupilObscurationDiameterfloat

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

telFocalPlaneDiameterfloat

Diameter of telescope flocal plane (mm).

telFlipXbool

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

telAzAltOffsetpair of lsst.geom.Angle

Telescope azimuth and altitude offset (degrees).

telAzAltScalepair of float

Telescope azimuth and altitude scale; azimuth scale is ±1.

telAltitudeLimitspair of lsst.geom.Angle

Telescope minimum, maximum allowed observed altitude.

telRotOffsetlsst.geom.Angle

Telescope camera rotator offset.

telRotScalefloat

Telescope camera rotator scale; must be ±1.

defaultDetectorstr

Name of default detector.

cbpFocalLengthfloat

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

cbpFlipXbool

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

cbpAzAltOffsetpair of lsst.geom.Angle

CBP azimuth and altitude offset (degrees).

cbpAzAltScalepair of float

CBP azimuth and altitude scale; azimuth scale is ±1.

cbpAltitudeLimitspair 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).