lsst::afw::cameraGeom::DetectorCollectionBase< T > Class Template Reference

An abstract base class for collections of Detectors and specific subclasses thereof. More...

#include <DetectorCollection.h>

Inheritance diagram for lsst::afw::cameraGeom::DetectorCollectionBase< T >:

Public Types
using	NameMap = std::unordered_map<std::string, std::shared_ptr<T>>
using	IdMap = std::map<int, std::shared_ptr<T>>
using	List = std::vector<std::shared_ptr<T>>

Public Member Functions
virtual	~DetectorCollectionBase () noexcept=0
NameMap const &	getNameMap () const noexcept
	Get a map keyed and ordered by name.
IdMap const &	getIdMap () const noexcept
	Get a map keyed and ordered by ID.
std::size_t	size () const noexcept
	Get the number of detectors.
bool	empty () const noexcept
	Determine if the collection contains any detectors.
std::shared_ptr< T >	operator[] (std::string const &name) const
	Implement the [name] operator.
std::shared_ptr< T >	operator[] (int id) const
	Implement the [id] operator.
std::shared_ptr< T >	get (std::string const &name, std::shared_ptr< T > def=nullptr) const
	Retrieve a detector by name, or fall back to a default.
std::shared_ptr< T >	get (int id, std::shared_ptr< T > def=nullptr) const
	Retrieve a detector by ID, or fall back to a default.

Protected Member Functions
	DetectorCollectionBase (List const &detectorList)
	DetectorCollectionBase () noexcept=default
	DetectorCollectionBase (DetectorCollectionBase const &)=default
	DetectorCollectionBase (DetectorCollectionBase &&)=default
DetectorCollectionBase &	operator= (DetectorCollectionBase const &)=default
DetectorCollectionBase &	operator= (DetectorCollectionBase &&)=default
void	add (std::shared_ptr< T > detector)
	Add a detector to the collection.
void	remove (std::string const &name)
void	remove (int id)

Detailed Description

template<typename T>
class lsst::afw::cameraGeom::DetectorCollectionBase< T >

An abstract base class for collections of Detectors and specific subclasses thereof.

Template Parameters

T	Element type; either Detector or a subclass thereof.

This class provides the common interface and implementation for DetectorCollection (which holds true Detector instances) and Camera::Builder (which holds Detector::InCameraBuilder instances). It is not intended to define an interface independent of those classes.

Definition at line 49 of file DetectorCollection.h.

Member Typedef Documentation

IdMap

template<typename T>

using lsst::afw::cameraGeom::DetectorCollectionBase< T >::IdMap = std::map<int, std::shared_ptr<T>>

Definition at line 53 of file DetectorCollection.h.

List

template<typename T>

using lsst::afw::cameraGeom::DetectorCollectionBase< T >::List = std::vector<std::shared_ptr<T>>

Definition at line 54 of file DetectorCollection.h.

NameMap

template<typename T>

using lsst::afw::cameraGeom::DetectorCollectionBase< T >::NameMap = std::unordered_map<std::string, std::shared_ptr<T>>

Definition at line 52 of file DetectorCollection.h.

Constructor & Destructor Documentation

~DetectorCollectionBase()

template<typename T>

lsst::afw::cameraGeom::DetectorCollectionBase< T >::~DetectorCollectionBase ( )

pure virtualdefaultnoexcept

DetectorCollectionBase() [1/4]

template<typename T>

lsst::afw::cameraGeom::DetectorCollectionBase< T >::DetectorCollectionBase ( List const & detectorList )

explicitprotected

Definition at line 74 of file DetectorCollection.cc.

                                                                           {
    for (auto const & detector : detectorList) {
        _nameDict[detector->getName()] = detector;
        _idDict[detector->getId()] = detector;
    }
 
    if (_idDict.size() < detectorList.size()) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Detector IDs are not unique");
    }
    if (_nameDict.size() < detectorList.size()) {
        throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Detector names are not unique");
    }
}

DetectorCollectionBase() [2/4]

template<typename T>

lsst::afw::cameraGeom::DetectorCollectionBase< T >::DetectorCollectionBase ( )

protecteddefaultnoexcept

DetectorCollectionBase() [3/4]

template<typename T>

lsst::afw::cameraGeom::DetectorCollectionBase< T >::DetectorCollectionBase ( DetectorCollectionBase< T > const & )

protecteddefault

DetectorCollectionBase() [4/4]

template<typename T>

lsst::afw::cameraGeom::DetectorCollectionBase< T >::DetectorCollectionBase ( DetectorCollectionBase< T > && )

protecteddefault

Member Function Documentation

add()

template<typename T>

void lsst::afw::cameraGeom::DetectorCollectionBase< T >::add ( std::shared_ptr< T > detector )

protected

Add a detector to the collection.

Parameters

[in]

detector

New detector to add to the collection.

Exceptions

pex::exceptions::RuntimeError

Thrown if the ID and/or name conflict with those of detectors already in the collection.

Exception Safety

Strong for pex::exceptions::RuntimeError, weak (collection is made empty) otherwise.

