harmonise two noise tool interfaces (#214)

* harmonise naming with ICaloReadCellNoiseMap * fix pre-commit test error * implement comments from review
key4hep · Jul 25, 2024 · da375fa · da375fa
1 parent 724e2c9
commit da375fa
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/k4Interface/include/k4Interface/ICaloReadCellNoiseMap.h b/k4Interface/include/k4Interface/ICaloReadCellNoiseMap.h
@@ -24,7 +24,7 @@
 
 /** @class ICaloReadCellNoiseMap RecInterface/RecInterface/ICaloReadCellNoiseMap.h ICaloReadCellNoiseMap.h
  *
- *  Abstarct Interface to noise per Calorimeter cell.
+ *  Abstract interface for tools that read noise values (RMS and offset) per calorimeter cell
  *
  *  @author Coralie Neubueser
  */
@@ -36,4 +36,4 @@ class ICaloReadCellNoiseMap : virtual public IAlgTool {
   virtual double noiseRMS(uint64_t aCellId)    = 0;
   virtual double noiseOffset(uint64_t aCellId) = 0;
 };
-#endif /* RECINTERFACE_ICALOREADNEIGHBOURSMAP_H */
+#endif /* RECINTERFACE_ICALOREADCELLNOISEMAP_H */
diff --git a/k4Interface/include/k4Interface/INoiseCaloCellsTool.h b/k4Interface/include/k4Interface/INoiseCaloCellsTool.h
@@ -24,7 +24,7 @@
 
 /** @class INoiseCaloCellsTool
  *
- *  Abstract interface to calorimeter noise tool
+ *  Abstract interface for tools that add or filter noise to calorimeter cells
  *
  *  @author Jana Faltova
  *  @date   2016-09

diff --git a/k4Interface/include/k4Interface/INoiseConstTool.h b/k4Interface/include/k4Interface/INoiseConstTool.h
@@ -24,7 +24,7 @@
 
 /** @class INoiseConstTool
  *
- *  Abstract interface to get calorimeter noise per cell tool
+ *  Abstract interface for tools that return noise values (RMS and offset) per calorimeter cell
  *  @author Coralie Neubueser
  *  @date   2018-01
  */
@@ -33,8 +33,8 @@ class INoiseConstTool : virtual public IAlgTool {
 public:
   DeclareInterfaceID(INoiseConstTool, 1, 0);
 
-  virtual double getNoiseConstantPerCell(uint64_t aCellID) = 0;
-  virtual double getNoiseOffsetPerCell(uint64_t aCellID)   = 0;
+  virtual double getNoiseRMSPerCell(uint64_t aCellID)    = 0;
+  virtual double getNoiseOffsetPerCell(uint64_t aCellID) = 0;
 };
 
 #endif /* RECINTERFACE_INOISECONSTTOOL_H */