LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
Public Types | Public Member Functions | Protected Member Functions | List of all members
lsst::afw::cameraGeom::DetectorCollectionBase< T > Class Template Referenceabstract

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

#include <DetectorCollection.h>

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. More...
 
IdMap const & getIdMap () const noexcept
 Get a map keyed and ordered by ID. More...
 
std::size_t size () const noexcept
 Get the number of detectors. More...
 
bool empty () const noexcept
 Determine if the collection contains any detectors. More...
 
std::shared_ptr< T > operator[] (std::string const &name) const
 Implement the [name] operator. More...
 
std::shared_ptr< T > operator[] (int id) const
 Implement the [id] operator. More...
 
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. More...
 
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. More...
 

Protected Member Functions

 DetectorCollectionBase (List const &detectorList)
 
 DetectorCollectionBase () noexcept=default
 
 DetectorCollectionBase (DetectorCollectionBase const &)=default
 
 DetectorCollectionBase (DetectorCollectionBase &&)=default
 
DetectorCollectionBaseoperator= (DetectorCollectionBase const &)=default
 
DetectorCollectionBaseoperator= (DetectorCollectionBase &&)=default
 
void add (std::shared_ptr< T > detector)
 Add a detector to the collection. More...
 
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
TElement 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

Definition at line 54 of file DetectorCollection.h.

◆ NameMap

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.

74  {
75  for (auto const & detector : detectorList) {
76  _nameDict[detector->getName()] = detector;
77  _idDict[detector->getId()] = detector;
78  }
79 
80  if (_idDict.size() < detectorList.size()) {
81  throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Detector IDs are not unique");
82  }
83  if (_nameDict.size() < detectorList.size()) {
84  throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Detector names are not unique");
85  }
86 }
table::Key< int > detector
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
T size(T... args)

◆ 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]detectorNew detector to add to the collection.
Exceptions
pex::exceptions::RuntimeErrorThrown 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.

89  {
90  auto idIter = _idDict.find(detector->getId());
91  auto nameIter = _nameDict.find(detector->getName());
92  if (idIter == _idDict.end()) {
93  if (nameIter == _nameDict.end()) {
94  try {
95  _idDict.emplace(detector->getId(), detector);
96  _nameDict.emplace(detector->getName(), detector);
97  } catch (...) {
98  _idDict.clear();
99  _nameDict.clear();
100  throw;
101  }
102  } else {
103  throw LSST_EXCEPT(
104  pex::exceptions::RuntimeError,
105  (boost::format("Detector name %s is not unique.") % detector->getName()).str()
106  );
107  }
108  } else {
109  if (nameIter == _nameDict.end()) {
110  throw LSST_EXCEPT(
111  pex::exceptions::RuntimeError,
112  (boost::format("Detector ID %s is not unique.") % detector->getId()).str()
113  );
114  } else {
115  if (nameIter->second != detector) {
116  assert(idIter->second != detector);
117  throw LSST_EXCEPT(
118  pex::exceptions::RuntimeError,
119  (boost::format("Detector name %s and ID %s are not unique.") % detector->getName()
120  % detector->getId()).str()
121  );
122  }
123  // detector is already present; do nothing
124  }
125  }
126 }
T clear(T... args)
T emplace(T... args)
T end(T... args)
T find(T... args)
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

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

72 { return _idDict.empty(); }
T empty(T... args)

◆ 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]iddetector id
[in]defdefault 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.

65  {
66  auto i = _idDict.find(id);
67  if (i == _idDict.end()) {
68  return def;
69  }
70  return i->second;
71 }

◆ 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]namedetector name
[in]defdefault 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.

56  {
57  auto i = _nameDict.find(name);
58  if (i == _nameDict.end()) {
59  return def;
60  }
61  return i->second;
62 }
table::Key< std::string > name
Definition: Amplifier.cc:116

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

62 { 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.

59 { 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]iddetector name
Returns
pointer to detector entry

Definition at line 46 of file DetectorCollection.cc.

46  {
47  auto det = get(id);
48  if (det == nullptr) {
49  throw LSST_EXCEPT(pex::exceptions::NotFoundError,
50  (boost::format("Detector with ID %s not found") % id).str());
51  }
52  return det;
53 }
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.

◆ 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]namedetector name
Returns
pointer to detector entry

Definition at line 36 of file DetectorCollection.cc.

36  {
37  auto det = get(name);
38  if (det == nullptr) {
39  throw LSST_EXCEPT(pex::exceptions::NotFoundError,
40  (boost::format("Detector with name %s not found") % name).str());
41  }
42  return det;
43 }

◆ remove() [1/2]

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

Definition at line 144 of file DetectorCollection.cc.

144  {
145  auto idIter = _idDict.find(id);
146  if (idIter == _idDict.end()) {
147  throw LSST_EXCEPT(
148  pex::exceptions::NotFoundError,
149  (boost::format("Detector with ID %s not found.") % id).str()
150  );
151  }
152  auto nameIter = _nameDict.find(idIter->second->getName());
153  assert(nameIter != _nameDict.end());
154  _nameDict.erase(nameIter);
155  _idDict.erase(idIter);
156 }
T erase(T... args)

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

129  {
130  auto nameIter = _nameDict.find(name);
131  if (nameIter == _nameDict.end()) {
132  throw LSST_EXCEPT(
133  pex::exceptions::NotFoundError,
134  (boost::format("Detector with name %s not found.") % name).str()
135  );
136  }
137  auto idIter = _idDict.find(nameIter->second->getId());
138  assert(idIter != _idDict.end());
139  _nameDict.erase(nameIter);
140  _idDict.erase(idIter);
141 }

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

67 { return _idDict.size(); }

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