Class Detector::InCameraBuilder

Nested Relationships

This class is a nested type of Class Detector.

Inheritance Relationships

Base Type

Class Documentation

class InCameraBuilder : public lsst::afw::cameraGeom::Detector::Builder

A helper class that allows the properties of a detector to be modified in the course of modifying a full camera.

Detector::InCameraBuilder can only be constructed via Camera::Builder, and all Detector::InCameraBuilder instances should always be owned by or shared with a Camera::Builder.

Unlike Detector::PartialRebuilder, InCameraBuilder can be used to set the orientation, pixel size, and more general coordinate systems associated with the detector.

The transformation from FOCAL_PLANE to PIXELS that relates this detector’s coordinate systems to those of the full camera and other detectors is created from the orientation and pixel size fields, and need not (and cannot) be set explicitly.

Public Functions

void setOrientation(Orientation const &orientation)

Set the orientation of the detector in the focal plane.

void setPixelSize(lsst::geom::Extent2D const &pixelSize)

Set the pixel size (in mm).

void setTransformFromPixelsTo(CameraSysPrefix const &toSys, std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const> transform)

Set the transformation from PIXELS to the given coordinate system.

If a transform already exists from PIXELS to

toSys, it is overwritten.
Parameters

  • toSys: Coordinate system prefix this transform returns points in.

  • transform: Transform from PIXELS to toSys.

void setTransformFromPixelsTo(CameraSys const &toSys, std::shared_ptr<afw::geom::TransformPoint2ToPoint2 const> transform)

Set the transformation from PIXELS to the given coordinate system.

If a transform already exists from PIXELS to

toSys, it is overwritten.
Parameters

  • toSys: Coordinate system prefix this transform returns points in. Must be associated with this detector.

  • transform: Transform from PIXELS to toSys.

Exceptions

  • pex::exceptions::InvalidParameterError: if toSys.getDetectorName() != this->getName().

bool discardTransformFromPixelsTo(CameraSysPrefix const &toSys)

Remove any transformation from PIXELS to the given coordinate system.

Return

true if a transform was removed; false otherwise.

Parameters

  • toSys: Coordinate system prefix this transform returns points in.

bool discardTransformFromPixelsTo(CameraSys const &toSys)

Remove any transformation from PIXELS to the given coordinate system.

Return

true if a transform was removed; false otherwise.

Parameters

  • toSys: Coordinate system prefix this transform returns points in. Must be associated with this detector.

Exceptions

  • pex::exceptions::InvalidParameterError: if toSys.getDetectorName() != this->getName().

void clearTransforms()

Remove all coordinate transforms.