BmnDetectorModel.h

Go to the documentation of this file.

/*
    BM@N alignment routine
    BM@N experiment at NICA complex, JINR, 2025
 
    Department: Math & Soft Group of HEP lab
    Author:     Igor Polev, polev@jinr.ru
 
    BmnDetectorModel abstract class header-only implementation
    Representation of detector as enumerated elements ID
*/
 
#ifndef BMNDETECTORMODEL_H
#define BMNDETECTORMODEL_H
 
#include "BmnAlignDefines.h"
#include "fairlogger/Logger.h"
 
#include <array>
#include <map>
 
/*
 * Due to usage of pure virtual mechanics it is not possible to
 * implement object initialization in constructor.
 * Therefore, Init() method is mandatory to call right after object creation.
 */
 
class BmnDetectorModel
{
  private:
    Bool_t fInitialized{false};
    // encoded ID to index mapping (and vice versa)
    std::map<Int_t, Int_t> fIDtoIdx;
    std::array<Int_t, BMN_MODULE_COUNT> fIdxToID;
 
  protected:
    // detector modules enumeration interface
    virtual void Reset() = 0;     // set ID sequense BEFORE first element
    virtual Int_t NextID() = 0;   // return ID value for the next element in sequense
                                  // or NEGATIVE value if sequence is over
  public:
    virtual Int_t MaxModulesInStation() const = 0;   // maximum number of modules in one station
    virtual Int_t Alignables() const = 0;            // number of alignable elements
    // re-encode DetectorID from hit into decector model ID
    // value must correspond to hit DetectorID as much as possible
    virtual Int_t IDfromHit(Int_t HitDetectorID) const = 0;
 
    BmnDetectorModel() = default;
    virtual ~BmnDetectorModel() = default;
    inline Bool_t Init();   // must be called right after object creation
    inline Int_t EncodedID(Int_t idx) const { return fInitialized ? fIdxToID.at(idx) : -1; };
    inline Int_t Idx(Int_t ID) const { return fInitialized ? fIDtoIdx.at(ID) : -1; };
    inline Int_t IdxFromHit(Int_t hitID) const { return fInitialized ? fIDtoIdx.at(IDfromHit(hitID)) : -1; };
    inline Bool_t UnknownID(Int_t ID) const { return fInitialized ? fIDtoIdx.find(ID) == fIDtoIdx.end() : kTRUE; }
};
 
inline Bool_t BmnDetectorModel::Init()
{
    // check modules count
    if (BMN_MODULE_COUNT != Alignables()) {
        LOG(error) << " <!> BmnDetectorModel : wrong detector configuration"
                   << "\n     modules expected: " << BMN_MODULE_COUNT << "\n     modules provided: " << Alignables();
        return kFALSE;
    }
    // build linear enumeration of detector modules
    Reset();
    Int_t ID{NextID()}, idx{0};
    while (ID >= 0) {   // negative values indicate end of sequense
        fIDtoIdx[ID] = idx;
        fIdxToID[idx++] = ID;
        ID = NextID();
    }
    return fInitialized = kTRUE;
};
 
#endif   // BMNDETECTORMODEL_H