DumpGeoConfig Namespace Reference

Functions
def	configureGeometry (flags, cfg)
def	getATLASVersion ()
def	DumpGeoCfg (flags, name="DumpGeoCA", **kwargs)

Variables
	_logger = logging.getLogger('DumpGeo')
	flags = initConfigFlags()
	MaxEvents
	NumThreads
	parser = flags.getArgumentParser(description="Dump the detector geometry to a GeoModel-based SQLite '.db' file.")
	prog
	default
	help
	metavar
	action
	args = flags.fillFromArgs(parser=parser)
	OutputFileName
	ShowTreetopContent
	ForceOverwrite
bool	dumpgeo_empty_input = False
	ProjectName
	RunNumbers
	TimeStamps
	TypedCollections
	GlobalTag
	isMC
	MCCampaign
	AtlasVersion
	None
	use_metadata
	toggle_geometry
	True
	keep_beampipe
	cfg = MainServicesCfg(flags)
	debugCAlevel = int(args.debugCA)

Function Documentation

configureGeometry()

def DumpGeoConfig.configureGeometry	(		flags,
			cfg
	)

Definition at line 25 of file DumpGeoConfig.py.

def configureGeometry(flags, cfg):
 
    # Beam pipe
    if flags.Detector.GeometryBpipe:
        from BeamPipeGeoModel.BeamPipeGMConfig import BeamPipeGeometryCfg
        cfg.merge(BeamPipeGeometryCfg(flags))
 
    # Inner Detectors
    if flags.Detector.GeometryPixel:
        from PixelGeoModel.PixelGeoModelConfig import PixelReadoutGeometryCfg
        cfg.merge(PixelReadoutGeometryCfg(flags))
    # TODO: do we need to set this separately?
    # if flags.Detector.GeometryBCM:
 
    if flags.Detector.GeometrySCT:
        from SCT_GeoModel.SCT_GeoModelConfig import SCT_ReadoutGeometryCfg
        cfg.merge(SCT_ReadoutGeometryCfg(flags))
 
    if flags.Detector.GeometryTRT:
        from TRT_GeoModel.TRT_GeoModelConfig import TRT_ReadoutGeometryCfg
        cfg.merge(TRT_ReadoutGeometryCfg(flags))
 
    # InDetServMat
    # Trigger the build of the InDetServMat geometry 
    # if any ID subsystems have been enabled
    if flags.Detector.GeometryID:
        from InDetServMatGeoModel.InDetServMatGeoModelConfig import (
             InDetServiceMaterialCfg)
        cfg.merge(InDetServiceMaterialCfg(flags))
 
    # Calorimeters
    if flags.Detector.GeometryLAr:
        from LArGeoAlgsNV.LArGMConfig import LArGMCfg
        cfg.merge(LArGMCfg(flags))
 
    if flags.Detector.GeometryTile:
        from TileGeoModel.TileGMConfig import TileGMCfg
        #flags.Tile.forceFullGeometry = True
        cfg.merge(TileGMCfg(flags))
        # We must set the "FULL" geometry explicitely, otherwise the "RECO" version will be used by default,
        # which is almost 'empty' (just the first level of child volumes is created for the "RECO" geo).
        cfg.getService("GeoModelSvc").DetectorTools["TileDetectorTool"].GeometryConfig="FULL"
    # TODO: do we need to set this separately?
    # if flags.Detector.GeometryMBTS:
 
    # Muon spectrometer
    if flags.Detector.GeometryMuon:
        from MuonConfig.MuonGeometryConfig import MuonGeoModelCfg
        cfg.merge(MuonGeoModelCfg(flags))
 
    # HGTD (defined only for Run4 geometry tags)
    if flags.Detector.GeometryHGTD:
        #set up geometry
        if flags.HGTD.Geometry.useGeoModelXml:
            from HGTD_GeoModelXml.HGTD_GeoModelConfig import HGTD_SimulationGeometryCfg
        else:
            from HGTD_GeoModel.HGTD_GeoModelConfig import HGTD_SimulationGeometryCfg
        cfg.merge(HGTD_SimulationGeometryCfg(flags))
        
    # ITk (defined only for Run4 geometry tags)
    if flags.Detector.GeometryITkPixel:
        from PixelGeoModelXml.ITkPixelGeoModelConfig import ITkPixelReadoutGeometryCfg
        cfg.merge(ITkPixelReadoutGeometryCfg(flags))
    if flags.Detector.GeometryITkStrip:
        from StripGeoModelXml.ITkStripGeoModelConfig import ITkStripReadoutGeometryCfg
        cfg.merge(ITkStripReadoutGeometryCfg(flags))
    # TODO: do we need to set those separately?
    # if flags.Detector.GeometryBCMPrime:
    # if flags.Detector.GeometryPLR:
 
    # Cavern (disabled by default)
    if flags.Detector.GeometryCavern:
        from AtlasGeoModel.CavernGMConfig import CavernGeometryCfg
        cfg.merge(CavernGeometryCfg(flags))
    
    # Forward detectors (disabled by default)
    if flags.Detector.GeometryLucid or flags.Detector.GeometryALFA or flags.Detector.GeometryAFP or flags.Detector.GeometryFwdRegion :
        from AtlasGeoModel.ForDetGeoModelConfig import ForDetGeometryCfg
        cfg.merge(ForDetGeometryCfg(flags))
    if flags.Detector.GeometryZDC:
        from ZDC_GeoM.ZdcGeoModelConfig import ZDC_DetToolCfg
        cfg.merge(ZDC_DetToolCfg(flags))
 
    # Temporary 'hack': 
    # Replace EllipticTube with Box, 
    # to bypass a crash due to lack of support 
    # for EllipticTube in GeoModelIO 
    # See: https://its.cern.ch/jira/browse/ATLASSIM-7263
    if "ForwardRegionGeoModelTool" in cfg.getService("GeoModelSvc").DetectorTools:
        cfg.getService("GeoModelSvc").DetectorTools["ForwardRegionGeoModelTool"].vp1Compatibility=True
 
 

