[SiPM] Major performance updates

Author: EdoPro98

include/SiPMAnalogSignal.h

@@ -19,10 +19,8 @@
 #ifndef SIPM_SIPMSIGNAL_H
 #define SIPM_SIPMSIGNAL_H
 
-#include <algorithm>
 #include <cmath>
 #include <cstdint>
-#include <iomanip>
 #include <iostream>
 #include <sstream>
 #include <vector>
@@ -33,27 +31,22 @@ class SiPMAnalogSignal {
   SiPMAnalogSignal() = default;
 
   SiPMAnalogSignal(const std::vector<float>& wav, const double sampling) noexcept
-    : m_Waveform(wav), m_Sampling(sampling){};
+    : m_Waveform(std::move(wav)), m_Sampling(sampling) {};
 
-  SiPMAnalogSignal& operator=(const std::vector<float>& v) {
-    m_Waveform = std::move(v);
-    return *this;
-  }
-
-  std::vector<float>::iterator begin() noexcept { return m_Waveform.begin(); }
-  std::vector<float>::iterator end() noexcept { return m_Waveform.end(); }
+  float* data() noexcept { return m_Waveform.data(); }
 
   inline float& operator[](const uint32_t i) noexcept { return m_Waveform[i]; }
   inline float operator[](const uint32_t i) const noexcept { return m_Waveform[i]; }
 
   /// @brief Returns the number of points in the waveform
   inline uint32_t size() const { return m_Waveform.size(); }
-  /// @brief Resets the class to its initial state
-  void clear() { m_Waveform.clear(); }
   /// @brief Returns the sampling time of the signal in ns
-  double sampling() const { return m_Sampling; }
+  inline double sampling() const { return m_Sampling; }
+  /// @brief Returns the signal length in ns
+  inline double length() const { return (double)m_Waveform.size() / m_Sampling; }
   /// @brief Returns the waveform in an accessible data structure
-  std::vector<float> waveform() const { return m_Waveform; }
+  inline const std::vector<float>& waveform() const noexcept {return m_Waveform; }
+
 
   /// @brief Returns integral of the signal
   double integral(const double, const double, const double) const;
@@ -72,12 +65,10 @@ class SiPMAnalogSignal {
     return ss.str();
   }
   friend std::ostream& operator<<(std::ostream&, const SiPMAnalogSignal&);
-  friend class SiPMSensor;
 
 private:
-  void setSampling(const double sampling) { m_Sampling = sampling; };
   std::vector<float> m_Waveform;
-  double m_Sampling = 1;
+  double m_Sampling;
 } /* SiPMAnalogSignal */;
 
 } /* namespace sipm */

include/SiPMHit.h

@@ -16,6 +16,7 @@
 #include <cstdint>
 #include <iomanip>
 #include <iostream>
