ldmx::ElectronicsMap< ElectronicsID, DetID > Class Template Reference

ElectronicsMap. More...

#include <ElectronicsMap.h>

Public Member Functions
	ElectronicsMap (bool want_d2e=false)
void	clear ()
	Remove all entries from the map.
void	addEntry (ElectronicsID eid, DetID did)
	Add an entry to the map.
bool	exists (ElectronicsID eid) const
	Tests if a given electronics id is in the map.
bool	exists (DetID did) const
	Tests if a given detector id is in the map This method is slow O(N) if the map is not configured for detector id to electronics id.
DetID	get (ElectronicsID eid) const
	Get the detector ID for this electronics ID.
ElectronicsID	get (DetID did) const
	Get the electronics ID for this detector ID This method is slow O(N) if the map is not configured for detector id to electronics id.

Private Attributes
std::vector< DetectorID::RawValue >	eid2did_
	Linear-time map for electronics (packed index) to raw detector id.
bool	makeD2E_
	Flag to determine if did2eid should be filled (resource optimization)
std::map< DetectorID::RawValue, ElectronicsID >	did2eid_
	Log(N) map for raw detector id to electronics id.

Detailed Description

template<class ElectronicsID, class DetID>
class ldmx::ElectronicsMap< ElectronicsID, DetID >

ElectronicsMap.

A class for efficient mapping between electronics IDs (using packed index techniques) and detector IDs which are arbitrarily formatted.

Template Parameters

in] ElectronicsID class of electronics ID

Template Parameters

in] DetID class of detector IDs

Definition at line 28 of file ElectronicsMap.h.

Constructor & Destructor Documentation

ElectronicsMap()

template<class ElectronicsID , class DetID >

ldmx::ElectronicsMap< ElectronicsID, DetID >::ElectronicsMap ( bool  want_d2e = false )

inline

Definition at line 30 of file ElectronicsMap.h.

      : eid2did_{ElectronicsID::MAX_INDEX, 0}, makeD2E_(want_d2e) {}

Member Function Documentation

addEntry()

template<class ElectronicsID , class DetID >

void ldmx::ElectronicsMap< ElectronicsID, DetID >::addEntry ( ElectronicsID  eid, DetID  did  )

inline

Add an entry to the map.

Definition at line 44 of file ElectronicsMap.h.

                                              {
    unsigned int index = eid.index();
    if (index >= eid2did_.size()) {
      EXCEPTION_RAISE("ElectronicsMapOverflow",
                      "Attempted to insert electronics with index " +
                          std::to_string(index) +
                          " which is larger than allowed in this map");
    }
    eid2did_[index] = did.raw();
    if (makeD2E_) did2eid_.insert(std::make_pair(did.raw(), eid));
  }

References ldmx::ElectronicsMap< ElectronicsID, DetID >::did2eid_, ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_, and ldmx::ElectronicsMap< ElectronicsID, DetID >::makeD2E_.

clear()

template<class ElectronicsID , class DetID >

void ldmx::ElectronicsMap< ElectronicsID, DetID >::clear ( )

inline

Remove all entries from the map.

Definition at line 36 of file ElectronicsMap.h.

               {
    eid2did_ = std::vector<DetectorID::RawValue>(ElectronicsID::MAX_INDEX, 0);
    did2eid_.clear();
  }

References ldmx::ElectronicsMap< ElectronicsID, DetID >::did2eid_, and ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_.

exists() [1/2]

template<class ElectronicsID , class DetID >

bool ldmx::ElectronicsMap< ElectronicsID, DetID >::exists ( DetID  did ) const

inline

Tests if a given detector id is in the map This method is slow O(N) if the map is not configured for detector id to electronics id.

Definition at line 68 of file ElectronicsMap.h.

                               {
    if (makeD2E_) {
      return did2eid_.find(did.raw()) == did2eid_.end();
    } else {
      for (auto i : eid2did_) {
        if (i == did.raw()) return true;
      }
      return false;
    }
  }

References ldmx::ElectronicsMap< ElectronicsID, DetID >::did2eid_, ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_, and ldmx::ElectronicsMap< ElectronicsID, DetID >::makeD2E_.

