lsst::afw::cameraGeom::Detector::Builder Class Reference

A helper class for Detector that allows amplifiers and most fields to be modified. More...

#include <Detector.h>

Inheritance diagram for lsst::afw::cameraGeom::Detector::Builder:

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

Public Member Functions
	Builder (Builder const &)=delete
	Builder (Builder &&)=delete
Builder &	operator= (Builder const &)=delete
Builder &	operator= (Builder &&)=delete
	~Builder () noexcept override=0
void	setBBox (lsst::geom::Box2I const &bbox)
	Set the bounding box.
void	setType (DetectorType type)
	Set the purpose of this detector.
void	setSerial (std::string const &serial)
	Set the detector serial "number".
void	setPhysicalType (std::string const &physicalType)
	Set the detector's physical type.
void	setCrosstalk (CrosstalkMatrix const &crosstalk)
	Set the crosstalk coefficients.
void	unsetCrosstalk ()
	Remove the crosstalk coefficient matrix.
std::vector< std::shared_ptr< Amplifier::Builder > > const &	getAmplifiers () const
	Return the sequence of Amplifier::Builders directly.
auto	begin ()
	An iterator range over amplifers.
auto	end ()
std::shared_ptr< Amplifier::Builder >	operator[] (size_t i) const
	Get the amplifier builder specified by index.
std::shared_ptr< Amplifier::Builder >	operator[] (std::string const &name) const
	Get a builder for the amplifier specified by name.
void	append (std::shared_ptr< Amplifier::Builder > builder)
	Append a new amplifier.
void	clear ()
	Remove all amplifiers.
std::size_t	size () const
	Return the number of amplifiers (renamed to len in Python).
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
	Builder (std::string const &name, int id)
	Construct a Detector::Builder with no amplifiers and the given name and ID.
	Builder (Fields fields, std::vector< std::shared_ptr< Amplifier::Builder > > &&amplifiers)
	Construct a Detector::Builder with the given field values and amplifiers.
Fields const &	getFields () const override
	Return a reference to a Fields struct.
std::vector< std::shared_ptr< Amplifier const > >	finishAmplifiers () const
	Create a vector of Amplifiers from the Amplifier::Builder sequence.
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).

Static Protected Member Functions
static std::vector< std::shared_ptr< Amplifier::Builder > >	rebuildAmplifiers (Detector const &detector)
	Create a vector of Amplifier::Builders from the Amplifiers in a Detector.

Detailed Description

A helper class for Detector that allows amplifiers and most fields to be modified.

Because Detector is immutable, creation and modification always go through Builder, or more precisely, one of its two subclasses:

• InCameraBuilder (obtained from Camera::Builder) is used to construct new detectors or modify them as part of Camera.
• PartialRebuilder (obtained from Detector::rebuild) is used to modify an existing detector without changing its relationship to its camera.

Detector::Builder itself provides functionality common to these:

• setters for the simple data fields of Detector;
• a container of Amplifier::Builders. It is not intended define an interface independent of its subclasses.

The name and ID of a detector (but not its "serial" string) are set at initial construction and are an integral part of the relationship between it and its Camera, and can never be changed, even by Builders.