Definition at line 89 of file DetectorCollection.cc.

                                                             {
    auto idIter = _idDict.find(detector->getId());
    auto nameIter = _nameDict.find(detector->getName());
    if (idIter == _idDict.end()) {
        if (nameIter == _nameDict.end()) {
            try {
                _idDict.emplace(detector->getId(), detector);
                _nameDict.emplace(detector->getName(), detector);
            } catch (...) {
                _idDict.clear();
                _nameDict.clear();
                throw;
            }
        } else {
            throw LSST_EXCEPT(
                pex::exceptions::RuntimeError,
                (boost::format("Detector name %s is not unique.") % detector->getName()).str()
            );
        }
    } else {
        if (nameIter == _nameDict.end()) {
            throw LSST_EXCEPT(
                pex::exceptions::RuntimeError,
                (boost::format("Detector ID %s is not unique.") % detector->getId()).str()
            );
        } else {
            if (nameIter->second != detector) {
                assert(idIter->second != detector);
                throw LSST_EXCEPT(
                    pex::exceptions::RuntimeError,
                    (boost::format("Detector name %s and ID %s are not unique.") % detector->getName()
                     % detector->getId()).str()
                );
            }
            // detector is already present; do nothing
        }
    }
}

empty()

template<typename T>

bool lsst::afw::cameraGeom::DetectorCollectionBase< T >::empty ( ) const

inlinenoexcept

Determine if the collection contains any detectors.

Definition at line 72 of file DetectorCollection.h.

{ return _idDict.empty(); }

get() [1/2]

template<typename T>

std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::get	(	int	id,
		std::shared_ptr< T >	def = nullptr ) const

Retrieve a detector by ID, or fall back to a default.

Parameters

[in]	id	detector id
[in]	def	default detector to return. This defaults to nullptr.

Returns

pointer to detector entry if the entry exists, else return the default value

Definition at line 65 of file DetectorCollection.cc.

                                                                                  {
    auto i = _idDict.find(id);
    if (i == _idDict.end()) {
        return def;
    }
    return i->second;
}

get() [2/2]

template<typename T>

std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::get	(	std::string const &	name,
		std::shared_ptr< T >	def = nullptr ) const

Retrieve a detector by name, or fall back to a default.

Parameters

[in]	name	detector name
[in]	def	default detector to return. This defaults to nullptr.

Returns

pointer to detector entry if the entry exists, else return the default value

Definition at line 56 of file DetectorCollection.cc.

                                                                                                  {
    auto i = _nameDict.find(name);
    if (i == _nameDict.end()) {
        return def;
    }
    return i->second;
}

getIdMap()

template<typename T>

IdMap const & lsst::afw::cameraGeom::DetectorCollectionBase< T >::getIdMap ( ) const

inlinenoexcept

Get a map keyed and ordered by ID.

Definition at line 62 of file DetectorCollection.h.

{ return _idDict; }

getNameMap()

template<typename T>

NameMap const & lsst::afw::cameraGeom::DetectorCollectionBase< T >::getNameMap ( ) const

inlinenoexcept

Get a map keyed and ordered by name.

Definition at line 59 of file DetectorCollection.h.

{ return _nameDict; }

operator=() [1/2]

template<typename T>

DetectorCollectionBase & lsst::afw::cameraGeom::DetectorCollectionBase< T >::operator= ( DetectorCollectionBase< T > && )

protecteddefault

operator=() [2/2]

template<typename T>

DetectorCollectionBase & lsst::afw::cameraGeom::DetectorCollectionBase< T >::operator= ( DetectorCollectionBase< T > const & )

protecteddefault

operator[]() [1/2]

template<typename T>

std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::operator[]

(

int

id

)

const

Implement the [id] operator.

Parameters

[in]

id

detector name

Returns

pointer to detector entry

Definition at line 46 of file DetectorCollection.cc.

                                                                   {
    auto det = get(id);
    if (det == nullptr) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("Detector with ID %s not found") % id).str());
    }
    return det;
}

operator[]() [2/2]

template<typename T>

std::shared_ptr< T > lsst::afw::cameraGeom::DetectorCollectionBase< T >::operator[]

(

std::string const &

name

)

const

Implement the [name] operator.

Parameters

[in]

name

detector name

Returns

pointer to detector entry

Definition at line 36 of file DetectorCollection.cc.

                                                                                   {
    auto det = get(name);
    if (det == nullptr) {
        throw LSST_EXCEPT(pex::exceptions::NotFoundError,
                          (boost::format("Detector with name %s not found") % name).str());
    }
    return det;
}

remove() [1/2]

template<typename T>

void lsst::afw::cameraGeom::DetectorCollectionBase< T >::remove ( int id )

protected

Definition at line 144 of file DetectorCollection.cc.

                                             {
    auto idIter = _idDict.find(id);
    if (idIter == _idDict.end()) {
        throw LSST_EXCEPT(
            pex::exceptions::NotFoundError,
            (boost::format("Detector with ID %s not found.") % id).str()
        );
    }
    auto nameIter = _nameDict.find(idIter->second->getName());
    assert(nameIter != _nameDict.end());
    _nameDict.erase(nameIter);
    _idDict.erase(idIter);
}

remove() [2/2]

template<typename T>

void lsst::afw::cameraGeom::DetectorCollectionBase< T >::remove ( std::string const & name )

protected

Definition at line 129 of file DetectorCollection.cc.

                                                             {
    auto nameIter = _nameDict.find(name);
    if (nameIter == _nameDict.end()) {
        throw LSST_EXCEPT(
            pex::exceptions::NotFoundError,
            (boost::format("Detector with name %s not found.") % name).str()
        );
    }
    auto idIter = _idDict.find(nameIter->second->getId());
    assert(idIter != _idDict.end());
    _nameDict.erase(nameIter);
    _idDict.erase(idIter);
}

size()

template<typename T>

std::size_t lsst::afw::cameraGeom::DetectorCollectionBase< T >::size ( ) const

inlinenoexcept

Get the number of detectors.

Renamed to __len__ in Python.

Definition at line 67 of file DetectorCollection.h.

{ return _idDict.size(); }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/cameraGeom/DetectorCollection.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/cameraGeom/DetectorCollection.cc