lsst::afw::cameraGeom::DetectorBase Class Reference

An abstract base class that provides common accessors for Detector and Detector::Builder. More...

#include <Detector.h>

Inheritance diagram for lsst::afw::cameraGeom::DetectorBase:

Classes
struct	Fields

Public Types
using	CrosstalkMatrix = ndarray::Array<float const, 2>

Public Member Functions
virtual	~DetectorBase () noexcept=default
std::string	getName () const
	Get the detector name.
int	getId () const
	Get the detector ID.
DetectorType	getType () const
	Return the purpose of this detector.
std::string	getSerial () const
	Get the detector serial "number".
std::string	getPhysicalType () const
	Get the detector's physical type.
lsst::geom::Box2I	getBBox () const
	Get the bounding box.
Orientation	getOrientation () const
	Get detector's orientation in the focal plane.
lsst::geom::Extent2D	getPixelSize () const
	Get size of pixel along (mm)
bool	hasCrosstalk () const
	Have we got crosstalk coefficients?
CrosstalkMatrix	getCrosstalk () const
	Get the crosstalk coefficients.
CameraSys	makeCameraSys (CameraSys const &cameraSys) const
	Get a coordinate system from a coordinate system (return input unchanged and untested)
CameraSys	makeCameraSys (CameraSysPrefix const &cameraSysPrefix) const
	Get a coordinate system from a detector system prefix (add detector name)
CameraSys	getNativeCoordSys () const
	The "native" coordinate system of this detector.

Protected Member Functions
	DetectorBase ()=default
	DetectorBase has no state, and is hence default-constructable, copyable, and movable.
	DetectorBase (DetectorBase const &)=default
	DetectorBase (DetectorBase &&)=default
DetectorBase &	operator= (DetectorBase const &)=default
DetectorBase &	operator= (DetectorBase &&)=default
virtual Fields const &	getFields () const =0
	Return a reference to a Fields struct.

Detailed Description

An abstract base class that provides common accessors for Detector and Detector::Builder.

Definition at line 56 of file Detector.h.

Member Typedef Documentation

CrosstalkMatrix

using lsst::afw::cameraGeom::DetectorBase::CrosstalkMatrix = ndarray::Array<float const, 2>

Definition at line 59 of file Detector.h.

Constructor & Destructor Documentation

~DetectorBase()

virtual lsst::afw::cameraGeom::DetectorBase::~DetectorBase ( )

virtualdefaultnoexcept

DetectorBase() [1/3]

lsst::afw::cameraGeom::DetectorBase::DetectorBase ( )

protecteddefault

DetectorBase has no state, and is hence default-constructable, copyable, and movable.

DetectorBase() [2/3]

lsst::afw::cameraGeom::DetectorBase::DetectorBase ( DetectorBase const & )

protecteddefault

DetectorBase() [3/3]

lsst::afw::cameraGeom::DetectorBase::DetectorBase ( DetectorBase && )

protecteddefault

Member Function Documentation

getBBox()

lsst::geom::Box2I lsst::afw::cameraGeom::DetectorBase::getBBox ( ) const

inline

Get the bounding box.

Definition at line 85 of file Detector.h.

{ return getFields().bbox; }

getCrosstalk()

CrosstalkMatrix lsst::afw::cameraGeom::DetectorBase::getCrosstalk ( ) const

inline

Get the crosstalk coefficients.

Definition at line 100 of file Detector.h.

{ return getFields().crosstalk; }

getFields()

virtual Fields const & lsst::afw::cameraGeom::DetectorBase::getFields ( ) const

protectedpure virtual

Return a reference to a Fields struct.

Must be implemented by all subclasses.

Implemented in lsst::afw::cameraGeom::Detector::Builder, and lsst::afw::cameraGeom::Detector.

getId()

int lsst::afw::cameraGeom::DetectorBase::getId ( ) const

inline

Get the detector ID.

Definition at line 67 of file Detector.h.

{ return getFields().id; }

getName()

std::string lsst::afw::cameraGeom::DetectorBase::getName ( ) const

inline

Get the detector name.

Definition at line 64 of file Detector.h.

{ return getFields().name; }

getNativeCoordSys()

CameraSys lsst::afw::cameraGeom::DetectorBase::getNativeCoordSys ( ) const

inline

The "native" coordinate system of this detector.

Definition at line 123 of file Detector.h.

{ return CameraSys(PIXELS, getName()); }

getOrientation()

Orientation lsst::afw::cameraGeom::DetectorBase::getOrientation ( ) const

inline

Get detector's orientation in the focal plane.

Definition at line 88 of file Detector.h.

{ return getFields().orientation; }

getPhysicalType()

std::string lsst::afw::cameraGeom::DetectorBase::getPhysicalType ( ) const

inline

Get the detector's physical type.

This may mean different things for different cameras; possibilities include the manufacturer ("ITL" vs "E2V") or fundamental technology ("CCD" vs "HgCdTe").

Definition at line 82 of file Detector.h.

{ return getFields().physicalType; }

getPixelSize()

lsst::geom::Extent2D lsst::afw::cameraGeom::DetectorBase::getPixelSize ( ) const

inline

Get size of pixel along (mm)

Definition at line 91 of file Detector.h.

{ return getFields().pixelSize; }

getSerial()

std::string lsst::afw::cameraGeom::DetectorBase::getSerial ( ) const

inline

Get the detector serial "number".

Definition at line 73 of file Detector.h.

{ return getFields().serial; }

getType()

DetectorType lsst::afw::cameraGeom::DetectorBase::getType ( ) const

inline

Return the purpose of this detector.

Definition at line 70 of file Detector.h.

{ return getFields().type; }

hasCrosstalk()

bool lsst::afw::cameraGeom::DetectorBase::hasCrosstalk ( ) const

inline

Have we got crosstalk coefficients?

Definition at line 94 of file Detector.h.

                              {
        return !(getFields().crosstalk.isEmpty() ||
                 getFields().crosstalk.getShape() == ndarray::makeVector(0, 0));
    }

makeCameraSys() [1/2]

CameraSys lsst::afw::cameraGeom::DetectorBase::makeCameraSys ( CameraSys const & cameraSys ) const

inline

Get a coordinate system from a coordinate system (return input unchanged and untested)

Parameters

[in]

cameraSys

Camera coordinate system

Returns

cameraSys unchanged

Note

the CameraSysPrefix version needs the detector name, which is why this is not static.

Definition at line 110 of file Detector.h.

{ return cameraSys; }

makeCameraSys() [2/2]

CameraSys lsst::afw::cameraGeom::DetectorBase::makeCameraSys ( CameraSysPrefix const & cameraSysPrefix ) const

inline

Get a coordinate system from a detector system prefix (add detector name)

Parameters

[in]

cameraSysPrefix

Camera coordinate system prefix

Returns

cameraSysPrefix with the detector name added

Definition at line 118 of file Detector.h.

                                                                          {
        return CameraSys(cameraSysPrefix, getFields().name);
    }

operator=() [1/2]

DetectorBase & lsst::afw::cameraGeom::DetectorBase::operator= ( DetectorBase && )

protecteddefault

operator=() [2/2]

DetectorBase & lsst::afw::cameraGeom::DetectorBase::operator= ( DetectorBase const & )

protecteddefault

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gf92a8ffd38+e7bc33f3ea/include/lsst/afw/cameraGeom/Detector.h