The fact that Amplifier::Builder inherits from Amplifier does not mean that a container of Amplifier::Builder can inherit from a container of Amplifier, and hence Detector::Builder (which has a container of Amplifer::Builder) cannot inherit directly from Detector (which has a container of Amplifier). But in both Python and templated C++ code, the container interfaces of Detector and Detector::Builder are identical (i.e. they're "duck type" equivalent), aside from the fact that Detector::Builder also permits addition and removal of amplifiers.

Definition at line 362 of file Detector.h.

Member Typedef Documentation

CrosstalkMatrix

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

inherited

Definition at line 59 of file Detector.h.

Constructor & Destructor Documentation

Builder() [1/4]

lsst::afw::cameraGeom::Detector::Builder::Builder ( Builder const & )

delete

Builder() [2/4]

lsst::afw::cameraGeom::Detector::Builder::Builder ( Builder && )

delete

~Builder()

lsst::afw::cameraGeom::Detector::Builder::~Builder ( )

overridepure virtualdefaultnoexcept

Builder() [3/4]

lsst::afw::cameraGeom::Detector::Builder::Builder ( std::string const & name, int id )

protected

Construct a Detector::Builder with no amplifiers and the given name and ID.

Definition at line 391 of file Detector.cc.

                                                       {
    _fields.name = name;
    _fields.id = id;
}

Builder() [4/4]

lsst::afw::cameraGeom::Detector::Builder::Builder ( Fields fields, std::vector< std::shared_ptr< Amplifier::Builder > > && amplifiers )

inlineprotected

Construct a Detector::Builder with the given field values and amplifiers.

Definition at line 471 of file Detector.h.

                                                                                     :
        _fields(std::move(fields)),
        _amplifiers(std::move(amplifiers))
    {}

Member Function Documentation

append()

void lsst::afw::cameraGeom::Detector::Builder::append

(

std::shared_ptr< Amplifier::Builder >

builder

)

Append a new amplifier.

Definition at line 376 of file Detector.cc.

                                                                    {
    _amplifiers.push_back(std::move(builder));
}

begin()

auto lsst::afw::cameraGeom::Detector::Builder::begin ( )

inline

An iterator range over amplifers.

Iterators dereference to shared_ptr<Amplifier::Builder>.

Definition at line 426 of file Detector.h.

{ return _amplifiers.begin(); }

clear()

void lsst::afw::cameraGeom::Detector::Builder::clear ( )

inline

Remove all amplifiers.

Definition at line 448 of file Detector.h.

{ _amplifiers.clear(); }

end()

auto lsst::afw::cameraGeom::Detector::Builder::end ( )

inline

Definition at line 427 of file Detector.h.

{ return _amplifiers.end(); }

finishAmplifiers()

AmpVector lsst::afw::cameraGeom::Detector::Builder::finishAmplifiers ( ) const

protected

Create a vector of Amplifiers from the Amplifier::Builder sequence.

Definition at line 398 of file Detector.cc.

                                                  {
    AmpVector result;
    result.reserve(_amplifiers.size());
    for (auto const & ampBuilderPtr : _amplifiers) {
        result.push_back(ampBuilderPtr->finish());
    }
    return result;
}

getAmplifiers()

std::vector< std::shared_ptr< Amplifier::Builder > > const & lsst::afw::cameraGeom::Detector::Builder::getAmplifiers ( ) const

inline

Return the sequence of Amplifier::Builders directly.

Definition at line 418 of file Detector.h.

{ return _amplifiers; }

getBBox()

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

inlineinherited

Get the bounding box.

Definition at line 85 of file Detector.h.

{ return getFields().bbox; }

getCrosstalk()

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

inlineinherited

Get the crosstalk coefficients.

Definition at line 100 of file Detector.h.

{ return getFields().crosstalk; }

getFields()

Fields const & lsst::afw::cameraGeom::Detector::Builder::getFields ( ) const

inlineoverrideprotectedvirtual

Return a reference to a Fields struct.

Must be implemented by all subclasses.

Implements lsst::afw::cameraGeom::DetectorBase.

Definition at line 476 of file Detector.h.

{ return _fields; }

getId()

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

inlineinherited

Get the detector ID.

Definition at line 67 of file Detector.h.

{ return getFields().id; }

getName()

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

inlineinherited

Get the detector name.

Definition at line 64 of file Detector.h.

{ return getFields().name; }

getNativeCoordSys()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

Get the detector serial "number".

Definition at line 73 of file Detector.h.

{ return getFields().serial; }

getType()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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]

Builder & lsst::afw::cameraGeom::Detector::Builder::operator= ( Builder && )

delete

operator=() [2/2]

Builder & lsst::afw::cameraGeom::Detector::Builder::operator= ( Builder const & )

delete

operator[]() [1/2]

std::shared_ptr< Amplifier::Builder > lsst::afw::cameraGeom::Detector::Builder::operator[] ( size_t i ) const

inline

Get the amplifier builder specified by index.

Exceptions

std::out_of_range

