Mu2e / Offline

Offline software for the Mu2e experiment
Apache License 2.0
8 stars 79 forks source link

Calorimeter object needs documentation #1256

Open brownd1978 opened 2 months ago

brownd1978 commented 2 months ago

The Calorimeter geometry object obtained via GeomHandle has an opaque interface and lacks documentation. For instance CalorimeterGeom/inc/CaloInfo.hh provides a text-string keyed interface, but there is no documentation what the valid text strings are. Documentation should be provided in the class headers, and in the appropriate section of the mu2e wiki, which is currently completely blank. That should also describe the different geometry systems used in the calorimeter (disk, crystal, etc) and their relationship to each other.