#include <PLRDetectorTool.h>

Inheritance diagram for PLRDetectorTool:

Collaboration diagram for PLRDetectorTool:

Public Member Functions
	PLRDetectorTool (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~PLRDetectorTool ()=default
virtual StatusCode	create () override final
virtual StatusCode	clear () override final
virtual GeoVDetectorManager *	manager ()
virtual const GeoVDetectorManager *	manager () const
virtual StatusCode	align () override

Protected Member Functions
bool	isAvailable (const std::string &versionNode, const std::string &tableNode) const
std::string	getBlob (const std::string &versionNode, const std::string &tableNode) const
StatusCode	createBaseTool ()
GeoModelIO::ReadGeoModel *	getSqliteReader () const
const GeoVPhysVol *	createTopVolume (GeoPhysVol worldVol, GmxInterface &interface, const std::string &versionNode, const std::string &tableNode, const std::string &containingDetector="", const std::string &envelopeName="", const GeoModelIO::ReadGeoModel sqlreader=nullptr) const

Protected Attributes
Gaudi::Property< std::string >	m_gmxFilename {this, "GmxFilename", "", "The name of the local file to read the geometry from"}
Gaudi::Property< std::string >	m_detectorName {this, "DetectorName", "ITkStrip", ""}
ServiceHandle< IRDBAccessSvc >	m_rdbAccessSvc {this, "RDBAccessSvc", "RDBAccessSvc", ""}
ServiceHandle< IRDBAccessSvc >	m_sqliteReadSvc {this, "SqliteReadSvc", "SqliteReadSvc", ""}
ServiceHandle< IGeoDbTagSvc >	m_geoDbTagSvc {this, "GeoDbTagSvc", "GeoDbTagSvc", ""}
Gaudi::Property< std::string >	m_dtdName {this, "OverrideDtdName", "", "Override standard .dtd file from GeoModelXml"}
Gaudi::Property< bool >	m_deduplicateLogVol
Gaudi::Property< bool >	m_deduplicatePhysVol
Gaudi::Property< bool >	m_deduplicateShape
Gaudi::Property< bool >	m_deduplicateTransf
GeoVDetectorManager *	m_detector {nullptr}

Private Member Functions
void	doNumerology ()
void	createVolume (GeoPhysVol *worldVol, GmxInterface &interface, const std::string &versionNode, const std::string &tableNode) const

Private Attributes
const InDetDD::PixelDetectorManager *	m_detManager {}
std::unique_ptr< InDetDD::SiCommonItems >	m_commonItems {}
WaferTree	m_moduleTree
Gaudi::Property< std::string >	m_alignmentFolderName {this, "AlignmentFolderName", "/Indet/Align", ""}
Gaudi::Property< std::string >	m_containingDetectorName {this, "ContainingDetector", "", "Containing detector name"}
Gaudi::Property< std::string >	m_envelopeVolumeName {this, "EnvelopeVolume", "ITkPixelDetector", "Envelope volume name"}
Gaudi::Property< std::string >	m_clobOutputFileName {this, "ClobOutputName", "", "Name of file to dump CLOB content to"}

Detailed Description

Definition at line 25 of file PLRDetectorTool.h.

Constructor & Destructor Documentation

◆ PLRDetectorTool()

PLRDetectorTool::PLRDetectorTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 18 of file PLRDetectorTool.cxx.

 : GeoModelXmlTool(type, name, parent)
{
}

◆ ~PLRDetectorTool()

virtual PLRDetectorTool::~PLRDetectorTool ( )

virtualdefault

Member Function Documentation

◆ align()

virtual StatusCode GeoModelTool::align ( )

inlineoverridevirtualinherited

Reimplemented in ALFA_DetectorTool, LArDetectorToolNV, PixelDetectorTool, SCT_DetectorTool, and TRT_DetectorTool.

Definition at line 25 of file GeoModelTool.h.

25{return StatusCode::SUCCESS;}

◆ clear()

StatusCode PLRDetectorTool::clear ( )

finaloverridevirtual

Reimplemented from GeoModelTool.

Definition at line 97 of file PLRDetectorTool.cxx.

{
  SG::DataProxy* proxy = detStore()->proxy(ClassID_traits<InDetDD::PixelDetectorManager>::ID(),m_detManager->getName());
  if (proxy) {
    proxy->reset();
    m_detManager = nullptr;
  }
  return StatusCode::SUCCESS;
 
}

◆ create()

StatusCode PLRDetectorTool::create ( )

finaloverridevirtual

Definition at line 26 of file PLRDetectorTool.cxx.

{
  // retrieve the common stuff
  ATH_CHECK(createBaseTool());
 
  GeoModelExperiment *theExpt = nullptr;
  ATH_CHECK(detStore()->retrieve(theExpt, "ATLAS"));
  const PLR_ID *idHelper = nullptr;
  ATH_CHECK(detStore()->retrieve(idHelper, "PLR_ID"));
 
  m_commonItems = std::make_unique<InDetDD::SiCommonItems>(idHelper);
 
  GeoModelIO::ReadGeoModel* sqlreader = getSqliteReader();
 
  std::string node{"InnerDetector"};
  std::string table{"PLRXDD"};
 
  //
  // Check the availability (if not running from SQLite)
  //
  if(!sqlreader){
      if (!isAvailable(node, table)) {
        ATH_MSG_ERROR("No PLR geometry found. PLR can not be built.");
        return StatusCode::FAILURE;
      }
  }
  //
  // Create the detector manager
  //
  // The * converts a ConstPVLink to a ref to a GeoVPhysVol
  // The & takes the address of the GeoVPhysVol
  GeoPhysVol *world = &*theExpt->getPhysVol();
  auto *manager = new InDetDD::PixelDetectorManager(&*detStore(), m_detectorName, "PLR_ID");
  manager->addFolder(m_alignmentFolderName);
  // Load the geometry, create the volume,
  // node,table are the location in the DB to look for the clob
  // empty strings are the (optional) containing detector and envelope names
  // allowed to pass a null sqlreader ptr - it will be used to steer the source of the geometry
  InDetDD::PLRGmxInterface gmxInterface(manager, m_commonItems.get(), &m_moduleTree);
 
  const GeoVPhysVol * topVol = createTopVolume(world, gmxInterface, node, table, m_containingDetectorName, m_envelopeVolumeName,sqlreader);
 
  // if we are using SQLite inputs,
  if (sqlreader) {
    ATH_MSG_INFO("Building PLR Readout Geometry from SQLite using "<<m_geoDbTagSvc->getParamSvcName());
    gmxInterface.buildReadoutGeometryFromSqlite(m_sqliteReadSvc.operator->(), sqlreader);
  }
 
  if(topVol){
    manager->addTreeTop(topVol);
    manager->initNeighbours();
  } else {
    ATH_MSG_FATAL("Could not find the Top Volume!!!");
    return StatusCode::FAILURE;
  }
 
  // set the manager
  m_detManager = manager;
 
  ATH_CHECK(detStore()->record(m_detManager, m_detManager->getName()));
  theExpt->addManager(m_detManager);
 
  // Create a symLink to the SiDetectorManager base class so it can be accessed as either SiDetectorManager or
  // PixelDetectorManager
  const InDetDD::SiDetectorManager *siDetManager = m_detManager;
  ATH_CHECK(detStore()->symLink(m_detManager, siDetManager));
 
  return StatusCode::SUCCESS;
}

◆ createBaseTool()

StatusCode GeoModelXmlTool::createBaseTool ( )

protectedinherited

Definition at line 26 of file GeoModelXmlTool.cxx.

{
  ATH_CHECK(m_geoDbTagSvc.retrieve());
  ATH_CHECK(m_rdbAccessSvc.retrieve());
  ATH_CHECK(m_sqliteReadSvc.retrieve());
 
  return StatusCode::SUCCESS;
}

◆ createTopVolume()

const GeoVPhysVol * GeoModelXmlTool::createTopVolume	(	GeoPhysVol *	worldVol,
		GmxInterface &	interface,
		const std::string &	versionNode,
		const std::string &	tableNode,
		const std::string &	containingDetector = "",
		const std::string &	envelopeName = "",
		const GeoModelIO::ReadGeoModel *	sqlreader = nullptr ) const

protectedinherited

Definition at line 35 of file GeoModelXmlTool.cxx.

{
  //If we have a valid sqlreader pointer, it means the volume should already exist,
  // so we don't need to create it  
  if(!sqlreader) createVolume(world, gmxInterface, vNode, tableName);
  else ATH_MSG_INFO("Using geometry from .sqlite file for"<<m_detectorName);
 
  unsigned int nChildren = world->getNChildVols();
 
  const GeoVPhysVol * envVol = nullptr;
  const GeoVPhysVol * topVol = nullptr;
 
  bool foundEnvelope = false;
  bool foundContainingDetector = false;
  // find the appropriate volume in the hierarchy, to allow it to be set as the topVolume in
  // our detectorManager
  std::string detectorName = m_detectorName; 
  //if a containingDetector is set, which the detector we are dealing with will sit inside, look for that first. 
  // Otherwise its just the name of the detector we are dealing with we look for
  if(containingDetector!="") detectorName = containingDetector;
 
  for (int iChild = nChildren - 1; iChild>=0; --iChild) {
    if (world->getNameOfChildVol(iChild) == detectorName) {
      // The * converts from a ConstPVLink to a reference to a GeoVPhysVol;
      // the & takes its address.
      envVol = &*world->getChildVol(iChild);
      foundContainingDetector = true;
      if(envelopeName=="") {topVol = envVol;break;}
      unsigned int nGrandchildren = envVol->getNChildVols();    
    for (int iGchild = nGrandchildren - 1; iGchild>=0; --iGchild) {
     if (envVol->getNameOfChildVol(iGchild) == envelopeName) {  
      topVol = &*(envVol->getChildVol(iGchild));
      foundEnvelope = true;
      break;
     }
    }
   }
  }
  if(containingDetector!="" && !foundContainingDetector) ATH_MSG_ERROR("Couldn't find the containing detector "<<containingDetector<<" in the world hierarchy!");
  else if(envelopeName!="" && !foundEnvelope) ATH_MSG_ERROR("Couldn't find the envelope volume "<<envelopeName<<" in the world hierarchy!");
  return topVol;
}

◆ createVolume()

void GeoModelXmlTool::createVolume	(	GeoPhysVol *	worldVol,
		GmxInterface &	interface,
		const std::string &	versionNode,
		const std::string &	tableNode ) const

privateinherited

Definition at line 107 of file GeoModelXmlTool.cxx.

                                                                                                                                          {
  int flags{};
  std::string gmxInput;
 
  if (m_gmxFilename.empty()) {
    ATH_MSG_INFO("Getting " << m_detectorName.value() << " GeoModelXml description from the geometry database");
    flags = 0x1; // Lowest bit ==> string; next bit implies gzip'd but we decided not to gzip
    // how to propagate these to here best...?
    gmxInput = getBlob(vNode,tableName);
    if (gmxInput.empty()) { // Invalid blob?
      std::string errMessage("GeoModelXmlTool::createTopVolume: Empty response received from the database.");
      throw std::runtime_error(errMessage);
    }
  } else {
    flags = 0;
    gmxInput = PathResolver::find_file(m_gmxFilename, "DATAPATH");
    ATH_MSG_INFO("Getting " << m_detectorName.value() << " GeoModelXml description from file "<<gmxInput);
    if (gmxInput.empty()) { // File not found
      std::string errMessage("GeoModelXmlTool::createTopVolume: Unable to find file " + m_gmxFilename +
                             " with PathResolver; check filename and DATAPATH environment variable");
      throw std::runtime_error(errMessage);
    }
  }
 
  // Use the DTD from GeoModel
  if (m_gmxFilename.empty()) {
    std::string replacementName = "GeoModelXml/";
    //now, work out the specific dtd version in the input .gmx
    std::string startdelim = "SYSTEM \"";
    std::string enddelim = "\" [";
    unsigned startpos = gmxInput.find(startdelim) + startdelim.length();
    unsigned endpos = gmxInput.find(enddelim);
    std::string searchName = gmxInput.substr(startpos,(endpos - startpos));
    if(searchName=="geomodel.dtd") replacementName+="geomodel_v0.dtd"; //used in xml for initial geometry tags - special case
    else replacementName+=searchName;
    ATH_MSG_DEBUG("Searching for "<<searchName<<" and replacing it with "<<replacementName);
    size_t chars = searchName.length();
    size_t index = gmxInput.find(searchName);
    if(m_dtdName!="")  replacementName=m_dtdName; //allow overriding of dtd version
    if (index != std::string::npos) {
        std::string dtdFile = PathResolver::find_file(replacementName, "DATAPATH");
        ATH_MSG_DEBUG("dtdFile = " << dtdFile);  
        gmxInput.replace(index,chars, dtdFile);
    } else {  
      throw std::runtime_error("GeoModelXmlTool::createTopVolume: Did not find valid .dtd in the gmx input string.");
    }
  }
 
  // optionally dump to local file for examination
  if (m_clobOutputFileName != "") {
    std::ofstream out(m_clobOutputFileName);
    if (m_gmxFilename.empty()) {
      out << gmxInput;
    } else {
      std::ifstream in(gmxInput);
      out << in.rdbuf();
    }
    out.close();
  }
  gmxInterface.enableLogVolDeDuplication(m_deduplicateLogVol);
  gmxInterface.enablePhysVolDeDuplication(m_deduplicatePhysVol);
  gmxInterface.enableShapeDeDuplication(m_deduplicateShape);
  gmxInterface.enableTransformDeDuplication(m_deduplicateTransf);
 
  Gmx2Geo gmx2Geo(gmxInput, world, gmxInterface, flags);  
}

◆ doNumerology()

void PLRDetectorTool::doNumerology ( )

private

Definition at line 108 of file PLRDetectorTool.cxx.

{
  InDetDD::SiNumerology n;
 
  ATH_MSG_INFO("\n\nPLR Numerology:\n===============\n\nNumber of parts is " << m_moduleTree.nParts());
}

◆ getBlob()

std::string GeoModelXmlTool::getBlob	(	const std::string &	versionNode,
		const std::string &	tableNode ) const

protectedinherited

Definition at line 94 of file GeoModelXmlTool.cxx.

{
  DecodeVersionKey versionKey(&*m_geoDbTagSvc, vNode);
  const IRDBRecordset_ptr recordSet = m_rdbAccessSvc->getRecordsetPtr(tableName, versionKey.tag(), versionKey.node());
  if (!recordSet || recordSet->size() == 0) {
    ATH_MSG_FATAL("Unable to obtain " << vNode << " recordSet");
    throw std::runtime_error("Unable to obtain recordSet");
  }
  const IRDBRecord *record = (*recordSet)[0];
  std::string clobString = record->getString("XMLCLOB");
  return clobString;
}

◆ getSqliteReader()

GeoModelIO::ReadGeoModel * GeoModelXmlTool::getSqliteReader ( ) const

protectedinherited

Definition at line 174 of file GeoModelXmlTool.cxx.

                                                              {
  return m_geoDbTagSvc->getSqliteReader();
}

◆ isAvailable()

bool GeoModelXmlTool::isAvailable	(	const std::string &	versionNode,
		const std::string &	tableNode ) const

protectedinherited

Definition at line 78 of file GeoModelXmlTool.cxx.

{
  if (m_gmxFilename.empty()) {
    DecodeVersionKey versionKey(&*m_geoDbTagSvc, vNode);
    const std::string& versionTag  = versionKey.tag();
    const std::string& versionNode = versionKey.node();
    const std::string version = m_rdbAccessSvc->getChildTag(tableName, versionTag, versionNode);
    if (version.empty()) {
      return false;
    }
    ATH_MSG_INFO("Using " << version << " from " << versionNode << " tag " << versionTag);
  }
 
  return true;
}

◆ manager() [1/2]

virtual GeoVDetectorManager * GeoModelTool::manager ( )

inlinevirtualinherited

Definition at line 21 of file GeoModelTool.h.

21{return m_detector;}

GeoModelTool::m_detector

GeoVDetectorManager * m_detector

Definition GeoModelTool.h:28

◆ manager() [2/2]

virtual const GeoVDetectorManager * GeoModelTool::manager ( ) const

inlinevirtualinherited

Definition at line 22 of file GeoModelTool.h.

22{return m_detector;}

Member Data Documentation

◆ m_alignmentFolderName

Gaudi::Property<std::string> PLRDetectorTool::m_alignmentFolderName {this, "AlignmentFolderName", "/Indet/Align", ""}

private

Definition at line 39 of file PLRDetectorTool.h.

39{this, "AlignmentFolderName", "/Indet/Align", ""};

◆ m_clobOutputFileName

Gaudi::Property<std::string> GeoModelXmlTool::m_clobOutputFileName {this, "ClobOutputName", "", "Name of file to dump CLOB content to"}

privateinherited

Definition at line 60 of file GeoModelXmlTool.h.

60{this, "ClobOutputName", "", "Name of file to dump CLOB content to"};

◆ m_commonItems

std::unique_ptr<InDetDD::SiCommonItems> PLRDetectorTool::m_commonItems {}

private

Definition at line 35 of file PLRDetectorTool.h.

35{};

◆ m_containingDetectorName

Gaudi::Property<std::string> PLRDetectorTool::m_containingDetectorName {this, "ContainingDetector", "", "Containing detector name"}

private

Definition at line 43 of file PLRDetectorTool.h.

43{this, "ContainingDetector", "", "Containing detector name"};

◆ m_deduplicateLogVol

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicateLogVol

protectedinherited

Initial value:

{this, "enableLogVolDeduplication", false,

"Remove duplications of equivalent logical volumes"}

Definition at line 48 of file GeoModelXmlTool.h.

48 {this, "enableLogVolDeduplication", false,

49 "Remove duplications of equivalent logical volumes"};

◆ m_deduplicatePhysVol

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicatePhysVol

protectedinherited

Initial value:

{this, "enablePhysVolDeduplication", false,

"Remove duplications of equivalent physical volumes"}

Definition at line 50 of file GeoModelXmlTool.h.

50 {this, "enablePhysVolDeduplication", false,

51 "Remove duplications of equivalent physical volumes"};

◆ m_deduplicateShape

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicateShape

protectedinherited

Initial value:

{this, "enableShapeDeduplication", false,

"Remove duplications of equivalent shapes"}

Definition at line 52 of file GeoModelXmlTool.h.

52 {this, "enableShapeDeduplication", false,

53 "Remove duplications of equivalent shapes"};

◆ m_deduplicateTransf

Gaudi::Property<bool> GeoModelXmlTool::m_deduplicateTransf

protectedinherited

Initial value:

{this, "enableTransDeduplication", false,

"Remove duplications of equivalent transform nodes"}

Definition at line 54 of file GeoModelXmlTool.h.

54 {this, "enableTransDeduplication", false,

55 "Remove duplications of equivalent transform nodes"};

◆ m_detector

GeoVDetectorManager* GeoModelTool::m_detector {nullptr}

protectedinherited

Definition at line 28 of file GeoModelTool.h.

28{nullptr};

◆ m_detectorName

Gaudi::Property<std::string> GeoModelXmlTool::m_detectorName {this, "DetectorName", "ITkStrip", ""}

protectedinherited

Definition at line 42 of file GeoModelXmlTool.h.

42{this, "DetectorName", "ITkStrip", ""};

◆ m_detManager

const InDetDD::PixelDetectorManager* PLRDetectorTool::m_detManager {}

private

Definition at line 34 of file PLRDetectorTool.h.

34{};

◆ m_dtdName

Gaudi::Property<std::string> GeoModelXmlTool::m_dtdName {this, "OverrideDtdName", "", "Override standard .dtd file from GeoModelXml"}

protectedinherited

Definition at line 46 of file GeoModelXmlTool.h.

46{this, "OverrideDtdName", "", "Override standard .dtd file from GeoModelXml"};

◆ m_envelopeVolumeName

Gaudi::Property<std::string> PLRDetectorTool::m_envelopeVolumeName {this, "EnvelopeVolume", "ITkPixelDetector", "Envelope volume name"}

private

Definition at line 44 of file PLRDetectorTool.h.

44{this, "EnvelopeVolume", "ITkPixelDetector", "Envelope volume name"};

◆ m_geoDbTagSvc

ServiceHandle<IGeoDbTagSvc> GeoModelXmlTool::m_geoDbTagSvc {this, "GeoDbTagSvc", "GeoDbTagSvc", ""}

protectedinherited

Definition at line 45 of file GeoModelXmlTool.h.

45{this, "GeoDbTagSvc", "GeoDbTagSvc", ""};

◆ m_gmxFilename

Gaudi::Property<std::string> GeoModelXmlTool::m_gmxFilename {this, "GmxFilename", "", "The name of the local file to read the geometry from"}

protectedinherited

Definition at line 41 of file GeoModelXmlTool.h.

41{this, "GmxFilename", "", "The name of the local file to read the geometry from"};

◆ m_moduleTree

WaferTree PLRDetectorTool::m_moduleTree

private

Definition at line 36 of file PLRDetectorTool.h.

◆ m_rdbAccessSvc

ServiceHandle<IRDBAccessSvc> GeoModelXmlTool::m_rdbAccessSvc {this, "RDBAccessSvc", "RDBAccessSvc", ""}

protectedinherited

Definition at line 43 of file GeoModelXmlTool.h.

43{this, "RDBAccessSvc", "RDBAccessSvc", ""};

◆ m_sqliteReadSvc

ServiceHandle<IRDBAccessSvc> GeoModelXmlTool::m_sqliteReadSvc {this, "SqliteReadSvc", "SqliteReadSvc", ""}

protectedinherited

Definition at line 44 of file GeoModelXmlTool.h.

44{this, "SqliteReadSvc", "SqliteReadSvc", ""};

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PLRDetectorTool()

◆ ~PLRDetectorTool()

Member Function Documentation

◆ align()

◆ clear()

◆ create()

◆ createBaseTool()

◆ createTopVolume()

◆ createVolume()

◆ doNumerology()

◆ getBlob()

◆ getSqliteReader()

◆ isAvailable()

◆ manager() [1/2]

◆ manager() [2/2]

Member Data Documentation

◆ m_alignmentFolderName

◆ m_clobOutputFileName

◆ m_commonItems

◆ m_containingDetectorName

◆ m_deduplicateLogVol

◆ m_deduplicatePhysVol

◆ m_deduplicateShape

◆ m_deduplicateTransf

◆ m_detector

◆ m_detectorName

◆ m_detManager

◆ m_dtdName

◆ m_envelopeVolumeName

◆ m_geoDbTagSvc

◆ m_gmxFilename

◆ m_moduleTree

◆ m_rdbAccessSvc

◆ m_sqliteReadSvc