DumpGeoCfg()

def DumpGeoConfig.DumpGeoCfg	(		flags,
			name = "DumpGeoCA",
		**	kwargs
	)

Definition at line 124 of file DumpGeoConfig.py.

def DumpGeoCfg(flags, name="DumpGeoCA", **kwargs):
    result = ComponentAccumulator()
 
    _logger.info("We're using these 'GeoModel.DumpGeo' configuration flags:")
    flags.dump("GeoModel.DumpGeo")
 
    # Debug messages
    _logger.debug("kwargs: %s", kwargs)
    
    # set additional DumpGeo Alg's properties
    _logger.verbose("Using ATLAS/Athena version: %s", getATLASVersion())
    _logger.verbose("Using GeoModel ATLAS version: %s", flags.GeoModel.AtlasVersion)
    kwargs.setdefault("AtlasRelease", getATLASVersion())
    kwargs.setdefault("AtlasVersion", flags.GeoModel.AtlasVersion)
    
    # Set the user's choice to see the content of the Treetops
    if flags.GeoModel.DumpGeo.ShowTreetopContent:
        kwargs.setdefault("ShowTreetopContent", True)
 
    # Set the name of the output '.db' file.
    # Pick the custom name if the user set it;
    # otherwise, build it from the geometry tag
    # and the filtered Detector Managers (if any).
    outFileName = ""
    if flags.GeoModel.DumpGeo.OutputFileName:
        outFileName = flags.GeoModel.DumpGeo.OutputFileName
    else:
        # Handle the user's inputs and create a file name 
        # for the output SQLite, accordingly
        outFileName = "geometry"
        filterDetManagers = []
        # - Put Geometry TAG into the file name
        # NOTE: at this point, the user-defined Geo TAG args.detDescr, 
        #       if set, has already replaced the default TAG in 'flags';
        #       so, we can use the latter, directy.
        geoTAG = flags.GeoModel.AtlasVersion
        _logger.info("+++ Dumping this Detector Description geometry TAG: '%s'", geoTAG)
        outFileName = outFileName + "-" + geoTAG
        
        if flags.GeoModel.DumpGeo.FilterDetManagers:
            
            _logger.info("+++ Filtering on these GeoModel 'Detector Managers': '%s'", flags.GeoModel.DumpGeo.FilterDetManagers)
 
            filterDetManagers = flags.GeoModel.DumpGeo.FilterDetManagers
            
            # Set the filter variable that is used in the C++ code
            kwargs.setdefault("UserFilterDetManager", filterDetManagers)
            
            # - Put the filtered Detector Managers' names into the file name, 
            #   if the user asked to filter on them
            outFileName = outFileName + "-" + "-".join(filterDetManagers)
 
        # - Add the final extension to the name of the output SQLite file 
        outFileName = outFileName + ".db"
 
    # Set the output file name variable in the C++ code
    kwargs.setdefault("OutSQLiteFileName", outFileName)
 
    # Check if the output SQLite file exists already, 
    # and overwrite it if the user asked to do so; 
    # otherwise, throw an error.
    if os.path.exists(outFileName):
        if flags.GeoModel.DumpGeo.ForceOverwrite:
            print("+ DumpGeo -- NOTE -- You chose to overwrite an existing geometry dump file with the same name, if present.")
            # os.environ["DUMPGEOFORCEOVERWRITE"] = "1" # save to an env var, for later use in GeoModelStandalone/GeoExporter
            # Check if the file exists before attempting to delete it   
            if os.path.exists(outFileName):
                os.remove(outFileName)
                _logger.verbose(f"The file {outFileName} has been deleted.")
            else:
                _logger.verbose(f"The file {outFileName} does not exist. So, it was not needed to 'force-delete' it. Continuing...")
        else:
            _logger.error(f"+++ DumpGeo -- ERROR!! The ouput file '{outFileName}' exists already!\nPlease move or remove it, or use the 'force' option: '-f' or '--forceOverWrite'.\n\n")
            sys.exit()
 
    # Schedule the DumpGeo Athena Algorithm
    the_alg = CompFactory.DumpGeo(name="DumpGeoAlg", **kwargs)
    result.addEventAlgo(the_alg, primary=True)
    return result
 
 

