Skip to content

Commit fd5b814

Browse files
committed
update documentation
1 parent d155729 commit fd5b814

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

src/TRestGeant4Metadata.cxx

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,8 @@
217217
///
218218
/// * **gdml**: Bound the generator to a certain gdml component. No need to define size
219219
/// and position. Needs another "from" parameter. If the "from" parameter is defined,
220-
/// we can omit `shape="gdml"` parameter.
220+
/// we can omit `shape="gdml"` parameter. In the case that the gdml volume has daughters,
221+
/// the particles will be generated excluding the daughter volumes.
221222
/// \code
222223
/// // We launch particles from random positions inside the vessel volume defined in our GDML geometry
223224
/// <generator type="volume" from="vessel" > ... </generator>
@@ -543,9 +544,15 @@
543544
/// the GDML geometry. If an event did not produce an energy deposit in the
544545
/// sensitiveVolume, the event will not be stored at all. Therefore, the
545546
/// sensitive volume will serve as a trigger volume to decide when an event
546-
/// should be stored. For the moment we can only define a single sensitive
547-
/// volume, but it might be desirable to introduce boolean operations with
548-
/// different geometry volumes.
547+
/// should be stored. Multiple sensitive volumes can be defined by using
548+
/// different `<volume>` definitions with the parameter `sensitive="true"`.
549+
/// When multiple sensitive volumes are defined, the event will be stored
550+
/// if an energy deposit is produced in any of these sensitive volumes.
551+
/// You can also use a logical volume as sensitive volume, in this case
552+
/// all the physical volumes corresponding to that logical volume will be
553+
/// set as sensitive volumes. Furthermore, you can use regular expressions
554+
/// (at the parameter `name` of the `<volume>` definition) to define
555+
/// multiple sensitive volumes matching a certain pattern.
549556
///
550557
/// We can define the energy range we are interested in by defining the
551558
/// parameter energyRange. The event will be written to disk only if the
@@ -629,8 +636,9 @@
629636
/// \endcode
630637
///
631638
/// The option `removeUnwantedTracks` can optionally be enabled inside detector section:
632-
///
639+
/// \code
633640
/// <detector><removeUnwantedTracks enabled="true" keepZeroEnergyTracks="true"/></detector>
641+
/// \endcode
634642
///
635643
/// This option will remove all tracks that do not deposit energy in any of the sensitive volumes or in any of
636644
/// the volumes marked as 'keepTracks' (for instance <volume name="veto" keepTracks="true" />).

0 commit comments

Comments
 (0)