exists() [2/2]

template<class ElectronicsID , class DetID >

bool ldmx::ElectronicsMap< ElectronicsID, DetID >::exists ( ElectronicsID  eid ) const

inline

Tests if a given electronics id is in the map.

Definition at line 59 of file ElectronicsMap.h.

                                       {
    return (eid.index() < eid2did_.size() && eid2did_[eid.index()] != 0);
  }

References ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_.

get() [1/2]

template<class ElectronicsID , class DetID >

ElectronicsID ldmx::ElectronicsMap< ElectronicsID, DetID >::get ( DetID  did ) const

inline

Get the electronics ID for this detector ID This method is slow O(N) if the map is not configured for detector id to electronics id.

Throws an exception on failure as there is no globally-defined invalid electronics

Definition at line 95 of file ElectronicsMap.h.

                                     {
    if (makeD2E_) {
      auto itr = did2eid_.find(did.raw());
      if (itr == did2eid_.end()) {
        std::stringstream ss;
        ss << "Unable to find mapping for det id " << did;
        EXCEPTION_RAISE("ElectronicsMapNotFound", ss.str());
      }
      return itr->second;
    } else {
      for (unsigned int i = 0; i < eid2did_.size(); i++) {
        if (eid2did_[i] == did.raw()) return ElectronicsID::idFromIndex(i);
      }
      std::stringstream ss;
      ss << "Unable to find mapping for det id " << did;
      EXCEPTION_RAISE("ElectronicsMapNotFound", ss.str());
    }
  }

References ldmx::ElectronicsMap< ElectronicsID, DetID >::did2eid_, ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_, and ldmx::ElectronicsMap< ElectronicsID, DetID >::makeD2E_.

get() [2/2]

template<class ElectronicsID , class DetID >

DetID ldmx::ElectronicsMap< ElectronicsID, DetID >::get ( ElectronicsID  eid ) const

inline

Get the detector ID for this electronics ID.

Definition at line 82 of file ElectronicsMap.h.

                                     {
    if (eid.index() >= eid2did_.size())
      return DetID();
    else
      return DetID(eid2did_[eid.index()]);
  }

References ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_.

Member Data Documentation

did2eid_

template<class ElectronicsID , class DetID >

std::map<DetectorID::RawValue, ElectronicsID> ldmx::ElectronicsMap< ElectronicsID, DetID >::did2eid_

private

Log(N) map for raw detector id to electronics id.

Definition at line 127 of file ElectronicsMap.h.

Referenced by ldmx::ElectronicsMap< ElectronicsID, DetID >::addEntry(), ldmx::ElectronicsMap< ElectronicsID, DetID >::clear(), ldmx::ElectronicsMap< ElectronicsID, DetID >::exists(), and ldmx::ElectronicsMap< ElectronicsID, DetID >::get().

eid2did_

template<class ElectronicsID , class DetID >

std::vector<DetectorID::RawValue> ldmx::ElectronicsMap< ElectronicsID, DetID >::eid2did_

private

Linear-time map for electronics (packed index) to raw detector id.

Definition at line 118 of file ElectronicsMap.h.

Referenced by ldmx::ElectronicsMap< ElectronicsID, DetID >::addEntry(), ldmx::ElectronicsMap< ElectronicsID, DetID >::clear(), ldmx::ElectronicsMap< ElectronicsID, DetID >::exists(), ldmx::ElectronicsMap< ElectronicsID, DetID >::exists(), ldmx::ElectronicsMap< ElectronicsID, DetID >::get(), and ldmx::ElectronicsMap< ElectronicsID, DetID >::get().

makeD2E_

template<class ElectronicsID , class DetID >

bool ldmx::ElectronicsMap< ElectronicsID, DetID >::makeD2E_

private

Flag to determine if did2eid should be filled (resource optimization)

Definition at line 122 of file ElectronicsMap.h.

Referenced by ldmx::ElectronicsMap< ElectronicsID, DetID >::addEntry(), ldmx::ElectronicsMap< ElectronicsID, DetID >::exists(), and ldmx::ElectronicsMap< ElectronicsID, DetID >::get().

---

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

• Tools/include/Tools/ElectronicsMap.h