getATLASVersion()

def DumpGeoConfig.getATLASVersion

(

)

Definition at line 117 of file DumpGeoConfig.py.

def getATLASVersion():
    if "AtlasVersion" in os.environ:
        return os.environ["AtlasVersion"]
    if "AtlasBaseVersion" in os.environ:
        return os.environ["AtlasBaseVersion"]
    return "Unknown"
 

Variable Documentation

_logger

DumpGeoConfig._logger = logging.getLogger('DumpGeo')

private

Definition at line 23 of file DumpGeoConfig.py.

action

DumpGeoConfig.action

Definition at line 248 of file DumpGeoConfig.py.

args

DumpGeoConfig.args = flags.fillFromArgs(parser=parser)

Definition at line 253 of file DumpGeoConfig.py.

AtlasVersion

DumpGeoConfig.AtlasVersion

Definition at line 300 of file DumpGeoConfig.py.

cfg

DumpGeoConfig.cfg = MainServicesCfg(flags)

Definition at line 326 of file DumpGeoConfig.py.

debugCAlevel

DumpGeoConfig.debugCAlevel = int(args.debugCA)

Definition at line 335 of file DumpGeoConfig.py.

default

DumpGeoConfig.default

Definition at line 241 of file DumpGeoConfig.py.

dumpgeo_empty_input

bool DumpGeoConfig.dumpgeo_empty_input = False

Definition at line 275 of file DumpGeoConfig.py.

flags

DumpGeoConfig.flags = initConfigFlags()

Definition at line 213 of file DumpGeoConfig.py.

ForceOverwrite

DumpGeoConfig.ForceOverwrite

Definition at line 268 of file DumpGeoConfig.py.

GlobalTag

DumpGeoConfig.GlobalTag

Definition at line 297 of file DumpGeoConfig.py.

help

DumpGeoConfig.help

Definition at line 242 of file DumpGeoConfig.py.

isMC

DumpGeoConfig.isMC

Definition at line 298 of file DumpGeoConfig.py.

keep_beampipe

DumpGeoConfig.keep_beampipe

Definition at line 312 of file DumpGeoConfig.py.

MaxEvents

DumpGeoConfig.MaxEvents

Definition at line 215 of file DumpGeoConfig.py.

MCCampaign

DumpGeoConfig.MCCampaign

Definition at line 299 of file DumpGeoConfig.py.

metavar

DumpGeoConfig.metavar

Definition at line 242 of file DumpGeoConfig.py.

None

DumpGeoConfig.None

Definition at line 311 of file DumpGeoConfig.py.

NumThreads

DumpGeoConfig.NumThreads

Definition at line 228 of file DumpGeoConfig.py.

OutputFileName

DumpGeoConfig.OutputFileName

Definition at line 264 of file DumpGeoConfig.py.

parser

DumpGeoConfig.parser = flags.getArgumentParser(description="Dump the detector geometry to a GeoModel-based SQLite '.db' file.")

Definition at line 238 of file DumpGeoConfig.py.

prog

DumpGeoConfig.prog

Definition at line 239 of file DumpGeoConfig.py.

ProjectName

DumpGeoConfig.ProjectName

Definition at line 291 of file DumpGeoConfig.py.

RunNumbers

DumpGeoConfig.RunNumbers

Definition at line 292 of file DumpGeoConfig.py.

ShowTreetopContent

DumpGeoConfig.ShowTreetopContent

Definition at line 266 of file DumpGeoConfig.py.

TimeStamps

DumpGeoConfig.TimeStamps

Definition at line 293 of file DumpGeoConfig.py.

toggle_geometry

DumpGeoConfig.toggle_geometry

Definition at line 312 of file DumpGeoConfig.py.

True

DumpGeoConfig.True

Definition at line 312 of file DumpGeoConfig.py.

TypedCollections

DumpGeoConfig.TypedCollections

Definition at line 294 of file DumpGeoConfig.py.

use_metadata

DumpGeoConfig.use_metadata

Definition at line 311 of file DumpGeoConfig.py.