+#include <memory>
 #include <sstream>
 
 namespace sipm {
@@ -24,7 +25,7 @@ class SiPMHit {
   /** @enum HitType
    * Defines the generating process for the hit
    */
-  enum class HitType {
+  enum class HitType : uint8_t {
     kPhotoelectron,           ///< Hit generated by a photoelectron
     kDarkCount,               ///< Hit generated by a dark count event
     kOpticalCrosstalk,        ///< Hit generated by an optical crosstalk
@@ -33,9 +34,10 @@ class SiPMHit {
     kSlowAfterPulse           ///< Hit generated by a slow afterpulse
   };
 
-  constexpr SiPMHit(const double time, const double amp, const uint32_t r, const uint32_t c,
-                    const HitType type) noexcept
-    : m_Time(time), m_Amplitude(amp), m_Row(r), m_Col(c), m_HitType(type), m_Hash((uint64_t)r << 32 | c) {}
+  constexpr SiPMHit(double time, float amp, uint32_t row, uint32_t col, HitType type,
+                    const SiPMHit* parentPtr = nullptr) noexcept
+    : m_Time(time), m_Amplitude(amp), m_Row(row), m_Col(col), m_HitType(type), m_ParentPtr(parentPtr) {}
+
 
   /// @brief Comparison operator for hits
   /**
@@ -45,16 +47,16 @@ class SiPMHit {
    * arrving/generating time.
    */
   constexpr bool operator<(const SiPMHit& rhs) const noexcept { return m_Time < rhs.m_Time; }
-  constexpr bool operator<=(const SiPMHit& rhs) const noexcept { return m_Time <= rhs.m_Time; }
-  constexpr bool operator>(const SiPMHit& rhs) const noexcept { return m_Time > rhs.m_Time; }
-  constexpr bool operator>=(const SiPMHit& rhs) const noexcept { return m_Time >= rhs.m_Time; }
+  constexpr bool operator<=(const SiPMHit& rhs) const noexcept { return !(rhs < *this); }
+  constexpr bool operator>(const SiPMHit& rhs) const noexcept { return rhs < *this; }
+  constexpr bool operator>=(const SiPMHit& rhs) const noexcept { return !(*this < rhs); }
 
   /// @brief Operator used to check if the hit is generated in the same cell
   /**
    * Hits are considered equal if they have same row and column,
    * hence the same SiPM cell
    */
-  constexpr bool operator==(const SiPMHit& rhs) const noexcept { return m_Hash == rhs.m_Hash; }
+  constexpr bool operator==(const SiPMHit& rhs) const noexcept { return m_Row == rhs.m_Row && m_Col == rhs.m_Col; }
 
   /// @brief Returns hit time
   constexpr double time() const noexcept { return m_Time; }
@@ -63,11 +65,11 @@ class SiPMHit {
   /// @brief Returns column of hitted cell
   constexpr uint32_t col() const noexcept { return m_Col; }
   /// @brief Returns amplitude of the signal produced by the hit
-  double amplitude() const noexcept { return m_Amplitude; }
-  double& amplitude() { return m_Amplitude; }
+  float amplitude() const noexcept { return m_Amplitude; }
+  float& amplitude() { return m_Amplitude; }
   /// @brief Returns hit type to identify the hits
   constexpr HitType hitType() const noexcept { return m_HitType; }
-  constexpr uint64_t hash() const noexcept { return m_Hash; }
+  constexpr const SiPMHit* parent() const noexcept { return m_ParentPtr; }
 
   friend std::ostream& operator<<(std::ostream&, const SiPMHit&);
   std::string toString() const {
@@ -83,11 +85,11 @@ class SiPMHit {
   // Once a hit is constructed only
   // amplitude can be changed
   const double m_Time;
-  double m_Amplitude;
+  const SiPMHit* m_ParentPtr;
+  float m_Amplitude;
   const uint32_t m_Row;
   const uint32_t m_Col;
   const HitType m_HitType;
-  const uint64_t m_Hash;
 };
 
 inline std::ostream& operator<<(std::ostream& out, const SiPMHit& obj) {

include/SiPMProperties.h

@@ -14,11 +14,8 @@
 #ifndef SIPM_SIPMPROPERTIES_H
 #define SIPM_SIPMPROPERTIES_H
 
-#include <algorithm>
 #include <cmath>
 #include <cstdint>
-#include <fstream>
-#include <iomanip>
 #include <iostream>
 #include <map>
 #include <sstream>
@@ -45,6 +42,8 @@ class SiPMProperties {
     kGaussian ///< 95% of photons have a gaussian distribution
   };
 
+  SiPMProperties();
+
   /// @brief Used to read settings from a json file
   static SiPMProperties readSettings(const std::string&);
 
@@ -55,13 +54,13 @@ class SiPMProperties {
   constexpr uint32_t pitch() const { return m_Pitch; }
 
   /// @brief Returns total number of cells in the sensor
-  constexpr uint32_t nCells() const;
+  constexpr uint32_t nCells() const { return m_Ncells; }
 
   /// @brief Returns number of cells in the side of the sensor
-  constexpr uint32_t nSideCells() const;
+  constexpr uint32_t nSideCells() const { return m_SideCells; }
 
   /// @brief Returns total number of points in the signal
-  constexpr uint32_t nSignalPoints() const;
+  constexpr uint32_t nSignalPoints() const { return m_SignalPoints; }
 
   /// @brief Returns @ref HitDistribution type of the sensor
   constexpr HitDistribution hitDistribution() const { return m_HitDistribution; }
@@ -114,7 +113,7 @@ class SiPMProperties {
   constexpr double apSlowFraction() const { return m_ApSlowFraction; }
 
   /// @brief Returns value of cell-to-cell gain variation.
-  constexpr double ccgv() const { return m_Ccgv; }
+  constexpr float ccgv() const { return m_Ccgv; }
 
   /// @brief Returns relative gain.
   constexpr double gain() const { return m_Gain; }
@@ -123,13 +122,13 @@ class SiPMProperties {
   constexpr double snrdB() const { return m_SnrdB; }
 
   /// @brief Returns RMS of the noise.
-  constexpr double snrLinear() const;
+  constexpr double snrLinear() const { return m_SnrLinear; }
 
   /// @brief Returns value of PDE if PdeType::kSimplePde is set.
   constexpr double pde() const { return m_Pde; }
 
   /// @brief Returns wavelength-PDE values if PdeType::kSpectrumPde is set
-  const std::map<double, double>& pdeSpectrum() const { return m_PdeSpectrum; }
+  std::map<double, double> pdeSpectrum() const { return m_PdeSpectrum; }
 
   /// @brief Returns type of PDE calculation used.
   constexpr PdeType pdeType() { return m_HasPde; }
@@ -170,11 +169,17 @@ class SiPMProperties {
   }
 
   /// @brief Set sampling time of the signal in ns
-  void setSampling(const double);
+  void setSampling(const double x) {
+    m_Sampling = x;
+    m_SignalPoints = m_SignalLength / m_Sampling;
+  }
 
   /// @brief Set length of the signa in ns
-  /// @parame x Signal length in ns
-  constexpr void setSignalLength(const double x) { m_SignalLength = x; }
+  /// @param x Signal length in ns
+  constexpr void setSignalLength(const double x) {
+    m_SignalLength = x;
+    m_SignalPoints = m_SignalLength / m_Sampling;
+  }
 
   /// @brief Set rising time constant of signal @sa SiPMSensor::signalShape
   /// @param x Signal risign time constant in ns
@@ -220,11 +225,11 @@ class SiPMProperties {
 
   /// @brief Set probability to have slow afterpulses over fast ones
   /// @param x Fraction of afterpulses generated using slow component
-  constexpr void setTauApSlowFraction(const double x) { m_ApSlowFraction = x; }
+  constexpr void setApSlowFraction(const double x) { m_ApSlowFraction = x; }
 
   /// @brief Set cell-to-cell gain variation @sa m_Ccgv
   /// @param x Value of ccgv as a fraction of signal
-  constexpr void setCcgv(const double x) { m_Ccgv = x; }
+  constexpr void setCcgv(const float x) { m_Ccgv = x; }
 
   /// @brief Set value for PDE (and sets @ref PdeType::kSimplePde)
   /// @param x Flat value of PDE to be applied
@@ -304,17 +309,17 @@ class SiPMProperties {
 private:
   double m_Size = 1;
   double m_Pitch = 25;
-  mutable uint32_t m_Ncells = 0;
-  mutable uint32_t m_SideCells = 0;
+  uint32_t m_Ncells;
+  uint32_t m_SideCells;
   HitDistribution m_HitDistribution = HitDistribution::kUniform;
 
   double m_Sampling = 1;
   double m_SignalLength = 500;
-  mutable uint32_t m_SignalPoints = 0;
+  uint32_t m_SignalPoints = 0;
   double m_RiseTime = 1;
   double m_FallTimeFast = 50;
   double m_FallTimeSlow = 100;
-  double m_SlowComponentFraction;
+  double m_SlowComponentFraction = 0.2;
   double m_RecoveryTime = 50;
 
   double m_Dcr = 200e3;
@@ -325,10 +330,10 @@ class SiPMProperties {
   double m_TauApFastComponent = 10;
   double m_TauApSlowComponent = 80;
   double m_ApSlowFraction = 0.5;
-  double m_Ccgv = 0.05;
+  float m_Ccgv = 0.05;
   double m_SnrdB = 30;
-  double m_Gain = 1.0;
-  mutable double m_SnrLinear = 0;
+  float m_Gain = 1.0;
+  double m_SnrLinear;
 
   double m_Pde = 1;
   std::map<double, double> m_PdeSpectrum;
@@ -340,40 +345,5 @@ class SiPMProperties {
   bool m_HasAp = true;
   bool m_HasSlowComponent = false;
 };
-// Constexpr assumes inline
-
-constexpr uint32_t SiPMProperties::nCells() const {
-  // m_SideCells and m_Ncells are cached
-  if ((m_SideCells == 0) || (m_Ncells == 0)) {
-    m_SideCells = 1000 * m_Size / m_Pitch;
-    m_Ncells = m_SideCells * m_SideCells;
-  }
-  return m_Ncells;
-}
-
-constexpr uint32_t SiPMProperties::nSideCells() const {
-  // m_SideCells and m_Ncells are cached
-  if ((m_SideCells == 0) || (m_Ncells == 0)) {
-    m_SideCells = 1000 * m_Size / m_Pitch;
-    m_Ncells = m_SideCells * m_SideCells;
-  }
-  return m_SideCells;
-}
-
-constexpr uint32_t SiPMProperties::nSignalPoints() const {
-  // m_Signalpoints is cached
-  if (m_SignalPoints == 0) {
-    m_SignalPoints = m_SignalLength / m_Sampling;
-  }
-  return m_SignalPoints;
-}
-
-constexpr double SiPMProperties::snrLinear() const {
-  // m_SnrLinear is cached
-  if (m_SnrLinear == 0) {
-    m_SnrLinear = pow(10, -m_SnrdB / 20);
-  }
-  return m_SnrLinear;
-}
 } // namespace sipm
 #endif /* SIPM_SIPMPROPERTIES_H  */