Tracker DAQ map: the correspondence between an electronics sensor address (feb, hybrid) and the detector layer it reads, plus the strip transform that turns a physical channel (pchannel) into a sensor strip index. More...

#include <TrackerDaqMap.h>

Classes
struct	SensorInfo
	Everything the mapper needs to know about one physical sensor. More...

Public Member Functions
bool	has (uint8_t feb, uint8_t hybrid) const
	True if the map has an entry for this electronics sensor.

const SensorInfo &	at (uint8_t feb, uint8_t hybrid) const
	Look up the sensor read by (feb, hybrid).

std::size_t	size () const
	Number of sensors in the map.

const std::map< uint16_t, SensorInfo > &	sensors () const
	All sensors, keyed by (feb << 8) \| hybrid.

Static Public Member Functions
static TrackerDaqMap	fromJsonFile (const std::string &path)
	Load a DAQ map from a JSON file.

Static Private Member Functions
static uint16_t	key (uint8_t feb, uint8_t hybrid)

Private Attributes
std::map< uint16_t, SensorInfo >	sensors_
	key = (feb << 8) \| hybrid

Detailed Description

Tracker DAQ map: the correspondence between an electronics sensor address (feb, hybrid) and the detector layer it reads, plus the strip transform that turns a physical channel (pchannel) into a sensor strip index.

Definition at line 15 of file TrackerDaqMap.h.

Member Function Documentation

◆ at()

const TrackerDaqMap::SensorInfo & tracking::reco::TrackerDaqMap::at	(	uint8_t	feb,
		uint8_t	hybrid ) const

Look up the sensor read by (feb, hybrid).

Exceptions

framework::exception::Exception if there is no such entry; callers that want to skip unmapped sensors must guard with has() first.

Definition at line 65 of file TrackerDaqMap.cxx.

                                                                         {
  auto it = sensors_.find(key(feb, hybrid));
  if (it == sensors_.end()) {
    EXCEPTION_RAISE("NotFound", "TrackerDaqMap has no entry for (feb=" +
                                    std::to_string(feb) +
                                    ", hybrid=" + std::to_string(hybrid) +
                                    "); guard with has() before calling at().");
  }
  return it->second;
}

References sensors_.

Referenced by tracking::reco::SiStripWaveformFitProcessor::produce().

◆ fromJsonFile()

TrackerDaqMap tracking::reco::TrackerDaqMap::fromJsonFile ( const std::string & path )

static

Load a DAQ map from a JSON file.

Expected schema:

{ "sensors": [ { "feb": 0, "hybrid": 0, "layer_id": 3101,
                 "n_strips": 640, "first_strip": 0, "reversed": false },
               ... ] }

Extra keys (e.g. "station", "orientation", "_comment") are ignored.

Exceptions

framework::exception::Exception if the file cannot be opened, is not valid JSON, lacks a non-empty "sensors" array, has a malformed entry, or defines the same (feb, hybrid) twice. There is no silent empty-map failure mode.

Definition at line 10 of file TrackerDaqMap.cxx.

                                                               {
  std::ifstream in(path);
  if (!in) {
    EXCEPTION_RAISE(
        "FileNotFound",
        "TrackerDaqMap could not open DAQ map file '" + path + "'.");
  }
 
  nlohmann::json doc;
  try {
    in >> doc;
  } catch (const nlohmann::json::parse_error& e) {
    EXCEPTION_RAISE("BadFormat",
                    "TrackerDaqMap failed to parse DAQ map file '" + path +
                        "': " + e.what());
  }
 
  if (!doc.contains("sensors") || !doc.at("sensors").is_array() ||
      doc.at("sensors").empty()) {
    EXCEPTION_RAISE("BadFormat", "TrackerDaqMap file '" + path +
                                     "' has no non-empty 'sensors' array.");
  }
 
  TrackerDaqMap map;
  for (const auto& s : doc.at("sensors")) {
    for (const char* required :
         {"feb", "hybrid", "layer_id", "n_strips", "first_strip", "reversed"}) {
      if (!s.contains(required)) {
        EXCEPTION_RAISE("BadFormat", "TrackerDaqMap file '" + path +
                                         "' has a sensor entry missing '" +
                                         required + "': " + s.dump());
      }
    }
 
    const auto feb = s.at("feb").get<uint8_t>();
    const auto hybrid = s.at("hybrid").get<uint8_t>();
    const uint16_t k = key(feb, hybrid);
    if (map.sensors_.count(k) != 0u) {
      EXCEPTION_RAISE("BadFormat", "TrackerDaqMap file '" + path +
                                       "' defines (feb=" + std::to_string(feb) +
                                       ", hybrid=" + std::to_string(hybrid) +
                                       ") more than once.");
    }
 
    SensorInfo info;
    info.layer_id_ = s.at("layer_id").get<int>();
    info.n_strips_ = s.at("n_strips").get<int>();
    info.first_strip_ = s.at("first_strip").get<int>();
    info.reversed_ = s.at("reversed").get<bool>();
    map.sensors_[k] = info;
  }
 
  return map;
}

References sensors_.

Referenced by tracking::reco::SiStripWaveformFitProcessor::onProcessStart().

◆ has()

bool tracking::reco::TrackerDaqMap::has	(	uint8_t	feb,
		uint8_t	hybrid ) const

inline

True if the map has an entry for this electronics sensor.

Definition at line 46 of file TrackerDaqMap.h.

                                              {
    return sensors_.find(key(feb, hybrid)) != sensors_.end();
  }

References sensors_.

Referenced by tracking::reco::SiStripWaveformFitProcessor::produce().

◆ key()

static uint16_t tracking::reco::TrackerDaqMap::key	(	uint8_t	feb,
		uint8_t	hybrid )

inlinestaticprivate

Definition at line 66 of file TrackerDaqMap.h.

                                                   {
    return static_cast<uint16_t>((static_cast<uint16_t>(feb) << 8) | hybrid);
  }

◆ sensors()

const std::map< uint16_t, SensorInfo > & tracking::reco::TrackerDaqMap::sensors ( ) const

inline

All sensors, keyed by (feb << 8) | hybrid.

For consumers that need to index by something other than the electronics address (e.g. build a layer_id -> n_strips lookup).

Definition at line 63 of file TrackerDaqMap.h.

63{ return sensors_; }

References sensors_.

◆ size()

std::size_t tracking::reco::TrackerDaqMap::size ( ) const

inline

Number of sensors in the map.

Definition at line 58 of file TrackerDaqMap.h.

58{ return sensors_.size(); }

References sensors_.

Referenced by tracking::reco::SiStripWaveformFitProcessor::onProcessStart().

Member Data Documentation

◆ sensors_

std::map<uint16_t, SensorInfo> tracking::reco::TrackerDaqMap::sensors_

private

key = (feb << 8) | hybrid

Definition at line 70 of file TrackerDaqMap.h.

Referenced by at(), fromJsonFile(), has(), sensors(), and size().

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

Tracking/include/Tracking/Reco/TrackerDaqMap.h
Tracking/src/Tracking/Reco/TrackerDaqMap.cxx

Classes

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ at()

◆ fromJsonFile()

◆ has()

◆ key()

◆ sensors()

◆ size()

Member Data Documentation

◆ sensors_