DetectorImp.cpp

Go to the documentation of this file.

//==========================================================================
//  AIDA Detector description implementation 
//--------------------------------------------------------------------------
// Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
// All rights reserved.
//
// For the licensing terms see $DD4hepINSTALL/LICENSE.
// For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
//
// Author     : M.Frank
//
//==========================================================================
 
#define DD4HEP_MUST_USE_DETECTORIMP_H 1
 
// Framework include files
#include <DD4hep/Plugins.h>
#include <DD4hep/Printout.h>
#include <DD4hep/GeoHandler.h>
#include <DD4hep/DetectorHelper.h>
#include <DD4hep/DetectorTools.h>
 
#include <DD4hep/InstanceCount.h>
#include <DD4hep/detail/ObjectsInterna.h>
#include <DD4hep/detail/DetectorInterna.h>
#include <DD4hep/detail/VolumeManagerInterna.h>
#include <DD4hep/detail/OpticalSurfaceManagerInterna.h>
#include <DD4hep/DetectorImp.h>
#include <DD4hep/DD4hepUnits.h>
 
// C/C++ include files
#include <iostream>
#include <stdexcept>
#include <cerrno>
#include <cstdlib>
#include <mutex>
 
// ROOT inlcude files
#include <TGeoSystemOfUnits.h>
#include <TGeoCompositeShape.h>
#include <TGeoBoolNode.h>
#include <TGeoManager.h>
#include <TGeoMatrix.h>
#include <TGeoVolume.h>
#include <TGeoShape.h>
#include <TClass.h>
 
#include <XML/DocumentHandler.h>
 
#ifndef __TIXML__
#include <xercesc/dom/DOMException.hpp>
namespace dd4hep {
  namespace xml {
    typedef xercesc::DOMException XmlException;
  }
}
#endif
 
using namespace dd4hep;
 
ClassImp(DetectorImp)
 
namespace {
 
  std::recursive_mutex  s_detector_apply_lock;
 
  struct Instances  {
    std::recursive_mutex  lock;
    std::map<std::string, Detector*> detectors;
    Detector* get(const std::string& name)   {
      const auto i = detectors.find(name);
      return i == detectors.end() ? nullptr : (*i).second;
    }
    void insert(const std::string& name, Detector* detector)   {
      const auto [_, emplaced] = detectors.emplace(name,detector);
      if ( !emplaced )   {
        except("DD4hep","Cannot insert detector instance %s [Already present]",name.c_str());
      }
    }
    Detector* remove(const std::string& name)   {
      const auto it = detectors.find(name);
      if ( it == detectors.end() )
        return nullptr;
      Detector* det = it->second;
      detectors.erase(it);
      return det;
    }
  };
  
  class DetectorGuard  final  {
  protected:
    static std::pair<std::recursive_mutex, std::map<DetectorImp*, TGeoManager*> >& detector_lock()   {
      static std::pair<std::recursive_mutex, std::map<DetectorImp*, TGeoManager*> > s_inst;
      return s_inst;
    }
    DetectorImp* detector {nullptr};
  public:
    DetectorGuard(DetectorImp* imp) : detector(imp) {}
    void lock(TGeoManager* mgr)   const  {
      auto& lock = detector_lock();
      lock.first.lock();
      lock.second[detector] = mgr;
    }
    TGeoManager* unlock()  const  {
      TGeoManager* mgr = nullptr;
      auto& lock = detector_lock();
      auto i = lock.second.find(detector);
      if ( i != lock.second.end() )   {
        mgr = (*i).second;
        lock.second.erase(i);
      }
      lock.first.unlock();
      return mgr;
    }
  };
  
  Instances& detector_instances()    {
    static Instances s_inst;
    return s_inst;
  }
}
 
std::string dd4hep::versionString(){
  char vsn[32];
  std::snprintf(vsn, sizeof(vsn), "v%2.2d-%2.2d", DD4HEP_MAJOR_VERSION, DD4HEP_MINOR_VERSION);
  return { vsn };
}
 
std::unique_ptr<Detector> Detector::make_unique(const std::string& name)   {
  return std::unique_ptr<Detector>(new DetectorImp(name));
}
 
