lsst.afw  21.0.0-11-ga6ea59e8e+47cba9fc36
Public Member Functions | List of all members
lsst::afw::cameraGeom::Orientation Class Referencefinal

Describe a detector's orientation in the focal plane. More...

#include <Orientation.h>

Public Member Functions

 Orientation (lsst::geom::Point2D const fpPosition=lsst::geom::Point2D(0, 0), lsst::geom::Point2D const refPoint=lsst::geom::Point2D(-0.5, -0.5), lsst::geom::Angle const yaw=lsst::geom::Angle(0), lsst::geom::Angle const pitch=lsst::geom::Angle(0), lsst::geom::Angle const roll=lsst::geom::Angle(0))
 
 ~Orientation () noexcept
 
 Orientation (Orientation const &) noexcept
 
 Orientation (Orientation &&) noexcept
 
Orientationoperator= (Orientation const &) noexcept
 
Orientationoperator= (Orientation &&) noexcept
 
lsst::geom::Point2D getFpPosition () const noexcept
 Return focal plane position of detector reference point (mm) More...
 
lsst::geom::Point2D getReferencePoint () const noexcept
 Return detector reference point (pixels) More...
 
lsst::geom::Angle getYaw () const noexcept
 Return the yaw angle. More...
 
lsst::geom::Angle getPitch () const noexcept
 Return the pitch angle. More...
 
lsst::geom::Angle getRoll () const noexcept
 Return the roll angle. More...
 
int getNQuarter () const noexcept
 Return the number of quarter turns (rounded to the closest quarter) More...
 
std::shared_ptr< geom::TransformPoint2ToPoint2makePixelFpTransform (lsst::geom::Extent2D const pixelSizeMm) const
 Generate a Transform from pixel to focal plane coordinates. More...
 
std::shared_ptr< geom::TransformPoint2ToPoint2makeFpPixelTransform (lsst::geom::Extent2D const pixelSizeMm) const
 Generate a Transform from focal plane to pixel coordinates. More...
 

Detailed Description

Describe a detector's orientation in the focal plane.

All rotations are about the reference point on the detector. Rotations are intrinsic, meaning each rotation is applied in the coordinates system produced by the previous rotation. Rotations are applied in this order: yaw (Z), pitch (Y'), and roll (X'').

Warning
: default refPoint is -0.5, -0.5 (the lower left corner of a detector). This means that the default-constructed Orientation is not a unity transform, but instead includes a 1/2 pixel shift.

Definition at line 52 of file Orientation.h.

Constructor & Destructor Documentation

◆ Orientation() [1/3]

lsst::afw::cameraGeom::Orientation::Orientation ( lsst::geom::Point2D const  fpPosition = lsst::geom::Point2D(0, 0),
lsst::geom::Point2D const  refPoint = lsst::geom::Point2D(-0.5, -0.5),
lsst::geom::Angle const  yaw = lsst::geom::Angle(0),
lsst::geom::Angle const  pitch = lsst::geom::Angle(                                 0),
lsst::geom::Angle const  roll = lsst::geom::Angle(                                 0) 
)
explicit
Parameters
fpPositionFocal plane position of detector reference point (mm)
refPointReference point on detector (pixels). Offset is measured to this point and all all rotations are about this point. The default value (-0.5, -0.5) is the lower left corner of the detector.
yawyaw: rotation about Z (X to Y), 1st rotation
pitchpitch: rotation about Y' (Z'=Z to X'), 2nd rotation
rollroll: rotation about X'' (Y''=Y' to Z''), 3rd rotation

Definition at line 30 of file Orientation.cc.

◆ ~Orientation()

lsst::afw::cameraGeom::Orientation::~Orientation ( )
defaultnoexcept

◆ Orientation() [2/3]

lsst::afw::cameraGeom::Orientation::Orientation ( Orientation const &  other)
noexcept

Definition at line 52 of file Orientation.cc.

◆ Orientation() [3/3]

lsst::afw::cameraGeom::Orientation::Orientation ( Orientation &&  other)
noexcept

Definition at line 59 of file Orientation.cc.

Member Function Documentation

◆ getFpPosition()

lsst::geom::Point2D lsst::afw::cameraGeom::Orientation::getFpPosition ( ) const
inlinenoexcept

Return focal plane position of detector reference point (mm)

Definition at line 75 of file Orientation.h.

◆ getNQuarter()

int lsst::afw::cameraGeom::Orientation::getNQuarter ( ) const
noexcept

Return the number of quarter turns (rounded to the closest quarter)

Definition at line 85 of file Orientation.cc.

◆ getPitch()

lsst::geom::Angle lsst::afw::cameraGeom::Orientation::getPitch ( ) const
inlinenoexcept

Return the pitch angle.

Definition at line 84 of file Orientation.h.

◆ getReferencePoint()

lsst::geom::Point2D lsst::afw::cameraGeom::Orientation::getReferencePoint ( ) const
inlinenoexcept

Return detector reference point (pixels)

Definition at line 78 of file Orientation.h.

◆ getRoll()

lsst::geom::Angle lsst::afw::cameraGeom::Orientation::getRoll ( ) const
inlinenoexcept

Return the roll angle.

Definition at line 87 of file Orientation.h.

◆ getYaw()

lsst::geom::Angle lsst::afw::cameraGeom::Orientation::getYaw ( ) const
inlinenoexcept

Return the yaw angle.

Definition at line 81 of file Orientation.h.

◆ makeFpPixelTransform()

std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > lsst::afw::cameraGeom::Orientation::makeFpPixelTransform ( lsst::geom::Extent2D const  pixelSizeMm) const

Generate a Transform from focal plane to pixel coordinates.

Returns
lsst::afw::geom::Transform from focal plane to pixel coordinates
Parameters
pixelSizeMmSize of the pixel in mm in X and Y

Definition at line 107 of file Orientation.cc.

◆ makePixelFpTransform()

std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > lsst::afw::cameraGeom::Orientation::makePixelFpTransform ( lsst::geom::Extent2D const  pixelSizeMm) const

Generate a Transform from pixel to focal plane coordinates.

Returns
lsst::afw::geom::Transform from pixel to focal plane coordinates
Parameters
pixelSizeMmSize of the pixel in mm in X and Y

Definition at line 93 of file Orientation.cc.

◆ operator=() [1/2]

Orientation & lsst::afw::cameraGeom::Orientation::operator= ( Orientation &&  other)
noexcept

Definition at line 75 of file Orientation.cc.

◆ operator=() [2/2]

Orientation & lsst::afw::cameraGeom::Orientation::operator= ( Orientation const &  other)
noexcept

Definition at line 66 of file Orientation.cc.


The documentation for this class was generated from the following files: