update README and header doxygen

key4hep · Nov 27, 2024 · 2fbfc2b · 2fbfc2b
1 parent 13ea3eb
commit 2fbfc2b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/DCHdigi/README.md b/DCHdigi/README.md
@@ -4,7 +4,7 @@
 
 * Each simulated hit is transformed into a digitized hit. The digitized hit position is the projection of the simulated hit position onto the sense wire (at the center of the cell)
 * Smearing of the digitized hit position along the wire and radially is done according to the input parameter values (`zResolution_mm` and `xyResolution_mm`, respectively)
-* The digitized hit adds new information: number of clusters and their size, which are derived from precalculated distributions contained in an input file specified by the parameter `fileDataAlg`. The method and distributions corresponds to the option 3 described in F. Cuna et al, arXiv:2105.07064
+* The digitized hit adds dNdx information if flag `calculate_dndx` is enabled (default not). This information consist on number of clusters and their size, which are derived from precalculated distributions contained in an input file specified by the parameter `fileDataAlg`. The method and distributions corresponds to the option 3 described in F. Cuna et al, arXiv:2105.07064
 * It requires that the cellID contain the layer and number of cell within the layer (nphi). It does not matter if the segmentation comes from geometrical segmentation by using twisted tubes and hyperboloids (and the cellID is created out of volume IDs), or the segmentation is virtual DD4hep segmentation
 * New digitized hit class is used as an EDM4hep data extension, to be integrated into EDM4hep
 * Debug histograms are created if `create_debug_histograms` option is enabled (output file name can be given)

diff --git a/DCHdigi/include/DCHdigi_v01.h b/DCHdigi/include/DCHdigi_v01.h
@@ -16,17 +16,19 @@
  * (default name DCH_DigiCollection) <br>
  * @param DCH_name DCH subdetector name <br>
  * (default value DCH_v2) <br>
-  * @param fileDataAlg File needed for calculating cluster count and size <br>
+ * @param calculate_dndx Optional flag to calcualte dNdx information <br>
+ * (default value false) <br>
+ * @param fileDataAlg File needed for calculating cluster count and size <br>
  * (default value /eos/.../DataAlgFORGEANT.root) <br>
-  * @param zResolution_mm Resolution (sigma for gaussian smearing) along the sense wire, in mm <br>
+ * @param zResolution_mm Resolution (sigma for gaussian smearing) along the sense wire, in mm <br>
  * (default value 1 mm) <br>
-  * @param xyResolution_mm Resolution (sigma for gaussian smearing) perpendicular the sense wire, in mm <br>
+ * @param xyResolution_mm Resolution (sigma for gaussian smearing) perpendicular the sense wire, in mm <br>
  * (default value 0.1 mm) <br>
-  * @param create_debug_histograms Optional flag to create debug histograms <br>
+ * @param create_debug_histograms Optional flag to create debug histograms <br>
  * (default value false) <br>
-  * @param GeoSvcName Geometry service name <br>
+ * @param GeoSvcName Geometry service name <br>
  * (default value GeoSvc) <br>
-  * @param uidSvcName The name of the UniqueIDGenSvc instance, used to create seed for each event/run, ensuring reproducibility. <br>
+ * @param uidSvcName The name of the UniqueIDGenSvc instance, used to create seed for each event/run, ensuring reproducibility. <br>
  * (default value uidSvc) <br>
  * <br>
  */