Detector& Detector::getInstance(const std::string& name)   {
  std::lock_guard<std::recursive_mutex> lock(detector_instances().lock);
  Detector* description = detector_instances().get(name);
  if ( !description )   {
    gGeoManager = nullptr;
    description = new DetectorImp(name);
    detector_instances().insert(name,description);
  }
  return *description;
}
 
void Detector::destroyInstance(const std::string& name) {
  std::lock_guard<std::recursive_mutex> lock(detector_instances().lock);
  Detector* description = detector_instances().remove(name);
  delete description;
}
 
DetectorImp::DetectorImp()
  : TNamed(), DetectorData(), DetectorLoad(this), m_buildType(BUILD_NONE)
{
  m_surfaceManager = new detail::OpticalSurfaceManagerObject(*this);
  m_std_conditions.convention  = STD_Conditions::NTP;
  m_std_conditions.pressure    = Pressure_NTP;
  m_std_conditions.temperature = Temperature_NTP;
}
 
DetectorImp::DetectorImp(const std::string& name)
  : TNamed(), DetectorData(), DetectorLoad(this), m_buildType(BUILD_NONE)
{
#if defined(DD4HEP_USE_GEANT4_UNITS)
  printout(INFO,"DD4hep","++ Using globally Geant4 unit system (mm,ns,MeV)");
  if ( TGeoManager::GetDefaultUnits() != TGeoManager::kG4Units )  {
    TGeoManager::LockDefaultUnits(kFALSE);
    TGeoManager::SetDefaultUnits(TGeoManager::kG4Units);
    TGeoManager::LockDefaultUnits(kTRUE);
  }
#else
  if ( TGeoManager::GetDefaultUnits() != TGeoManager::kRootUnits )  {
    TGeoManager::LockDefaultUnits(kFALSE);
    TGeoManager::SetDefaultUnits(TGeoManager::kRootUnits);
    TGeoManager::LockDefaultUnits(kTRUE);
  }
#endif
 
  SetName(name.c_str());
  SetTitle("DD4hep detector description object");
  //DetectorGuard(this).lock(gGeoManager);
  gGeoManager = nullptr;
  InstanceCount::increment(this);
  m_manager = new TGeoManager(name.c_str(), "Detector Geometry");
  {
    m_manager->AddNavigator();
    m_manager->SetCurrentNavigator(0);
    gGeoManager = m_manager;
#if 1 //FIXME: eventually this should be set to 1 - needs fixes in examples ...
    TGeoElementTable* table = m_manager->GetElementTable();
    table->TGeoElementTable::~TGeoElementTable();
    new(table) TGeoElementTable();
    // This will initialize the table without filling:
    table->AddElement("VACUUM","VACUUM", 1, 1, 1e-15);
#endif
  }
  if ( !gGeoIdentity )
  {
    gGeoIdentity = new TGeoIdentity();
  }
  m_surfaceManager = new detail::OpticalSurfaceManagerObject(*this);
  m_std_conditions.convention  = STD_Conditions::NTP;
  m_std_conditions.pressure    = Pressure_NTP;
  m_std_conditions.temperature = Temperature_NTP;
  
  VisAttr attr("invisible");
  attr.setColor(1.0, 0.5, 0.5, 0.5);
  attr.setLineStyle(VisAttr::SOLID);
  attr.setDrawingStyle(VisAttr::SOLID);
  attr.setVisible(false);
  attr.setShowDaughters(true);
  addVisAttribute(attr);
  m_invisibleVis = attr;
}
 
DetectorImp::~DetectorImp() {
  DetectorGuard(this).lock(gGeoManager);
  if ( m_manager )  {
    std::lock_guard<std::recursive_mutex> lock(detector_instances().lock);
    if ( m_manager == gGeoManager ) gGeoManager = nullptr;
    Detector* description = detector_instances().get(GetName());
    if ( description )   {
      detector_instances().remove(m_manager->GetName());
    }
  }
  delete m_surfaceManager;
  m_surfaceManager = nullptr;
  destroyData(false);
  m_extensions.clear();
  m_detectorTypes.clear();
  InstanceCount::decrement(this);
  DetectorGuard(this).unlock();
}
 
