DumpGeoConfig Namespace Reference

Functions
	configureGeometry (flags, cfg)
	getATLASVersion ()
	dumpGeoOutputFileName (flags)
	resolveDumpGeoGeometryTag (det_descr, configured_tag, fallback_tag)
	validateDumpGeoOutputFile (output_file, force_overwrite)
	zdcGeometryWarning (flags, default_geometry_tags)
	logZDCGeometryWarning (warning, repeated=False)
	DumpGeoCfg (flags, name="DumpGeoAlg", **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
	filesInput
	args = flags.fillFromArgs(parser=parser)
	OutputFileName
	FilterDetManagers
	ShowTreetopContent
	ForceOverwrite
	configured_geometry_tag = None
	geometry_tag
	AtlasVersion
bool	dumpgeo_empty_input = False
	input_metadata = GetFileMD(flags.Input.Files)
	input_geometry_tag = input_metadata.get("GeoAtlas", None)
	ProjectName
	RunNumbers
	TimeStamps
	TypedCollections
	GlobalTag
	isMC
	MCCampaign
	use_metadata
	toggle_geometry
	keep_beampipe
	zdc_warning = zdcGeometryWarning(flags, defaultGeometryTags)
	cfg = MainServicesCfg(flags)
	debugCAlevel = int(args.debugCA)
	status = cfg.run()
	repeated

Function Documentation

configureGeometry()

configureGeometry	(		flags,
			cfg )

Definition at line 28 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 explicitly, 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()

DumpGeoCfg	(		flags,
			name = "DumpGeoAlg",
		**	kwargs )

Definition at line 193 of file DumpGeoConfig.py.

def DumpGeoCfg(flags, name="DumpGeoAlg", **kwargs):
    if _logger.isEnabledFor(logging.DEBUG):
        _logger.debug(
            "Dumping the '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)
 
    # Configure DetectorManager filtering independently of the output file
    # name. In particular, a user-defined file name must not disable the
    # filter passed to the C++ algorithm.
    filterDetManagers = flags.GeoModel.DumpGeo.FilterDetManagers
    if filterDetManagers:
        _logger.info(
            "+++ Filtering on these GeoModel 'Detector Managers': '%s'",
            filterDetManagers,
        )
        kwargs.setdefault("UserFilterDetManager", filterDetManagers)
 
    # Set the name of the output '.db' file.
    configuredOutFileName = dumpGeoOutputFileName(flags)
    if not flags.GeoModel.DumpGeo.OutputFileName:
        _logger.info(
            "+++ Dumping this Detector Description geometry TAG: '%s'",
            flags.GeoModel.AtlasVersion,
        )
 
    # Set the output file name variable in the C++ code
    kwargs.setdefault("OutSQLiteFileName", configuredOutFileName)
 
    # The final algorithm property is authoritative. A caller can override the
    # flag-derived filename through kwargs, so validation and deletion must use
    # the same path that the C++ algorithm will write.
    outFileName = kwargs["OutSQLiteFileName"]
    kwargs.setdefault(
        "ForceOverwrite",
        flags.GeoModel.DumpGeo.ForceOverwrite,
    )
    forceOverwrite = kwargs["ForceOverwrite"]
 
    # Reject an existing file unless overwrite is enabled. Destructive removal
    # is deliberately deferred to DumpGeo::initialize(), immediately before
    # the C++ algorithm opens the output database.
    validateDumpGeoOutputFile(
        outFileName,
        forceOverwrite,
    )
 
    # Schedule the DumpGeo Athena Algorithm
    result = ComponentAccumulator()
    the_alg = CompFactory.DumpGeo(name=name, **kwargs)
    result.addEventAlgo(the_alg, primary=True)
    return result
 
 

dumpGeoOutputFileName()

dumpGeoOutputFileName

(

flags

)

Return the configured DumpGeo SQLite output file name.

Definition at line 128 of file DumpGeoConfig.py.

def dumpGeoOutputFileName(flags):
    """Return the configured DumpGeo SQLite output file name."""
    if flags.GeoModel.DumpGeo.OutputFileName:
        return flags.GeoModel.DumpGeo.OutputFileName
 
    output_file = f"geometry-{flags.GeoModel.AtlasVersion}"
    filter_det_managers = flags.GeoModel.DumpGeo.FilterDetManagers
    if filter_det_managers:
        output_file += "-" + "-".join(filter_det_managers)
 
    return output_file + ".db"
 
 

getATLASVersion()

getATLASVersion

(

)

Definition at line 120 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"
 
 

logZDCGeometryWarning()

logZDCGeometryWarning	(		warning,
			repeated = False )

Log a ZDC geometry warning, optionally as an end-of-run reminder.

Definition at line 184 of file DumpGeoConfig.py.

def logZDCGeometryWarning(warning, repeated=False):
    """Log a ZDC geometry warning, optionally as an end-of-run reminder."""
    if not warning:
        return
    if repeated:
        _logger.warning("Repeating the earlier ZDC geometry warning:")
    _logger.warning(*warning)
 
 

resolveDumpGeoGeometryTag()

resolveDumpGeoGeometryTag	(		det_descr,
			configured_tag,
			fallback_tag )

Resolve the geometry tag using the DumpGeo command-line precedence.

Definition at line 141 of file DumpGeoConfig.py.

def resolveDumpGeoGeometryTag(det_descr, configured_tag, fallback_tag):
    """Resolve the geometry tag using the DumpGeo command-line precedence."""
    if det_descr:
        return det_descr
    if configured_tag:
        return configured_tag
    return fallback_tag
 
 

validateDumpGeoOutputFile()

validateDumpGeoOutputFile	(		output_file,
			force_overwrite )

Reject an existing output file unless overwrite is enabled.

Definition at line 150 of file DumpGeoConfig.py.

def validateDumpGeoOutputFile(output_file, force_overwrite):
    """Reject an existing output file unless overwrite is enabled."""
    if os.path.exists(output_file) and not force_overwrite:
        raise ConfigurationError(
            f"DumpGeo output file '{output_file}' already exists. "
            "Move or remove it, or enable "
            "'GeoModel.DumpGeo.ForceOverwrite' "
            "(or use the '-f' option from the command line)."
        )
 
 

zdcGeometryWarning()

zdcGeometryWarning	(		flags,
			default_geometry_tags )

Return logger arguments for an incompatible ZDC geometry tag.

Definition at line 161 of file DumpGeoConfig.py.

def zdcGeometryWarning(flags, default_geometry_tags):
    """Return logger arguments for an incompatible ZDC geometry tag."""
    if not flags.Detector.GeometryZDC:
        return None
 
    known_zdc_tags = {
        default_geometry_tags.RUN2_ZDC,
        default_geometry_tags.RUN3_ZDC23,
        default_geometry_tags.RUN3_ZDC24,
    }
    if flags.GeoModel.AtlasVersion in known_zdc_tags:
        return None
 
    return (
        "ZDC geometry was enabled with geometry tag '%s', which may "
        "not contain a ZDC GeoDB payload. Consider using "
        "--detDescr=%s or --detDescr=%s for Run 3.",
        flags.GeoModel.AtlasVersion,
        default_geometry_tags.RUN3_ZDC23,
        default_geometry_tags.RUN3_ZDC24,
    )
 
 

Variable Documentation

_logger

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

protected

Definition at line 26 of file DumpGeoConfig.py.

action

DumpGeoConfig.action

Definition at line 311 of file DumpGeoConfig.py.

args

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

Definition at line 318 of file DumpGeoConfig.py.

AtlasVersion

DumpGeoConfig.AtlasVersion

Definition at line 363 of file DumpGeoConfig.py.

cfg

DumpGeoConfig.cfg = MainServicesCfg(flags)

Definition at line 448 of file DumpGeoConfig.py.

configured_geometry_tag

DumpGeoConfig.configured_geometry_tag = None

Definition at line 350 of file DumpGeoConfig.py.

debugCAlevel

DumpGeoConfig.debugCAlevel = int(args.debugCA)

Definition at line 457 of file DumpGeoConfig.py.

default

DumpGeoConfig.default

Definition at line 298 of file DumpGeoConfig.py.

dumpgeo_empty_input

tuple dumpgeo_empty_input = False

Definition at line 381 of file DumpGeoConfig.py.

filesInput

DumpGeoConfig.filesInput

Definition at line 317 of file DumpGeoConfig.py.

FilterDetManagers

DumpGeoConfig.FilterDetManagers

Definition at line 327 of file DumpGeoConfig.py.

flags

DumpGeoConfig.flags = initConfigFlags()

Definition at line 268 of file DumpGeoConfig.py.

ForceOverwrite

DumpGeoConfig.ForceOverwrite

Definition at line 335 of file DumpGeoConfig.py.

geometry_tag

DumpGeoConfig.geometry_tag

Initial value:

=  resolveDumpGeoGeometryTag(
        args.detDescr,
        configured_geometry_tag,
        defaultGeometryTags.RUN3,
    )

Definition at line 353 of file DumpGeoConfig.py.

GlobalTag

DumpGeoConfig.GlobalTag

Definition at line 415 of file DumpGeoConfig.py.

help

DumpGeoConfig.help

Definition at line 299 of file DumpGeoConfig.py.

input_geometry_tag

DumpGeoConfig.input_geometry_tag = input_metadata.get("GeoAtlas", None)

Definition at line 388 of file DumpGeoConfig.py.

input_metadata

DumpGeoConfig.input_metadata = GetFileMD(flags.Input.Files)

Definition at line 387 of file DumpGeoConfig.py.

isMC

DumpGeoConfig.isMC

Definition at line 416 of file DumpGeoConfig.py.

keep_beampipe

DumpGeoConfig.keep_beampipe

Definition at line 432 of file DumpGeoConfig.py.

MaxEvents

DumpGeoConfig.MaxEvents

Definition at line 270 of file DumpGeoConfig.py.

MCCampaign

DumpGeoConfig.MCCampaign

Definition at line 417 of file DumpGeoConfig.py.

metavar

DumpGeoConfig.metavar

Definition at line 304 of file DumpGeoConfig.py.

NumThreads

DumpGeoConfig.NumThreads

Definition at line 283 of file DumpGeoConfig.py.

OutputFileName

DumpGeoConfig.OutputFileName

Definition at line 325 of file DumpGeoConfig.py.

parser

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

Definition at line 293 of file DumpGeoConfig.py.

prog

DumpGeoConfig.prog

Definition at line 294 of file DumpGeoConfig.py.

ProjectName

DumpGeoConfig.ProjectName

Definition at line 409 of file DumpGeoConfig.py.

repeated

DumpGeoConfig.repeated

Definition at line 482 of file DumpGeoConfig.py.

RunNumbers

DumpGeoConfig.RunNumbers

Definition at line 410 of file DumpGeoConfig.py.

ShowTreetopContent

DumpGeoConfig.ShowTreetopContent

Definition at line 333 of file DumpGeoConfig.py.

status

DumpGeoConfig.status = cfg.run()

Definition at line 480 of file DumpGeoConfig.py.

TimeStamps

DumpGeoConfig.TimeStamps

Definition at line 411 of file DumpGeoConfig.py.

toggle_geometry

DumpGeoConfig.toggle_geometry

Definition at line 431 of file DumpGeoConfig.py.

TypedCollections

DumpGeoConfig.TypedCollections

Definition at line 412 of file DumpGeoConfig.py.

use_metadata

DumpGeoConfig.use_metadata

Definition at line 430 of file DumpGeoConfig.py.

zdc_warning

DumpGeoConfig.zdc_warning = zdcGeometryWarning(flags, defaultGeometryTags)

Definition at line 439 of file DumpGeoConfig.py.