[EMCAL-1144] Fix operator+ in EMCAL Hit

mfasDa · sawenzel · commit 5592ca626ffe · 2024-06-03T10:30:27.000+02:00
- operator+ must be declared outside the class as
  binary operator
- Return object should be copy of the lhs hit and
  sum of the two energy losses
In addition:
- Fixing namespace of operator&lt;&lt;
- Updating doxymodules.h with new features in
  calibration part.
diff --git a/Detectors/EMCAL/base/include/EMCALBase/Hit.h b/Detectors/EMCAL/base/include/EMCALBase/Hit.h
@@ -22,6 +22,8 @@ namespace emcal
 /// \class Hit
 /// \brief EMCAL simulation hit information
 /// \ingroup EMCALbase
+/// \author Markus Fasel <markus.fasel@cern.ch>, Oak Ridge National Laboratory
+/// \since August 31st, 2017
 class Hit : public o2::BasicXYZEHit<float>
 {
  public:
@@ -63,11 +65,6 @@ class Hit : public o2::BasicXYZEHit<float>
   /// \return This point with the summed energy loss
   Hit& operator+=(const Hit& rhs);
 
-  /// \brief Creates a new point base on this point but adding the energy loss of the right hand side
-  /// \param rhs Hit to add to
-  /// \return New EMAL point base on this point
-  Hit operator+(const Hit& rhs) const;
-
   /// \brief Destructor
   ~Hit() = default;
 
@@ -99,6 +96,16 @@ class Hit : public o2::BasicXYZEHit<float>
   ClassDefNV(Hit, 1);
 };
 
+/// \brief Creates a new point base on this point but adding the energy loss of the right hand side
+/// \param lhs Left hand side of the sum
+/// \param rhs Right hand side of the sum
+/// \return New EMAL point base on this point
+Hit operator+(const Hit& lhs, const Hit& rhs);
+
+/// \brief Output stream operator for EMCAL hits
+/// \param stream Stream to write on
+/// \param point Hit to be printed
+/// \return Stream after printing
 std::ostream& operator<<(std::ostream& stream, const Hit& point);
 } // namespace emcal
 } // namespace o2
diff --git a/Detectors/EMCAL/base/src/Hit.cxx b/Detectors/EMCAL/base/src/Hit.cxx
@@ -32,7 +32,7 @@ Bool_t Hit::operator<(const Hit& rhs) const
 
 Bool_t Hit::operator==(const Hit& rhs) const
 {
-  return (GetDetectorID() == GetDetectorID()) && (GetTrackID() == rhs.GetTrackID());
+  return (GetDetectorID() == rhs.GetDetectorID()) && (GetTrackID() == rhs.GetTrackID());
 }
 
 Hit& Hit::operator+=(const Hit& rhs)
@@ -41,14 +41,14 @@ Hit& Hit::operator+=(const Hit& rhs)
   return *this;
 }
 
-Hit Hit::operator+(const Hit& rhs) const
+Hit o2::emcal::operator+(const Hit& lhs, const Hit& rhs)
 {
-  Hit result(*this);
+  Hit result(lhs);
   result.SetEnergyLoss(result.GetEnergyLoss() + rhs.GetEnergyLoss());
-  return *this;
+  return result;
 }
 
-std::ostream& operator<<(std::ostream& stream, const Hit& p)
+std::ostream& o2::emcal::operator<<(std::ostream& stream, const Hit& p)
 {
   p.PrintStream(stream);
   return stream;
diff --git a/Detectors/EMCAL/doxymodules.h b/Detectors/EMCAL/doxymodules.h
@@ -35,17 +35,24 @@
  * EMCAL calibration objects for
  * - Bad channel map
  * - Time calibration
+ * - Time slewing parameters
  * - Gain calibration
  * - Temperature calibration
+ * - FEE DCS parameters
+ * - Pedestal data
+ * In addition providing an interface convenient CCDB access and methods
+ * to recalibrate add cell level.
  */
 
 /**
  * @defgroup EMCALcalib EMCAL calib
  * @brief EMCAL bad channel calibration
  * @ingroup DetectorEMCAL
  *
- * Performs the EMCal bad channel calibration.
- *
+ * EMCAL calibrator performing
+ * - Bad channel calibration
+ * - Time calibration
+ * and corresponding workflows for calibration tasks.
  */
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ Bool_t Hit::operator<(const Hit& rhs) const`
`32`	`32`
`33`	`33`	`Bool_t Hit::operator==(const Hit& rhs) const`
`34`	`34`	`{`
`35`		`- return (GetDetectorID() == GetDetectorID()) && (GetTrackID() == rhs.GetTrackID());`
	`35`	`+ return (GetDetectorID() == rhs.GetDetectorID()) && (GetTrackID() == rhs.GetTrackID());`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`Hit& Hit::operator+=(const Hit& rhs)`
`@@ -41,14 +41,14 @@ Hit& Hit::operator+=(const Hit& rhs)`
`41`	`41`	`return *this;`
`42`	`42`	`}`
`43`	`43`
`44`		`-Hit Hit::operator+(const Hit& rhs) const`
	`44`	`+Hit o2::emcal::operator+(const Hit& lhs, const Hit& rhs)`
`45`	`45`	`{`
`46`		`- Hit result(*this);`
	`46`	`+ Hit result(lhs);`
`47`	`47`	`result.SetEnergyLoss(result.GetEnergyLoss() + rhs.GetEnergyLoss());`
`48`		`- return *this;`
	`48`	`+ return result;`
`49`	`49`	`}`
`50`	`50`
`51`		`-std::ostream& operator<<(std::ostream& stream, const Hit& p)`
	`51`	`+std::ostream& o2::emcal::operator<<(std::ostream& stream, const Hit& p)`
`52`	`52`	`{`
`53`	`53`	`p.PrintStream(stream);`
`54`	`54`	`return stream;`