Int_t DetectorImp::saveObject(const char *name, Int_t option, Int_t bufsize) const   {
  Int_t nbytes = 0;
  try  {
    DetectorData::patchRootStreamer(TGeoVolume::Class());
    DetectorData::patchRootStreamer(TGeoNode::Class());
    nbytes = TNamed::Write(name, option, bufsize);
    DetectorData::unpatchRootStreamer(TGeoVolume::Class());
    DetectorData::unpatchRootStreamer(TGeoNode::Class());
    return nbytes;
  }
  catch (const std::exception& e) {
    DetectorData::unpatchRootStreamer(TGeoVolume::Class());
    DetectorData::unpatchRootStreamer(TGeoNode::Class());
    except("Detector","Exception %s while saving dd4hep::Detector object", e.what());
  }
  catch (...) {
    DetectorData::unpatchRootStreamer(TGeoVolume::Class());
    DetectorData::unpatchRootStreamer(TGeoNode::Class());
    except("Detector","UNKNOWN exception while saving dd4hep::Detector object.");
  }
  return nbytes;
}
 
// Load volume manager
void DetectorImp::imp_loadVolumeManager()   {
  detail::destroyHandle(m_volManager);
  m_volManager = VolumeManager(*this, "World", world(), Readout(), VolumeManager::TREE);
}
 
void* DetectorImp::addUserExtension(unsigned long long int key, ExtensionEntry* entry) {
  return m_extensions.addExtension(key,entry);
}
 
void* DetectorImp::removeUserExtension(unsigned long long int key, bool destroy)  {
  return m_extensions.removeExtension(key,destroy);
}
 
void* DetectorImp::userExtension(unsigned long long int key, bool alert) const {
  return m_extensions.extension(key,alert);
}
 
DetectorBuildType DetectorImp::buildType() const {
  std::lock_guard<std::recursive_mutex> lock(s_detector_apply_lock);
  DetectorBuildType temp = m_buildType;
  return temp;
}
 
void DetectorImp::declareParent(const std::string& detector_name, const DetElement& parent)  {
  if ( !detector_name.empty() )  {
    if ( parent.isValid() )  {
      auto i = m_detectorParents.find(detector_name);
      if (i == m_detectorParents.end())   {
        Volume parent_volume = parent.placement().volume();
        if ( parent_volume.isValid() )   {
          m_detectorParents.emplace(detector_name,parent);
          return;
        }
        except("DD4hep","+++ Failed to access valid parent volume of %s from %s",
               detector_name.c_str(), parent.name());
      }
      except("DD4hep",
             "+++ A parent to the detector %s was already registered.",
             detector_name.c_str());
    }
    except("DD4hep",
           "+++ Attempt to register invalid parent for detector: %s [Invalid-Handle].",
           detector_name.c_str());
  }
  except("DD4hep",
         "+++ Attempt to register parent to invalid detector [Invalid-detector-name].");
}
 
Volume DetectorImp::pickMotherVolume(const DetElement& de) const {
  if ( !de.isValid() )   {
    except("DD4hep","Detector: Attempt to access mother volume of invalid detector [Invalid-handle]");
    return nullptr;
  }
  std::string de_name = de.name();
  auto i = m_detectorParents.find(de_name);
  if (i == m_detectorParents.end())   {
    if ( m_worldVol.isValid() )  {
      return m_worldVol;
    }
    except("DD4hep",
           "+++ The world volume is not (yet) valid. "
           "Are you correctly building the detector %s?",
           de.name());
  }
  if ( (*i).second.isValid() )  {
    Volume vol = (*i).second.volume();
    if ( vol.isValid() )  {
      return vol;
    }
  }
  except("DD4hep",
         "+++ The mother volume of %s is not valid. "
         "Are you correctly building detectors?",
         de.name());
  return nullptr;
}
 
