gar::geo::AuxDetGeometry Class Reference

The geometry of one entire detector, as served by art. More...

#include <AuxDetGeometry.h>

Public Member Functions
	AuxDetGeometry (fhicl::ParameterSet const &pset, art::ActivityRegistry &reg)
void	preBeginRun (art::Run const &run)
	Updates the geometry if needed at the beginning of each new run. More...
AuxDetGeometryCore const &	GetProvider () const
	Returns a constant reference to the service provider. More...
AuxDetGeometryCore const *	GetProviderPtr () const
	Returns a constant pointer to the service provider. More...

Private Member Functions
void	LoadNewGeometry (std::string gdmlfile, std::string rootfile)
	Expands the provided paths and loads the geometry description(s) More...
void	InitializeChannelMap ()
AuxDetGeometryCore &	GetProvider ()
	Returns a reference to the service provider. More...
AuxDetGeometryCore *	GetProviderPtr ()
	Returns a pointer to the service provider. More...

Private Attributes
AuxDetGeometryCore	fProvider
	the actual service provider More...
std::string	fRelPath
bool	fForceUseFCLOnly
fhicl::ParameterSet	fSortingParameters
	Parameter set to define the channel map sorting. More...

Detailed Description

The geometry of one entire detector, as served by art.

This class extends the interface of the geometry service provider, GeometryCore, to the one of an art service. It handles the correct initialization of the provider using information

It relies on geo::ExptGeoHelperInterface service to obtain the channel mapping algorithm proper for the selected geometry.

The geometry initialization happens immediately on construction. Optionally, the geometry is automatically reinitialized on each run based on the information contained in the art::Run object.

Configuration

In addition to the parameters documented in geo::GeometryCore, the following parameters are supported:

• RelativePath (string, default: no path): this path is prepended to the geometry file names before searching from them; the path string does not affect the file name
• GDML (string, mandatory): path of the GDML file to be served to Geant4 for detector simulation. The full file is composed out of the optional relative path specified by RelativePath path and the base name specified in GDML parameter; this path is searched for in the directories configured in the FW_SEARCH_PATH environment variable;
• ROOT (string, mandatory): currently overridden by GDML parameter, whose value is used instead; this path is assembled in the same way as the one for GDML parameter, except that no alternative (wireless) geometry is used even if DisableWiresInG4 is specified (see below); this file is used to load the geometry used in the internal simulation and reconstruction, basically everywhere except for the Geant4 simulation
• DisableWiresInG4 (boolean, default: false): if true, Geant4 is loaded with an alternative geometry from a file with the standard name as configured with the /GDML/ parameter, but with an additional "_nowires" appended before the ".gdml" suffix
• ForceUseFCLOnly (boolean, default: false): information on the current geometry is stored in each run by the event generator producers; if this information does not describe the current geometry, a new geometry is loaded according to the information in the run. If ForceUseFCLOnly is set to true, this mechanism is disabled and the geometry is just loaded at the beginning of the job from the information in the job configuration, once and for all.
• SortingParameters (a parameter set; default: empty): this configuration is directly passed to the channel mapping algorithm (see geo::ChannelMapAlg); its content is dependent on the chosen implementation of ChannelMapAlg

Note

Currently, the file defined by GDML parameter is also served to ROOT for the internal geometry representation.

Definition at line 96 of file AuxDetGeometry.h.

Constructor & Destructor Documentation

gar::geo::AuxDetGeometry::AuxDetGeometry	(	fhicl::ParameterSet const &	pset,
		art::ActivityRegistry &	reg
	)

Definition at line 30 of file AuxDetGeometry_service.cc.

    : fProvider         (pset)
    , fRelPath          (pset.get< std::string       >("RelativePath",      ""   ))
    , fForceUseFCLOnly  (pset.get< bool              >("ForceUseFCLOnly" ,  false))
    , fSortingParameters(pset.get<fhicl::ParameterSet>("SortingParameters", fhicl::ParameterSet() ))
    {
      // add a final directory separator ("/") to fRelPath if not already there
      if (!fRelPath.empty() && (fRelPath.back() != '/')) fRelPath += '/';
      
      // register a callback to be executed when a new run starts
      reg.sPreBeginRun.watch(this, &AuxDetGeometry::preBeginRun);
      
      //......................................................................
      // 5.15.12 BJR: use the gdml file for both the fGDMLFile and fROOTFile
      // variables as ROOT v5.30.06 is once again able to read in gdml files
      // during batch operation, in this case think of fROOTFile meaning the
      // file used to make the ROOT TGeoManager.  I don't want to remove
      // the separate variables in case ROOT breaks again
      std::string GDMLFileName = pset.get<std::string>("GDML");
      std::string ROOTFileName = pset.get<std::string>("GDML");
      
      // load the geometry
      LoadNewGeometry(GDMLFileName, ROOTFileName);
      
    } // Geometry::Geometry()

Member Function Documentation

AuxDetGeometryCore const& gar::geo::AuxDetGeometry::GetProvider ( ) const

inline

