From 8a37cde8ad1eb520890af1fa461a9785197b7ac7 Mon Sep 17 00:00:00 2001
From: Andre Sailer <andre.philippe.sailer@cern.ch>
Date: Mon, 3 May 2021 11:11:46 +0200
Subject: [PATCH] DDSim.Action: extend docstrings
---
DDG4/python/DDSim/Helper/Action.py | 20 ++++++++++++++++----
1 file changed, 16 insertions(+), 4 deletions(-)
diff --git a/DDG4/python/DDSim/Helper/Action.py b/DDG4/python/DDSim/Helper/Action.py
index 21488c8d2..e77265483 100644
--- a/DDG4/python/DDSim/Helper/Action.py
+++ b/DDG4/python/DDSim/Helper/Action.py
@@ -8,14 +8,22 @@ import ddsix as six
class Action(ConfigHelper):
- """Action holding sensitive detector actions
+ """Helper holding sensitive detector actions.
+
The default tracker and calorimeter actions can be set with
>>> SIM = DD4hepSimulation()
>>> SIM.action.tracker=('Geant4TrackerWeightedAction', {'HitPositionCombination': 2, 'CollectSingleDeposits': False})
>>> SIM.action.calo = "Geant4CalorimeterAction"
- for specific subdetectors specific sensitive detectors can be set based on pattern matching
+ The default sensitive actions for calorimeters and trackers are applied based on the sensitive type.
+ The list of sensitive types can be changed with
+
+ >>> SIM = DD4hepSimulation()
+ >>> SIM.action.trackerSDTypes = ['tracker', 'myTrackerSensType']
+ >>> SIM.calor.calorimeterSDTypes = ['calorimeter', 'myCaloSensType']
+
+ For specific subdetectors specific sensitive detectors can be set based on patterns in the name of the subdetector.
>>> SIM = DD4hepSimulation()
>>> SIM.action.mapActions['tpc'] = "TPCSDAction"
@@ -55,8 +63,12 @@ class Action(ConfigHelper):
@property
def mapActions(self):
- """ create a map of patterns and actions to be applied to sensitive detectors
- example: SIM.action.mapActions['tpc'] = "TPCSDAction" """
+ """Create a map of patterns and actions to be applied to sensitive detectors.
+
+ Example: if the name of the detector matches tpc the TPCSDAction is used.
+
+ SIM.action.mapActions['tpc'] = "TPCSDAction"
+ """
return self._mapActions
@mapActions.setter
--
GitLab