HgcrocDigiCollection.h

Go to the documentation of this file.

 
#ifndef RECON_EVENT_HGCROCDIGICOLLECTION_H_
#define RECON_EVENT_HGCROCDIGICOLLECTION_H_
 
// ROOT
#include "TObject.h"  //for ClassDef
 
// STL
#include <stdint.h>  //32bit words
 
#include <iostream>  //Print method
#include <vector>    //vector lists
 
namespace ldmx {
 
class HgcrocDigiCollection {
 public:
  class Sample {
   public:
    Sample(bool tot_progress, bool tot_complete, int firstMeas, int seconMeas,
           int toa, int version = 3);
 
    Sample(uint32_t w, int version = 3) : word_(w), version_{version} {}
 
    Sample() {}
 
    bool isTOTinProgress() const {
      return (ONE_BIT_MASK & (word_ >> FIRSTFLAG_POS));
    }
 
    bool isTOTComplete() const {
      return (ONE_BIT_MASK & (word_ >> SECONFLAG_POS));
    }
 
    int toa() const {
      if (version_ == 2) {
        return secon();
      } else {
        return third();
      }
    }
 
    int tot() const {
      if (version_ == 2) {
        return 0xfff & (word_ >> FIRSTMEAS_POS);
      }
 
      int meas = secon();
      if (meas > 512) meas = (meas - 512) * 8;
      return meas;
    }
 
    int adcTm1() const { return first(); }
 
    int adcT() const {
      if (version_ == 2) {
        return third();
      }
 
      if (not isTOTComplete())
        return secon();  // running modes
      else
        return first();  // calibration mode
    }
 
    uint32_t raw() const { return word_; }
 
   private:
    int first() const { return TEN_BIT_MASK & (word_ >> FIRSTMEAS_POS); }
 
    int secon() const { return TEN_BIT_MASK & (word_ >> SECONMEAS_POS); }
 
    int third() const { return TEN_BIT_MASK & word_; }
 
   private:
    uint32_t word_;
    int version_;
  };  // Sample
 
 public:
  class HgcrocDigi {
   public:
    HgcrocDigi(unsigned int id, std::vector<uint32_t>::const_iterator first,
               const HgcrocDigiCollection& collection)
        : id_(id), first_(first), collection_(collection) {}
 
    unsigned int id() const { return id_; }
 
    bool isADC() const {
      return !(soi().isTOTinProgress() or soi().isTOTComplete());
    }
 
    bool isTOT() const { return !isADC(); }
 
    int tot() const {
      if (not isTOT()) return -1;
      if (soi().isTOTinProgress()) return -2;
      return soi().tot();
    }
 
    int totSampleIndex() const {
      for (unsigned int i_sample{0}; i_sample < size(); i_sample++)
        if (at(i_sample).isTOTComplete()) return i_sample;
      return -1;
    }
 
    HgcrocDigiCollection::Sample at(unsigned int i_sample) const {
      return Sample(*(first_ + i_sample), collection_.getVersion());
    }
 
    HgcrocDigiCollection::Sample soi() const {
      return at(collection_.getSampleOfInterestIndex());
    }
 
    unsigned int size() const { return collection_.getNumSamplesPerDigi(); }
 
   private:
    unsigned int id_;
 
    std::vector<uint32_t>::const_iterator first_;
 
    const HgcrocDigiCollection& collection_;
 
  };  // HgcrocDigi
 
 public:
  HgcrocDigiCollection() {}
 
  virtual ~HgcrocDigiCollection() {}
 
  void clear();
 
  friend std::ostream& operator<<(std::ostream& o,
                                  const HgcrocDigiCollection& d);
  int getVersion() const { return version_; }
 
  void setVersion(int v) {
    version_ = v;
    return;
  }
 
  unsigned int getNumSamplesPerDigi() const { return num_samples_per_digi_; }
 
  void setNumSamplesPerDigi(unsigned int n) {
    num_samples_per_digi_ = n;
    return;
  }
 
  unsigned int getSampleOfInterestIndex() const { return sample_of_interest_; }
 
  void setSampleOfInterestIndex(unsigned int n) {
    sample_of_interest_ = n;
    return;
  }
 
  const HgcrocDigi getDigi(unsigned int digiIndex) const;
 
  unsigned int getNumDigis() const { return channel_ids_.size(); }
 
  unsigned int size() const { return channel_ids_.size(); }
 
  void addDigi(unsigned int id, const std::vector<Sample>& digi);
  void addDigi(unsigned int id, const std::vector<uint32_t>& digi);
 
 public:
  class Iterator {
   public:
    explicit Iterator(HgcrocDigiCollection& c, long index = 0)
        : digi_index_{index}, coll_{c} {}
    Iterator& operator++() {
      digi_index_++;
      return *this;
    }
    Iterator operator++(int) {
      Iterator retval = *this;
      ++(*this);
      return retval;
    }
    bool operator==(Iterator other) const {
      return digi_index_ == other.digi_index_;
    }
    bool operator!=(Iterator other) const { return !(*this == other); }
    const HgcrocDigi operator*() const { return coll_.getDigi(digi_index_); }
 
   private:
    long digi_index_{0};
    HgcrocDigiCollection& coll_;
  };  // iterator
 
 public:
  Iterator begin() { return Iterator(*this, 0); }
 
  Iterator end() { return Iterator(*this, getNumDigis()); }
 
 private:
  static const int ONE_BIT_MASK = 1;
 
  static const int TEN_BIT_MASK = (1 << 10) - 1;
 
  static const int FIRSTFLAG_POS = 31;
 
  static const int SECONFLAG_POS = 30;
 
  static const int FIRSTMEAS_POS = 20;
 
  static const int SECONMEAS_POS = 10;
 
 private:
  std::vector<unsigned int> channel_ids_;
 
  std::vector<uint32_t> samples_;
 
  unsigned int num_samples_per_digi_;
 
  unsigned int sample_of_interest_;
 
  int version_;
 
  ClassDef(HgcrocDigiCollection, 6);
};
}  // namespace ldmx
 
std::ostream& operator<<(std::ostream& s,
                         const ldmx::HgcrocDigiCollection::Sample& sample);
 
std::ostream& operator<<(std::ostream& s,
                         const ldmx::HgcrocDigiCollection::HgcrocDigi& digi);
 
std::ostream& operator<<(std::ostream& s,
                         const ldmx::HgcrocDigiCollection& col);
 
#endif /* RECON_EVENT_ECALDIGI_H_ */