const STD_Conditions& DetectorImp::stdConditions()   const   {
  if ( (m_std_conditions.convention&STD_Conditions::USER_SET) == 0 &&
       (m_std_conditions.convention&STD_Conditions::USER_NOTIFIED) == 0 )
  {
    printout(WARNING,"DD4hep","++ STD conditions NOT defined by client. NTP defaults taken.");
    m_std_conditions.convention |= STD_Conditions::USER_NOTIFIED;
  }
  return m_std_conditions;
}
void DetectorImp::setStdConditions(double temp, double pressure)  {
  m_std_conditions.temperature = temp;
  m_std_conditions.pressure = pressure;
  m_std_conditions.convention = STD_Conditions::USER_SET;
  if      ( std::abs(temp-Temperature_NTP) < 1e-10 && std::abs(pressure-Pressure_NTP) < 1e-10 )
    m_std_conditions.convention |= STD_Conditions::NTP;
  else if ( std::abs(temp-Temperature_STP) < 1e-10 && std::abs(pressure-Pressure_STP) < 1e-10 )
    m_std_conditions.convention |= STD_Conditions::STP;
  else
    m_std_conditions.convention |= STD_Conditions::USER;
}
 
void DetectorImp::setStdConditions(const std::string& type)   {
  if ( type == "STP" )   {
    m_std_conditions.temperature = Temperature_STP;
    m_std_conditions.pressure    = Pressure_STP;
    m_std_conditions.convention  = STD_Conditions::STP|STD_Conditions::USER_SET;
  }
  else if ( type == "NTP" )   {
    m_std_conditions.temperature = Temperature_NTP;
    m_std_conditions.pressure    = Pressure_NTP;
    m_std_conditions.convention  = STD_Conditions::NTP|STD_Conditions::USER_SET;
  }
  else   {
    except("DD4hep",
           "++ Attempt to set standard conditions to "
           "unknown conventions (Only STP and NTP allowed).");
  }
}
 
DetElement DetectorImp::detector(const std::string& name) const  {
  HandleMap::const_iterator i = m_detectors.find(name);
  if (i != m_detectors.end()) {
    return (*i).second;
  }
  DetElement de = detail::tools::findElement(*this,name);
  return de;
}
 
Detector& DetectorImp::addDetector(const Handle<NamedObject>& ref_det) {
  DetElement     det_element(ref_det);
  DetectorHelper helper(this);
  DetElement     existing_det = helper.detectorByID(det_element.id());
 
  if ( existing_det.isValid() )   {
    SensitiveDetector sd = helper.sensitiveDetector(existing_det);
    if ( sd.isValid() )   {
      std::stringstream str;
      str << "Detector: The sensitive sub-detectors " << det_element.name() << " and "
          << existing_det.name() << " have the identical ID:" << det_element.id() << ".";
      except("DD4hep",str.str());
    }
  }
  m_detectors.append(ref_det);
  det_element->flag |= DetElement::Object::IS_TOP_LEVEL_DETECTOR;
  PlacedVolume pv = det_element.placement();
  if ( !pv.isValid() )   {
    std::stringstream str;
    str << "Detector: Adding subdetectors with no valid placement is not allowed: "
        << det_element.name() << " ID:" << det_element.id() << ".";
    except("DD4hep",str.str());
  }
  Volume volume = pv->GetMotherVolume();
  if ( volume == m_worldVol )  {
    printout(DEBUG,"DD4hep","+++ Detector: Added detector %s to the world instance.",
             det_element.name());
    m_world.add(det_element);
    return *this;
  }
  auto ipar = m_detectorParents.find(det_element.name());
  if (ipar != m_detectorParents.end())   {
    DetElement parent = (*ipar).second;
    parent.add(det_element);
    printout(DEBUG,"DD4hep","+++ Detector: Added detector %s to parent %s.",
             det_element.name(), parent.name());
    return *this;
  }
 
  // The detector's placement must be one of the existing detectors
  for(HandleMap::iterator idet = m_detectors.begin(); idet != m_detectors.end(); ++idet)  {
    DetElement parent((*idet).second);
    Volume     vol = parent.placement().volume();
    if ( vol == volume )  {
      printout(INFO,"DD4hep","+++ Detector: Added detector %s to the parent:%s.",
               det_element.name(),parent.name());
      parent.add(det_element);
      return *this;
    }
  }
  except("DD4hep","+++ Detector: The detector %s has no known parent.", det_element.name());
  throw std::runtime_error("Detector-Error"); // Never called....
}
 
