lsst::afw::cameraGeom::Detector::InCameraBuilder Class Reference

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

#include <Detector.h>

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

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

Public Member Functions
void	setOrientation (Orientation const &orientation)
	Set the orientation of the detector in the focal plane. More...
void	setPixelSize (lsst::geom::Extent2D const &pixelSize)
	Set the pixel size (in mm). More...
void	setTransformFromPixelsTo (CameraSysPrefix const &toSys, std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const > transform)
	Set the transformation from PIXELS to the given coordinate system. More...
void	setTransformFromPixelsTo (CameraSys const &toSys, std::shared_ptr< afw::geom::TransformPoint2ToPoint2 const > transform)
	Set the transformation from PIXELS to the given coordinate system. More...
bool	discardTransformFromPixelsTo (CameraSysPrefix const &toSys)
	Remove any transformation from PIXELS to the given coordinate system. More...
bool	discardTransformFromPixelsTo (CameraSys const &toSys)
	Remove any transformation from PIXELS to the given coordinate system. More...
void	clearTransforms ()
	Remove all coordinate transforms. More...
void	setBBox (lsst::geom::Box2I const &bbox)
	Set the bounding box. More...
void	setType (DetectorType type)
	Set the purpose of this detector. More...
void	setSerial (std::string const &serial)
	Set the detector serial "number". More...
void	setPhysicalType (std::string const &physicalType)
	Set the detector's physical type. More...
void	setCrosstalk (CrosstalkMatrix const &crosstalk)
	Set the crosstalk coefficients. More...
void	unsetCrosstalk ()
	Remove the crosstalk coefficient matrix. More...
std::vector< std::shared_ptr< Amplifier::Builder > > const &	getAmplifiers () const
	Return the sequence of Amplifier::Builders directly. More...
auto	begin ()
	An iterator range over amplifers. More...
auto	end ()
std::shared_ptr< Amplifier::Builder >	operator[] (size_t i) const
	Get the amplifier builder specified by index. More...
std::shared_ptr< Amplifier::Builder >	operator[] (std::string const &name) const
	Get a builder for the amplifier specified by name. More...
void	append (std::shared_ptr< Amplifier::Builder > builder)
	Append a new amplifier. More...
void	clear ()
	Remove all amplifiers. More...
std::size_t	size () const
	Return the number of amplifiers (renamed to len in Python). More...
std::string	getName () const
	Get the detector name. More...
int	getId () const
	Get the detector ID. More...
DetectorType	getType () const
	Return the purpose of this detector. More...
std::string	getSerial () const
	Get the detector serial "number". More...
std::string	getPhysicalType () const
	Get the detector's physical type. More...
lsst::geom::Box2I	getBBox () const
	Get the bounding box. More...
Orientation	getOrientation () const
	Get detector's orientation in the focal plane. More...
lsst::geom::Extent2D	getPixelSize () const
	Get size of pixel along (mm) More...
bool	hasCrosstalk () const
	Have we got crosstalk coefficients? More...
CrosstalkMatrix	getCrosstalk () const
	Get the crosstalk coefficients. More...
CameraSys	makeCameraSys (CameraSys const &cameraSys) const
	Get a coordinate system from a coordinate system (return input unchanged and untested) More...
CameraSys	makeCameraSys (CameraSysPrefix const &cameraSysPrefix) const
	Get a coordinate system from a detector system prefix (add detector name) More...
CameraSys	getNativeCoordSys () const
	The "native" coordinate system of this detector. More...

Protected Member Functions
Fields const &	getFields () const override
	Return a reference to a Fields struct. More...
std::vector< std::shared_ptr< Amplifier const > >	finishAmplifiers () const
	Create a vector of Amplifiers from the Amplifier::Builder sequence. More...

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. More...

Friends
class	Camera

Detailed Description

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.

Definition at line 555 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.

Member Function Documentation

append()

void lsst::afw::cameraGeom::Detector::Builder::append ( std::shared_ptr< Amplifier::Builder >  builder )

inherited

Append a new amplifier.

Definition at line 351 of file Detector.cc.

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

begin()

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

inlineinherited

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 ( )

inlineinherited

Remove all amplifiers.

Definition at line 448 of file Detector.h.

{ _amplifiers.clear(); }

clearTransforms()

void lsst::afw::cameraGeom::Detector::InCameraBuilder::clearTransforms ( )

inline

Remove all coordinate transforms.

Definition at line 623 of file Detector.h.

{ _connections.clear(); }

discardTransformFromPixelsTo() [1/2]

bool lsst::afw::cameraGeom::Detector::InCameraBuilder::discardTransformFromPixelsTo

(

CameraSys const &

toSys

)

Remove any transformation from PIXELS to the given coordinate system.

Parameters

toSys

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

Returns

true if a transform was removed; false otherwise.

Exceptions

pex::exceptions::InvalidParameterError

if toSys.getDetectorName() != this->getName().

Definition at line 445 of file Detector.cc.

                                                                                  {
    if (toSys.getDetectorName() != getName()) {
        throw LSST_EXCEPT(
            pex::exceptions::InvalidParameterError,
            (boost::format("Cannot add coordinate system for detector '%s' to detector '%s'.") %
             toSys.getDetectorName() % getName()).str()
        );
    }
    auto iter = findConnection(_connections.begin(), _connections.end(), toSys);
    if (iter != _connections.end()) {
        _connections.erase(iter);
        return true;
    }
    return false;
}

discardTransformFromPixelsTo() [2/2]

bool lsst::afw::cameraGeom::Detector::InCameraBuilder::discardTransformFromPixelsTo

(

CameraSysPrefix const &

toSys

)

Remove any transformation from PIXELS to the given coordinate system.

Parameters

toSys

Coordinate system prefix this transform returns points in.

Returns

true if a transform was removed; false otherwise.

Definition at line 441 of file Detector.cc.

                                                                                        {
    return discardTransformFromPixelsTo(makeCameraSys(toSys));
}

end()

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

inlineinherited

Definition at line 427 of file Detector.h.

{ return _amplifiers.end(); }

finishAmplifiers()

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

protectedinherited

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

Definition at line 373 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

inlineinherited

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

inlineoverrideprotectedvirtualinherited

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]

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

inlineinherited

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

inherited

Get a builder for the amplifier specified by name.

Exceptions

lsst::pex::exceptions::InvalidParameterError

if no such amplifier.

Definition at line 347 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 )

staticprotectedinherited

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

Definition at line 355 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 )

inlineinherited

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 )

inlineinherited

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::InCameraBuilder::setOrientation ( Orientation const &  orientation )

inline

Set the orientation of the detector in the focal plane.

Definition at line 561 of file Detector.h.

{ Detector::Builder::setOrientation(orientation); }

setPhysicalType()

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

inlineinherited

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::InCameraBuilder::setPixelSize ( lsst::geom::Extent2D const &  pixelSize )

inline

Set the pixel size (in mm).

Definition at line 566 of file Detector.h.

{ Detector::Builder::setPixelSize(pixelSize); }

setSerial()

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

inlineinherited

Set the detector serial "number".

Definition at line 381 of file Detector.h.

{ _fields.serial = serial; }

setTransformFromPixelsTo() [1/2]

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

Set the transformation from PIXELS to the given coordinate system.

Parameters

toSys	Coordinate system prefix this transform returns points in. Must be associated with this detector.
transform	Transform from PIXELS to toSys.

If a transform already exists from PIXELS to toSys, it is overwritten.

Exceptions

pex::exceptions::InvalidParameterError

if toSys.getDetectorName() != this->getName().

Definition at line 420 of file Detector.cc.

  {
    if (toSys.getDetectorName() != getName()) {
        throw LSST_EXCEPT(
            pex::exceptions::InvalidParameterError,
            (boost::format("Cannot add coordinate system for detector '%s' to detector '%s'.") %
             toSys.getDetectorName() % getName()).str()
        );
    }
    auto iter = findConnection(_connections.begin(), _connections.end(), toSys);
    if (iter == _connections.end()) {
        _connections.push_back(
            TransformMap::Connection{transform, getNativeCoordSys(), toSys}
        );
    } else {
        iter->transform = transform;
    }
}

setTransformFromPixelsTo() [2/2]

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

Set the transformation from PIXELS to the given coordinate system.

Parameters

toSys	Coordinate system prefix this transform returns points in.
transform	Transform from PIXELS to toSys.

If a transform already exists from PIXELS to toSys, it is overwritten.

Definition at line 413 of file Detector.cc.

  {
    return setTransformFromPixelsTo(makeCameraSys(toSys), std::move(transform));
}

setType()

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

inlineinherited

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

inlineinherited

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 ( )

inlineinherited

Remove the crosstalk coefficient matrix.

Definition at line 403 of file Detector.h.

{ _fields.crosstalk = CrosstalkMatrix(); }

Friends And Related Function Documentation

Camera

friend class Camera

friend

Definition at line 630 of file Detector.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/cameraGeom/Detector.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/cameraGeom/Detector.cc