if index is out of range.

Definition at line 435 of file Detector.h.

{ return _amplifiers.at(i); }

operator[]() [2/2]

std::shared_ptr< Amplifier::Builder > lsst::afw::cameraGeom::Detector::Builder::operator[]

(

std::string const &

name

)

const

Get a builder for the amplifier specified by name.

Exceptions

lsst::pex::exceptions::InvalidParameterError

if no such amplifier.

Definition at line 372 of file Detector.cc.

                                                                                       {
    return *findAmpIterByName(_amplifiers.begin(), _amplifiers.end(), name);
}

rebuildAmplifiers()

std::vector< std::shared_ptr< Amplifier::Builder > > lsst::afw::cameraGeom::Detector::Builder::rebuildAmplifiers ( Detector const & detector )

staticprotected

Create a vector of Amplifier::Builders from the Amplifiers in a Detector.

Definition at line 380 of file Detector.cc.

  {
    std::vector<std::shared_ptr<Amplifier::Builder>> result;
    result.reserve(detector.size());
    for (auto const & ampPtr : detector) {
        result.push_back(std::make_shared<Amplifier::Builder>(*ampPtr));
    }
    return result;
}

setBBox()

void lsst::afw::cameraGeom::Detector::Builder::setBBox ( lsst::geom::Box2I const & bbox )

inline

Set the bounding box.

Definition at line 375 of file Detector.h.

{ _fields.bbox = bbox; }

setCrosstalk()

void lsst::afw::cameraGeom::Detector::Builder::setCrosstalk ( CrosstalkMatrix const & crosstalk )

inline

Set the crosstalk coefficients.

The shape of the crosstalk matrix must be consistent with the set of amplifiers, but is not checked until a Detector instance is actually constructed.

Setting with a zero-size matrix is equivalent to calling unsetCrosstalk().

Definition at line 400 of file Detector.h.

{ _fields.crosstalk = crosstalk; }

setOrientation()

void lsst::afw::cameraGeom::Detector::Builder::setOrientation ( Orientation const & orientation )

inlineprotected

Set the orientation of the detector in the focal plane.

This is intended for use by InCameraBuilder only; the orientation is used to set the coordinate transform from FOCAL_PLANE to PIXELS, and hence cannot be modified unless the full Camera is being modified.

Definition at line 490 of file Detector.h.

{ _fields.orientation = orientation; }

setPhysicalType()

void lsst::afw::cameraGeom::Detector::Builder::setPhysicalType ( std::string const & physicalType )

inline

Set 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 388 of file Detector.h.

{ _fields.physicalType = physicalType; }

setPixelSize()

void lsst::afw::cameraGeom::Detector::Builder::setPixelSize ( lsst::geom::Extent2D const & pixelSize )

inlineprotected

Set the pixel size (in mm).

This is intended for use by InCameraBuilder only; the pixel size is used to set the coordinate transform from FOCAL_PLANE to PIXELS, and hence cannot be modified unless the full Camera is being modified.

Definition at line 499 of file Detector.h.

{ _fields.pixelSize = pixelSize; }

setSerial()

void lsst::afw::cameraGeom::Detector::Builder::setSerial ( std::string const & serial )

inline

Set the detector serial "number".

Definition at line 381 of file Detector.h.

{ _fields.serial = serial; }

setType()

void lsst::afw::cameraGeom::Detector::Builder::setType ( DetectorType type )

inline

Set the purpose of this detector.

Definition at line 378 of file Detector.h.

{ _fields.type = type; }

size()

std::size_t lsst::afw::cameraGeom::Detector::Builder::size ( ) const

inline

Return the number of amplifiers (renamed to len in Python).

Definition at line 451 of file Detector.h.

{ return _amplifiers.size(); }

unsetCrosstalk()

void lsst::afw::cameraGeom::Detector::Builder::unsetCrosstalk ( )

inline

Remove the crosstalk coefficient matrix.

Definition at line 403 of file Detector.h.

{ _fields.crosstalk = CrosstalkMatrix(); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/cameraGeom/Detector.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/cameraGeom/Detector.cc