Detector& DetectorImp::addConstant(const Handle<NamedObject>& x) {
  if ( strcmp(x.name(),"Detector_InhibitConstants") == 0 )   {
    const char* title = x->GetTitle();
    char c = ::toupper(title[0]);
    m_inhibitConstants = (c=='Y' || c=='T' || c=='1');
  }
  m_define.append(x, false);
  return *this;
}
 
Constant DetectorImp::constant(const std::string& name) const {
  if ( !m_inhibitConstants )   {
    return getRefChild(m_define, name);
  }
  throw std::runtime_error("Detector:constant("+name+"): Access to global constants is inhibited.");
}
 
std::string DetectorImp::constantAsString(const std::string& name) const {
  if ( !m_inhibitConstants )   {
    Handle<NamedObject> c = constant(name);
    if (c.isValid())
      return c->GetTitle();
    throw std::runtime_error("Detector:constantAsString: The constant " + name + " is not known to the system.");
  }
  throw std::runtime_error("Detector:constantAsString("+name+"):: Access to global constants is inhibited.");
}
 
long DetectorImp::constantAsLong(const std::string& name) const {
  if ( !m_inhibitConstants )   {
    return _toLong(constantAsString(name));
  }
  throw std::runtime_error("Detector:constantAsLong("+name+"): Access to global constants is inhibited.");
}
 
double DetectorImp::constantAsDouble(const std::string& name) const {
  if ( !m_inhibitConstants )   {
    return _toDouble(constantAsString(name));
  }
  throw std::runtime_error("Detector:constantAsDouble("+name+"): Access to global constants is inhibited.");
}
 
Detector& DetectorImp::addField(const Handle<NamedObject>& x) {
  m_field.add(x);
  m_fields.append(x);
  return *this;
}
 
Material DetectorImp::material(const std::string& name) const {
  TGeoMedium* mat = m_manager->GetMedium(name.c_str());
  if (mat) {
    return Material(mat);
  }
  throw std::runtime_error("Cannot find a material referenced by name:" + name);
}
 
void DetectorImp::mapDetectorTypes()  {
  m_detectorTypes[""] = {};
  for( const auto& i : m_detectors )   {
    DetElement det(i.second);
    if ( det.parent().isValid() )  { // Exclude 'world'
      HandleMap::const_iterator j=m_sensitive.find(det.name());
      if ( j != m_sensitive.end() )  {
        SensitiveDetector sd((*j).second);
        m_detectorTypes[sd.type()].emplace_back(det);
      }
      else if ( det.type() == "compound" )  {
        m_detectorTypes[det.type()].emplace_back(det);      
      }
      else  {
        m_detectorTypes["passive"].emplace_back(det);      
      }
    }
  }
}
 
std::vector<std::string> DetectorImp::detectorTypes() const  {
  if ( m_manager->IsClosed() ) {
    std::vector<std::string> v;
    v.reserve(m_detectorTypes.size());
    for(const auto& t : m_detectorTypes )
      v.emplace_back(t.first);
    return v;
  }
  throw std::runtime_error("detectorTypes: Call only available once the geometry is closed!");
}
 
const std::vector<DetElement>& DetectorImp::detectors(const std::string& type, bool throw_exc) const {
  if ( m_manager->IsClosed() ) {
    DetectorTypeMap::const_iterator i=m_detectorTypes.find(type);
    if ( i != m_detectorTypes.end() ) return (*i).second;
    if ( throw_exc )  {
      throw std::runtime_error("detectors("+type+"): Detectors of this type do not exist in the current setup!");
    }
    // return empty vector instead of exception
    return m_detectorTypes.at("") ;
  }
  throw std::runtime_error("detectors("+type+"): Detectors can only selected by type once the geometry is closed!");
}
 