Returns a constant reference to the service provider.

Definition at line 106 of file AuxDetGeometry.h.

{ return fProvider; }

AuxDetGeometryCore& gar::geo::AuxDetGeometry::GetProvider ( )

inlineprivate

Returns a reference to the service provider.

Definition at line 119 of file AuxDetGeometry.h.

{ return fProvider; }

AuxDetGeometryCore const* gar::geo::AuxDetGeometry::GetProviderPtr ( ) const

inline

Returns a constant pointer to the service provider.

Definition at line 109 of file AuxDetGeometry.h.

{ return &GetProvider(); }

AuxDetGeometryCore* gar::geo::AuxDetGeometry::GetProviderPtr ( )

inlineprivate

Returns a pointer to the service provider.

Definition at line 122 of file AuxDetGeometry.h.

{ return &GetProvider(); }

void gar::geo::AuxDetGeometry::InitializeChannelMap ( )

private

Definition at line 85 of file AuxDetGeometry_service.cc.

    {
      // the channel map is responsible of calling the channel map configuration
      // of the geometry
      art::ServiceHandle<geo::AuxDetExptGeoHelperInterface>()->ConfigureAuxDetChannelMapAlg(fSortingParameters,
                                                                                            GetProviderPtr());
      if ( !GetProvider().hasAuxDetChannelMap() ) {
        throw cet::exception("ChannelMapLoadFail") << " failed to load new channel map";
      }
      
    } // Geometry::InitializeChannelMap()

void gar::geo::AuxDetGeometry::LoadNewGeometry ( std::string  gdmlfile, std::string  rootfile  )

private

Expands the provided paths and loads the geometry description(s)

Definition at line 98 of file AuxDetGeometry_service.cc.

    {
      // start with the relative path
      std::string GDMLFileName(fRelPath), ROOTFileName(fRelPath);
      
      // add the base file names
      ROOTFileName.append(gdmlfile); // not rootfile (why?)
      GDMLFileName.append(gdmlfile);
      
      // Search all reasonable locations for the GDML file that contains
      // the detector geometry.
      // cet::search_path constructor decides if initialized value is a path
      // or an environment variable
      cet::search_path sp("FW_SEARCH_PATH");
      
      std::string GDMLfile;
      if( !sp.find_file(GDMLFileName, GDMLfile) ) {
        throw cet::exception("AuxDetGeometry")
        << "cannot find the gdml geometry file:"
        << "\n" << GDMLFileName
        << "\nbail ungracefully.\n";
      }
      
      std::string ROOTfile;
      if( !sp.find_file(ROOTFileName, ROOTfile) ) {
        throw cet::exception("AuxDetGeometry")
        << "cannot find the root geometry file:\n"
        << "\n" << ROOTFileName
        << "\nbail ungracefully.\n";
      }
      
      // initialize the geometry with the files we have found
      GetProvider().LoadGeometryFile(GDMLfile, ROOTfile);
      
      // now update the channel map
      InitializeChannelMap();
      
    } // Geometry::LoadNewGeometry()

void gar::geo::AuxDetGeometry::preBeginRun

(

art::Run const &

run

)

Updates the geometry if needed at the beginning of each new run.

Definition at line 58 of file AuxDetGeometry_service.cc.

    {
      // if we are requested to stick to the configured geometry, do nothing
      if (fForceUseFCLOnly) return;
      
      // check here to see if we need to load a new geometry.
      // get the detector id from the run object
      auto rdcol = run.getMany<sumdata::RunData>();
      if (rdcol.empty()) {
        MF_LOG_WARNING("LoadNewGeometry")
        << "cannot find sumdata::RunData object to grab detector name\n"
        << "this is expected if generating MC files\n"
        << "using default geometry from configuration file\n";
        return;
      }
      
      // if the detector name is still the same, everything is fine
      std::string newDetectorName = rdcol.front()->DetName();
      if (GetProvider().DetectorName() == newDetectorName) return;
      
      LoadNewGeometry(GetProvider().DetectorName() + ".gdml",
                      GetProvider().DetectorName() + ".gdml");
      
    } // Geometry::preBeginRun()

Member Data Documentation

bool gar::geo::AuxDetGeometry::fForceUseFCLOnly

private

Force Geometry to only use the geometry files specified in the fcl file

Definition at line 129 of file AuxDetGeometry.h.

AuxDetGeometryCore gar::geo::AuxDetGeometry::fProvider

private

the actual service provider

Definition at line 125 of file AuxDetGeometry.h.

std::string gar::geo::AuxDetGeometry::fRelPath

private

Relative path added to FW_SEARCH_PATH to search for geometry file

Definition at line 127 of file AuxDetGeometry.h.

fhicl::ParameterSet gar::geo::AuxDetGeometry::fSortingParameters

private

Parameter set to define the channel map sorting.

Definition at line 131 of file AuxDetGeometry.h.

---

The documentation for this class was generated from the following files:

• garsoft/Geometry/AuxDetGeometry.h
• garsoft/Geometry/AuxDetGeometry_service.cc