Go Back to: C++ Manual General Site
LDMX.Detectors package¶
Submodules¶
LDMX.Detectors.make_path module¶
Helpful python configuration functions for getting the path to installed detector descriptions.
makePath is meant to be internal to this module, but there is no reason a user could use it for a different purpose if desired
- This file was configured by cmake for the installation of ldmx-sw at
/home/runner/work/ldmx-sw/ldmx-sw/install
- LDMX.Detectors.make_path.makeDetectorPath(det_name)¶
Get the full path to the installed ldmx detector description
- Parameters:
det_name (str) – Name of detector to get a path for (should match the name of one of the detector directories)
- Returns:
full path to the installed detector gdml description
- Return type:
str
Examples
- Useful for use with the simulator producer:
from LDMX.Detector.makePath import * mySimulator.detector = makeDetectorPath( ‘ldmx-det-v12’ )
- LDMX.Detectors.make_path.makePath(det_name, file_name)¶
Return a path to the installed data directory for the input detector and file names.
Assumes the detectors are installed in the ‘data/detectors’ directory in the installation directory. Errors out the python script if the created full path does exist. This could happen because - The inputs were spelled wrong - The detector gdml files were not installed - The detector or file you want doesn’t exist
- Parameters:
det_name (str) – Name of detector to get a path for (should match the name of one of the detector directories)
file_name (str) – Name of the detector gdml file to get a path for (should match the name – no extension – of one of the gdml files)
- Returns:
full path to installed detector gdml description
- Return type:
str
- LDMX.Detectors.make_path.makeScoringPlanesPath(det_name)¶
Get the full path to the installed ldmx scoring planes description
- Parameters:
det_name (str) – Name of detector to get a path for (should match the name of one of the detector directories)
- Returns:
full path to the installed scoring planes gdml description
- Return type:
str
Examples
- Useful for use with the simulator producer:
from LDMX.Detector.makePath import * mySimulator.scoring_planes = makeScoringPlanesPath( ‘ldmx-det-v12’ )