std::vector<DetElement> DetectorImp::detectors(unsigned int includeFlag, unsigned int excludeFlag ) const  {
  if( ! m_manager->IsClosed() ) {
    throw std::runtime_error("detectors(typeFlag): Detectors can only selected by typeFlag once the geometry is closed!");
  }
  std::vector<DetElement> dets ;
  dets.reserve( m_detectors.size() ) ;
  
  for(HandleMap::const_iterator i=m_detectors.begin(); i!=m_detectors.end(); ++i)   {
    DetElement det((*i).second);
    if ( det.parent().isValid() )  { // Exclude 'world'
      
      //fixme: what to do with compounds - add their daughters  ?
      // ...
 
      if( ( det.typeFlag() &  includeFlag ) == includeFlag &&
          ( det.typeFlag() &  excludeFlag ) ==  0 )
        dets.emplace_back( det ) ;
    }
  }
  return dets ;
}
 
std::vector<DetElement> DetectorImp::detectors(const std::string& type1,
                                               const std::string& type2,
                                               const std::string& type3,
                                               const std::string& type4,
                                               const std::string& type5 )  {
  if ( m_manager->IsClosed() ) {
    std::vector<DetElement> v;
    DetectorTypeMap::const_iterator i, end=m_detectorTypes.end();
    if ( !type1.empty() && (i=m_detectorTypes.find(type1)) != end )
      v.insert(v.end(),(*i).second.begin(),(*i).second.end());
    if ( !type2.empty() && (i=m_detectorTypes.find(type2)) != end )
      v.insert(v.end(),(*i).second.begin(),(*i).second.end());
    if ( !type3.empty() && (i=m_detectorTypes.find(type3)) != end )
      v.insert(v.end(),(*i).second.begin(),(*i).second.end());
    if ( !type4.empty() && (i=m_detectorTypes.find(type4)) != end )
      v.insert(v.end(),(*i).second.begin(),(*i).second.end());
    if ( !type5.empty() && (i=m_detectorTypes.find(type5)) != end ) 
      v.insert(v.end(),(*i).second.begin(),(*i).second.end());
    return v;
  }
  throw std::runtime_error("detectors("+type1+","+type2+",...): Detectors can only selected by type once the geometry is closed!");
}
 
Handle<NamedObject> DetectorImp::getRefChild(const HandleMap& e, const std::string& name, bool do_throw) const {
  HandleMap::const_iterator it = e.find(name);
  if (it != e.end()) {
    return it->second;
  }
  if (do_throw) {
    union ptr {
      const ObjectHandleMap* omap;
      const char* c;
      const void* other;
      ptr(const void* p) { other = p; }
    };
    std::string nam = "";
    ptr mptr(&e), ref(this);
    if ( ref.c > mptr.c && mptr.c < ref.c+sizeof(*this) )  {
      nam = mptr.omap->name;
    }
    std::stringstream err;
    err << "getRefChild: Failed to find child with name: " << name
        << " Map " << nam << " contains " << e.size() << " elements";
    if ( std::getenv("DD4HEP_LIST_CHILDREN") )  {
      err << ": {";
      for (it = e.begin(); it != e.end(); ++it) {
        if (it != e.begin()) {
          err << ", ";
        }
        err << it->first;
      }
      err << "}";
    }
    else  {
      err << ". Set the environment variable DD4HEP_LIST_CHILDREN to list them.";
    }
    throw std::runtime_error(err.str());
  }
  return nullptr;
}
 
