# BeamInfo¶

class lsst.cbp.BeamInfo(cameraGeom, name, holePos, isOnPupil, isOnFocalPlane, focalPlanePos, pupilPos, focalFieldAngle, pupilFieldAngle)

Bases: object

Information about a beam at the telescope.

Note that this is information about the fiducial position of the beam; it tell you nothing about the rest of the beam. Thus, for instance, a broad beam may easily have some light on a detector even if isVisible is False.

Parameters: cameraGeom : lsst.afw.cameraGeom.Camera Camera geometry name : str Beam name holePos : pair of float Hole position on CBP mask (x, y mm) isOnPupil : bool See fields below isOnFocalPlane : bool See fields below focalPlanePos : pair of float See fields below pupilPos : pair of float See fields below focalFieldAngle : pair of float See fields below pupilFieldAngle : pair of float See fields below

Notes

Attributes

name : str
Name of beam.
holePos : pair of float
Position of hole on CBP mask (x, y mm).
isOnPupil : bool
True if the beam is likely on the pupil and not obscured by the secondary.
isOnFocalPlane : bool

True if the beam is likely on the focal plane.

This is independent of isOnPupil; both must be true for light from the beam to be on the focal plane.

focalPlanePos : lsst.geom.Point2D
Telescope focal plane position of beam (x, y mm).
focalFieldAngle : lsst.geom.Point2D
Focal plane field angle of beam (x, y rad).
pupilFieldAngle : lsst.geom.Point2D
Pupil field angle of beam (x, y rad).
pupilPos : lsst.geom.Point2D
Telescope pupil plane position of beam (x, y mm).

Attributes Summary

 detectorName The name of the detector that the beam falls on, or None if isOnDetector is False. detectorPos The position of the spot on the detector, or (nan, nan) if isOnDetector is False. isOnDetector Is the spot from the beam on a detector? isVisible Is light from the beam visible on a detector?

Attributes Documentation

detectorName

The name of the detector that the beam falls on, or None if isOnDetector is False.

detectorPos

The position of the spot on the detector, or (nan, nan) if isOnDetector is False.

isOnDetector

Is the spot from the beam on a detector?

isVisible

Is light from the beam visible on a detector?