Clarify the documentation of the Cluster direction members (#406)

* Minor comment update * Update edm4hep.yaml Co-authored-by: Andre Sailer <[email protected]> --------- Co-authored-by: Andre Sailer <[email protected]>
key4hep · Feb 20, 2025 · e95e675 · e95e675
1 parent 06324b7
commit e95e675
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/edm4hep.yaml b/edm4hep.yaml
@@ -399,8 +399,8 @@ datatypes:
       - float                energyError [GeV]   // error on the energy
       - edm4hep::Vector3f    position [mm]       // position of the cluster
       - edm4hep::CovMatrix3f positionError   // covariance matrix of the position
-      - float                iTheta          // intrinsic direction of cluster at position  Theta. Not to be confused with direction cluster is seen from IP
-      - float                phi             // intrinsic direction of cluster at position - Phi. Not to be confused with direction cluster is seen from IP
+      - float                iTheta          // Polar angle of the cluster's intrinsic direction (used e.g. for vertexing). Not to be confused with the cluster position seen from IP
+      - float                phi             // Azimuthal angle of the cluster's intrinsic direction (used e.g. for vertexing). Not to be confused with the cluster position seen from IP
       - edm4hep::Vector3f    directionError [mm**2]  // covariance matrix of the direction
     VectorMembers:
       - float   shapeParameters      // shape parameters. This should be accompanied by a descriptive list of names in the shapeParameterNames collection level metadata, as a vector of strings with the same ordering