namespace {
  struct ShapePatcher: public detail::GeoScan {
    VolumeManager m_volManager;
    DetElement m_world;
    ShapePatcher(VolumeManager m, DetElement e)
      : detail::GeoScan(e), m_volManager(m), m_world(e) {
    }
    void patchShapes() {
      auto&  data = *m_data;
      char   text[32];
      std::string nam;
      printout(INFO,"Detector","+++ Patching names of anonymous shapes....");
      for (auto i = data.rbegin(); i != data.rend(); ++i) {
        for( const TGeoNode* n : (*i).second )  {
          TGeoVolume* vol = n->GetVolume();
          TGeoShape*  s   = vol->GetShape();
          const char* sn  = s->GetName();
          ::snprintf(text,sizeof(text),"_shape_%p",(void*)s);
          if ( !sn || 0 == ::strlen(sn)) {
            nam = vol->GetName();
            nam += text;
            s->SetName(nam.c_str());
          }
          else if (0 == ::strcmp(sn, s->IsA()->GetName())) {
            nam = vol->GetName();
            nam += text;
            s->SetName(nam.c_str());
          }
          else {
            nam = sn;
            if (nam.find("_shape") == std::string::npos)
              nam += text;
            s->SetName(nam.c_str());
          }
          if (s->IsA() == TGeoCompositeShape::Class()) {
            TGeoCompositeShape* c = (TGeoCompositeShape*) s;
            const TGeoBoolNode* boolean = c->GetBoolNode();
            s = boolean->GetLeftShape();
            sn = s->GetName();
            if ( !sn || 0 == ::strlen(sn)) {
              s->SetName((nam + "_left").c_str());
            }
            else if (0 == ::strcmp(sn, s->IsA()->GetName())) {
              s->SetName((nam + "_left").c_str());
            }
            s = boolean->GetRightShape();
            sn = s->GetName();
            if ( !sn || 0 == ::strlen(sn)) {
              s->SetName((nam + "_right").c_str());
            }
            else if (0 == ::strcmp(s->GetName(), s->IsA()->GetName())) {
              s->SetName((nam + "_right").c_str());
            }
          }
        }
      }
    }
  };
}
 
void DetectorImp::endDocument(bool close_geometry)    {
  const char* option = (close_geometry) ? "close" : nullptr;
  this->endDocument(option);
}
 
void DetectorImp::endDocument(const char* option)  {
  TGeoManager* mgr = m_manager;
  TString      clopt, opt(option == nullptr ? "" : option);
  std::lock_guard<std::recursive_mutex> lock(s_detector_apply_lock);
  opt.ToLower();
  if ( opt.Contains("close") && !mgr->IsClosed() )  {
#if 0
    Region trackingRegion("TrackingRegion");
    trackingRegion.setThreshold(1);
    trackingRegion.setStoreSecondaries(true);
    add(trackingRegion);
    m_trackingVol.setRegion(trackingRegion);
    // Set the tracking volume to invisible.
    VisAttr trackingVis("TrackingVis");
    trackingVis.setVisible(false);
    m_trackingVol.setVisAttributes(trackingVis);
    add(trackingVis);
#endif
    m_worldVol.solid()->ComputeBBox();
    // Propagating reflections: This is useless now and unused!!!!
    // Since we allow now for anonymous shapes,
    // we will rename them to use the name of the volume they are assigned to
    if( opt.Contains("i")  ) clopt += "i";
    if( opt.Contains("nv") ) clopt += "nv";
    (clopt.Length()>0) ? mgr->CloseGeometry(clopt) : mgr->CloseGeometry();
    if( clopt.Contains("nv") )  {
      printout(INFO,"Detector","++ Geometry voxelization is disabled.");
    }
    PlacedVolume pv = mgr->GetTopNode();
    auto* extension = pv->GetUserExtension();
    if ( nullptr == extension )   {
      extension = new PlacedVolume::Object();
      pv->SetUserExtension(extension);
    }
    m_world.setPlacement(pv);
    // Paths cached while the geometry was built may be outdated
    detail::tools::clearPathCaches(m_world);
  }
  // Patching shape names of anonymous shapes
  ShapePatcher patcher(m_volManager, m_world);
  patcher.patchShapes();
  mapDetectorTypes();
  m_state = READY;
  //DetectorGuard(this).unlock();
}
 
