Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Commit

Permalink
add some documentation of ecal det map
Browse files Browse the repository at this point in the history
  • Loading branch information
tomeichlersmith committed Nov 30, 2021
1 parent 19cba2f commit 1b14002
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion include/Ecal/EcalDetectorMap.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

namespace ecal {

/// The ECal map is between the ECal EID and the ECal DetID
typedef ldmx::TemplatedElectronicsMap<ldmx::EcalElectronicsID,ldmx::EcalID> EcalElectronicsMap;

/** \brief Class which provides various information about how the parts of the Ecal connect to each other.
Expand All @@ -42,10 +43,15 @@ typedef ldmx::TemplatedElectronicsMap<ldmx::EcalElectronicsID,ldmx::EcalID> Ecal
*/
class EcalDetectorMap : public framework::ConditionsObject {
public:
static constexpr const char* CONDITIONS_OBJECT_NAME{"EcalDetectorMap"};
/// The name of the EID <-> DetID map for the ECal
static constexpr const char* CONDITIONS_OBJECT_NAME{"EcalDetectorMap"};

/**
* Default constructor which builds the necessary maps.
*/
EcalDetectorMap();

/// Provider which loads the map
friend class EcalDetectorMapLoader;

/**
Expand All @@ -54,12 +60,17 @@ class EcalDetectorMap : public framework::ConditionsObject {
const EcalElectronicsMap& emap() const { return emap_; }

private:
/// import cell map from the provided CSV loader
void loadCellMap(conditions::GeneralCSVLoader& loader);
/// import motherboard map from the provided CSV loader
void loadMotherboardMap(conditions::GeneralCSVLoader& loader);
/// import layer map from the provided CSV loader
void loadLayerMap(conditions::GeneralCSVLoader& loader);

/// build the electronics map from loaded maps
void buildElectronicsMap();

/// the full electronics map
EcalElectronicsMap emap_;

/**
Expand Down

0 comments on commit 1b14002

Please sign in to comment.