void DetectorImp::init() {
  if (!m_world.isValid()) {
    TGeoManager* mgr = m_manager;
    std::lock_guard<std::recursive_mutex> lock(s_detector_apply_lock);
    Constant     air_const = getRefChild(m_define, "Air", false);
    Constant     vac_const = getRefChild(m_define, "Vacuum", false);
    Box          worldSolid;
    
    m_materialVacuum = material(vac_const.isValid() ? vac_const->GetTitle() : "Vacuum");
 
    m_worldVol = m_manager->GetTopVolume();
    if ( m_worldVol.isValid() )   {
      worldSolid    = m_worldVol.solid();
      m_materialAir = m_worldVol.material();
      printout(INFO,"Detector", "*********** Use Top Node from manager as "
               "world volume [%s].  Material: %s BBox: %4.0f %4.0f %4.0f",
               worldSolid->IsA()->GetName(), m_materialAir.name(),
               worldSolid->GetDX(), worldSolid->GetDY(), worldSolid->GetDZ());
    }
    else   {
      Solid parallelWorldSolid = Box("world_x", "world_y", "world_z");
      worldSolid    = Box("world_x", "world_y", "world_z");
      m_materialAir = material(air_const.isValid() ? air_const->GetTitle() : "Air");
      m_worldVol    = Volume("world_volume", worldSolid, m_materialAir);
      parallelWorldSolid->SetName("parallel_world_solid");
      printout(INFO,"Detector","*********** Created World volume with size: %4.0f %4.0f %4.0f",
               worldSolid->GetDX(), worldSolid->GetDY(), worldSolid->GetDZ());
    }
    m_world = DetElement(new WorldObject(*this,"world"));
    VisAttr worldVis = visAttributes("WorldVis");
    if ( !worldVis.isValid() )  {
      worldVis = VisAttr("WorldVis");
      worldVis.setVisible(false);
      worldVis.setShowDaughters(true);
      worldVis.setColor(1., 1., 1., 1.);
      worldVis.setLineStyle(VisAttr::SOLID);
      worldVis.setDrawingStyle(VisAttr::WIREFRAME);
      //m_worldVol.setVisAttributes(worldVis);
      m_worldVol->SetVisibility(kFALSE);
      m_worldVol->SetVisDaughters(kTRUE);
      m_worldVol->SetVisContainers(kTRUE);
      add(worldVis);
    }
    m_worldVol.setVisAttributes(worldVis);
    m_manager->SetTopVolume(m_worldVol.ptr());
 
    m_detectors.append(m_world);
    m_world.setPlacement(mgr->GetTopNode());
 
    m_parallelWorldVol = Volume("parallel_world_volume", worldSolid, m_materialAir);
 
    m_field = OverlayedField("global");
    m_state = LOADING;
  }
}
 
void DetectorImp::fromXML(const std::string& xmlfile, DetectorBuildType build_type) {
  std::lock_guard<std::recursive_mutex> lock(s_detector_apply_lock);
  m_buildType = build_type;
  processXML(xmlfile, nullptr);
}
 
void DetectorImp::fromXML(const std::string& fname, xml::UriReader* entity_resolver, DetectorBuildType build_type)  {
  std::lock_guard<std::recursive_mutex> lock(s_detector_apply_lock);
  m_buildType = build_type;
  processXML(fname, entity_resolver);
}
 
void DetectorImp::dump() const {
  TGeoManager* mgr = m_manager;
  mgr->SetVisLevel(4);
  mgr->SetVisOption(1);
  m_worldVol->Draw("ogl");
}
 
long DetectorImp::apply(const char* factory_type, int argc, char** argv)   const   {
  std::lock_guard<std::recursive_mutex> lock(s_detector_apply_lock);
  std::string fac = factory_type;
  try {
    Detector* thisPtr = const_cast<DetectorImp*>(this);
    long result = PluginService::Create<long>(fac, thisPtr, argc, argv);
    if (0 == result) {
      PluginDebug dbg;
      result = PluginService::Create<long>(fac, thisPtr, argc, argv);
      if ( 0 == result )  {
        throw std::runtime_error("dd4hep: apply-plugin: Failed to locate plugin " +
                                 fac + ". " + dbg.missingFactory(fac));
      }
    }
    result = *(long*) result;
    if (result != 1) {
      throw std::runtime_error("dd4hep: apply-plugin: Failed to execute plugin " + fac);
    }
    return result;
  }
  catch (const xml::XmlException& e) {
    throw std::runtime_error(xml::_toString(e.msg) + "\ndd4hep: XML-DOM Exception with plugin:" + fac);
  }
  catch (const std::exception& e) {
    throw std::runtime_error(std::string(e.what()) + "\ndd4hep: with plugin:" + fac);
  }
  catch (...) {
    throw std::runtime_error("UNKNOWN exception from plugin:" + fac);
  }
  return EINVAL;
}