Tool for building detectors out of a GDML description. More...

#include <GDMLDetectorTool.h>

Inheritance diagram for GDMLDetectorTool:

Collaboration diagram for GDMLDetectorTool:

Public Member Functions
	GDMLDetectorTool (const std::string &type, const std::string &name, const IInterface *parent)
	~GDMLDetectorTool ()
virtual StatusCode	initialize () override final
	Athena method.
virtual void	BuildGeometry () override final
	virtual methods being implemented here
virtual void	Build () override
	purely virtual methods being implemented here
virtual void	PositionInParent () override
virtual void	SetRotationAndOffset ()
virtual void	BuildSubDetectors () override
virtual void	SetEnvelope () override
virtual void	ResetEnvelope () override
virtual void	SetAsWorld () override
std::string	GetDetectorName () const override
void	SetDetectorName (const std::string &) override
void	SetParent (IDetectorGeometryTool *) override
Envelope &	GetEnvelope () override final
G4VPhysicalVolume *	GetWorldVolume () override final

Protected Attributes
ToolHandleArray< IDetectorGeometryTool >	m_subDetTools {this, "SubDetectors", {}, "Tool handle array of all subdetector tools"}
ServiceHandle< IG4GeometryNotifierSvc >	m_notifierSvc {this, "GeometryNotifierSvc", "G4GeometryNotifierSvc", "Detector name (same as the Tool name if not set"}
IDetectorGeometryTool *	m_theParent {}
Envelope	m_envelope
Gaudi::Property< std::string >	m_detectorName {this, "DetectorName", "", "Detector name (same as the Tool name if not set"}
bool	m_isWorld {false}
Gaudi::Property< double >	m_rotateX {this, "RotateX" , 0.0, "Rotation around the X-axis"}
Gaudi::Property< double >	m_rotateY {this, "RotateY" , 0.0, "Rotation around the Y-axis"}
Gaudi::Property< double >	m_rotateZ {this, "RotateZ" , 0.0, "Rotation around the Z-axis"}
Gaudi::Property< double >	m_offsetX {this, "OffsetX" , 0.0, "Offset in the X-direction"}
Gaudi::Property< double >	m_offsetY {this, "OffsetY" , 0.0, "Offset in the Y-direction"}
Gaudi::Property< double >	m_offsetZ {this, "OffsetZ" , 0.0, "Offset in the Z-direction"}

Private Member Functions
bool	IsTopTransform ()
void	SetInitialTransformation ()

Private Attributes
std::string	m_GDMLFileName
std::string	m_builderName
bool	m_blGetTopTransform
G4Transform3D	m_topTransform
std::string	m_geoDetectorName

Detailed Description

Tool for building detectors out of a GDML description.

Author: Andrea Dell'Acqua

Date: 2017-02-21

Definition at line 27 of file GDMLDetectorTool.h.

Constructor & Destructor Documentation

◆ GDMLDetectorTool()

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

Definition at line 16 of file GDMLDetectorTool.cxx.

  : DetectorGeometryBase(type,name,parent),m_GDMLFileName(""),m_blGetTopTransform(true),m_geoDetectorName("")
{
  m_topTransform.setIdentity();
  ATH_MSG_DEBUG( "GDMLDetectorTool constructor for " << name );
  declareProperty("GeoDetectorName",m_geoDetectorName, "Name of the detector in GeoModel, if different from G4.");
  declareProperty("GDMLFileName",m_GDMLFileName,"Name of the GDML file to be used as input.");
 
}

◆ ~GDMLDetectorTool()

GDMLDetectorTool::~GDMLDetectorTool ( )

inline

Definition at line 32 of file GDMLDetectorTool.h.

32{}

Member Function Documentation

◆ Build()

void DetectorGeometryBase::Build ( )

overridevirtualinherited

purely virtual methods being implemented here

Definition at line 53 of file DetectorGeometryBase.cxx.

{
  ATH_MSG_VERBOSE( name() << "::Build() (Base class method): Starting. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
  
  SetEnvelope();
  ATH_MSG_VERBOSE( name() << "::Build() - Envelope set. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
 
  m_notifierSvc->SetCurrentDetectorName(m_detectorName.value());
  BuildGeometry();
  ATH_MSG_VERBOSE( name() << "::Build() - Geometry built. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
 
  SetRotationAndOffset();
  ATH_MSG_VERBOSE( name() << "::Build() - Volume moved around. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
 
  PositionInParent();
  ATH_MSG_VERBOSE( name() << "::Build() - Connected with parent. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
 
  BuildSubDetectors();
  ATH_MSG_VERBOSE( name() << "::Build() (Base class method): Finished. Number of registered volumes "<<G4LogicalVolumeStore::GetInstance()->size() );
  return;
}

◆ BuildGeometry()

void GDMLDetectorTool::BuildGeometry ( )

finaloverridevirtual

virtual methods being implemented here

Reimplemented from DetectorGeometryBase.

Definition at line 59 of file GDMLDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( name() << " GDMLDetectorTool::BuildGeometry(): Starting" );
 
  G4GDMLParser parser;
  parser.Read(m_GDMLFileName.c_str(),false);
  m_envelope.theEnvelope=parser.GetWorldVolume()->GetLogicalVolume();
 
  ATH_MSG_VERBOSE( name() << " GDMLDetectorTool::BuildGeometry(): Finished" );
}

◆ BuildSubDetectors()

void DetectorGeometryBase::BuildSubDetectors ( )

overridevirtualinherited

Definition at line 155 of file DetectorGeometryBase.cxx.

{
  ATH_MSG_VERBOSE( name() << "::BuildSubDetectors() (Base class method): Starting");
  for (auto& subDetTool: m_subDetTools)
    {
      ATH_MSG_VERBOSE(name() << "::BuildSubDetectors() (Base class method):  Positioning "<<subDetTool->GetDetectorName()<<" within "<<m_detectorName.value());
      subDetTool->SetParent(this);
      subDetTool->Build();
    }
  ATH_MSG_VERBOSE( name() << "::BuildSubDetectors() (Base class method): Finished");
}

◆ GetDetectorName()

std::string DetectorGeometryBase::GetDetectorName ( ) const

overrideinherited

Definition at line 180 of file DetectorGeometryBase.cxx.

{
  return m_detectorName.value();
}

◆ GetEnvelope()

Envelope & DetectorGeometryBase::GetEnvelope ( )

finaloverrideinherited

Definition at line 195 of file DetectorGeometryBase.cxx.

{
  return m_envelope;
}

◆ GetWorldVolume()

G4VPhysicalVolume * DetectorGeometryBase::GetWorldVolume ( )

finaloverrideinherited

Definition at line 200 of file DetectorGeometryBase.cxx.

{
  if (m_isWorld)
    return m_envelope.thePositionedVolume;
  else
    {
      ATH_MSG_ERROR("trying to get World from a DetectorTool which World is not!");
      return 0;
    }
}

◆ initialize()

StatusCode GDMLDetectorTool::initialize ( )

finaloverridevirtual

Athena method.

called at initialization time, being customized here

Definition at line 26 of file GDMLDetectorTool.cxx.

{
  ATH_MSG_DEBUG( name() << " GDMLDetectorTool::initialize(): Starting" );
 
  if(m_detectorName.empty())
    {
      m_detectorName = this->name();
      // re-initialize m_detectorName in order to take the real detector name rather than the path to it
      size_t ipos=m_detectorName.value().find_last_of('.');
      size_t length=m_detectorName.value().size();
      if (ipos<length)
        {
          ATH_MSG_DEBUG( "m_detectorName: " << m_detectorName.value() << " needs to be reset.");
          m_detectorName=m_detectorName.value().substr(ipos+1,length-ipos-1);
          ATH_MSG_DEBUG( "m_detectorName default value reset to " << m_detectorName.value());
        }
    }
  ATH_MSG_DEBUG( name() << "GDMLDetectorTool::initialize() : Detector name = " << m_detectorName.value()<<" File name: "<<m_GDMLFileName );
  if(m_geoDetectorName.empty())
    {
      m_geoDetectorName = m_detectorName.value();
    }
  if(m_GDMLFileName.empty())
    {
          m_GDMLFileName = m_detectorName.value()+".gdml";
    }
  ATH_MSG_DEBUG( name() << "GDMLDetectorTool::initialize() : Geo Detector name = " << m_geoDetectorName<<" File name: "<<m_GDMLFileName );
 
  ATH_MSG_DEBUG( name() << " GDMLDetectorTool::initialize(): Finished" );
  return StatusCode::SUCCESS;
}

◆ IsTopTransform()

bool GDMLDetectorTool::IsTopTransform ( )

private

Definition at line 70 of file GDMLDetectorTool.cxx.

{
  return m_blGetTopTransform;
}

◆ PositionInParent()

void DetectorGeometryBase::PositionInParent ( )

overridevirtualinherited

Reimplemented in GeoDetectorTool.

Definition at line 120 of file DetectorGeometryBase.cxx.

{
  ATH_MSG_VERBOSE( name() << "::PositionInParent() (Base class method)");
  if (m_isWorld)
    {
      // check that the detector is built
      if (m_envelope.IsBuilt())
        {
          G4VPhysicalVolume* physWorld= new G4PVPlacement(0,G4ThreeVector(),
                                                          m_envelope.theEnvelope,m_envelope.theEnvelope->GetName(),0,false,0,false);
          m_envelope.thePositionedVolume=physWorld;
        }
    }
  else
    {
      // check that there is a parent
      if (!m_theParent)
        {
          ATH_MSG_ERROR("Parent not set for "<<m_detectorName.value()<<"!!!!!!!!!!");
        }
      else
        {
          if (m_theParent->GetEnvelope().IsBuilt())
            {
              // G4VPhysicalVolume *physVol = new G4PVPlacement(0,G4ThreeVector(),
              //                                                m_envelope.theEnvelope,m_envelope.theEnvelope->GetName(),m_theParent->GetEnvelope().theEnvelope,false,0,false);
              // TODO: implement a possible rotation/displacement - something like this based on the old code?
              G4VPhysicalVolume *physVol = new G4PVPlacement(m_envelope.theRotation,m_envelope.thePosition,
                                                             m_envelope.theEnvelope,m_envelope.theEnvelope->GetName(),m_theParent->GetEnvelope().theEnvelope,false,0);
              m_envelope.thePositionedVolume=physVol;
            }
        }
    }
}

◆ ResetEnvelope()

void DetectorGeometryBase::ResetEnvelope ( )

overridevirtualinherited

Definition at line 171 of file DetectorGeometryBase.cxx.

172{

173}

◆ SetAsWorld()

void DetectorGeometryBase::SetAsWorld ( )

overridevirtualinherited

Definition at line 185 of file DetectorGeometryBase.cxx.

{
  m_isWorld=true;
}

◆ SetDetectorName()

void DetectorGeometryBase::SetDetectorName ( const std::string & s )

overrideinherited

Definition at line 175 of file DetectorGeometryBase.cxx.

{
  m_detectorName=s;
}

◆ SetEnvelope()

void DetectorGeometryBase::SetEnvelope ( )

overridevirtualinherited

Definition at line 167 of file DetectorGeometryBase.cxx.

168{

169}

◆ SetInitialTransformation()

void GDMLDetectorTool::SetInitialTransformation ( )

private

Definition at line 75 of file GDMLDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( name() << " GDMLDetectorTool::SetInitialTransformation(): Starting" );
  if (!m_envelope.theRotation)
    {
      ATH_MSG_VERBOSE( name() << " GDMLDetectorTool::SetInitialTransformation(): Creating new G4RotationMatrix" );
      m_envelope.theRotation=new G4RotationMatrix;
    }
  *(m_envelope.theRotation)=m_topTransform.getRotation().inverse();
  m_envelope.thePosition=m_topTransform.getTranslation();
  ATH_MSG_VERBOSE( name() << " GDMLDetectorTool::SetInitialTransformation(): Finished" );
}

◆ SetParent()

void DetectorGeometryBase::SetParent ( IDetectorGeometryTool * p )

overrideinherited

Definition at line 190 of file DetectorGeometryBase.cxx.

{
  m_theParent=p;
}

◆ SetRotationAndOffset()

void DetectorGeometryBase::SetRotationAndOffset ( )

virtualinherited

Definition at line 80 of file DetectorGeometryBase.cxx.

{
  ATH_MSG_VERBOSE( name() << "::SetRotationAndOffset() (Base class method)");
  // Firstly do the rotation
  if (!m_envelope.theRotation)
    {
      // m_envelope.theRotation is null, so create an identity
      // rotation first.
      // FIXME probably a neater way to do this part.
      m_envelope.theRotation=new G4RotationMatrix;
      // add the extra rotations.
      m_envelope.theRotation->rotateX(m_rotateX);
      m_envelope.theRotation->rotateY(m_rotateY);
      m_envelope.theRotation->rotateZ(m_rotateZ);
      if (m_envelope.thePositionedVolume)
        {
          // Override the rotation for m_envelope.thePositionedVolume.
          m_envelope.thePositionedVolume->SetRotation(m_envelope.theRotation);
        }
    }
  else
    {
      // m_envelope.theRotation already exists, so just add the
      // extra rotations.
      m_envelope.theRotation->rotateX(m_rotateX);
      m_envelope.theRotation->rotateY(m_rotateY);
      m_envelope.theRotation->rotateZ(m_rotateZ);
    }
  // Secondly add the additional position offset to the existing
  // m_envelope.thePosition vector.
  m_envelope.thePosition+=G4ThreeVector(m_offsetX,m_offsetY,m_offsetZ);
  if (m_envelope.thePositionedVolume)
    {
      // Override the translation for m_envelope.thePositionedVolume.
      m_envelope.thePositionedVolume->SetTranslation(m_envelope.thePosition);
    }
 
  ATH_MSG_VERBOSE( name() << "::SetRotationAndOffset() (Base class method): Finished" );
  return;
}

Member Data Documentation

◆ m_blGetTopTransform

bool GDMLDetectorTool::m_blGetTopTransform

private

Definition at line 45 of file GDMLDetectorTool.h.

◆ m_builderName

std::string GDMLDetectorTool::m_builderName

private

Definition at line 44 of file GDMLDetectorTool.h.

◆ m_detectorName

Gaudi::Property<std::string> DetectorGeometryBase::m_detectorName {this, "DetectorName", "", "Detector name (same as the Tool name if not set"}

protectedinherited

Definition at line 71 of file DetectorGeometryBase.h.

71{this, "DetectorName", "", "Detector name (same as the Tool name if not set"};

◆ m_envelope

Envelope DetectorGeometryBase::m_envelope

protectedinherited

Definition at line 70 of file DetectorGeometryBase.h.

◆ m_GDMLFileName

std::string GDMLDetectorTool::m_GDMLFileName

private

Definition at line 43 of file GDMLDetectorTool.h.

◆ m_geoDetectorName

std::string GDMLDetectorTool::m_geoDetectorName

private

Definition at line 47 of file GDMLDetectorTool.h.

◆ m_isWorld

bool DetectorGeometryBase::m_isWorld {false}

protectedinherited

Definition at line 72 of file DetectorGeometryBase.h.

72{false};

◆ m_notifierSvc

ServiceHandle<IG4GeometryNotifierSvc> DetectorGeometryBase::m_notifierSvc {this, "GeometryNotifierSvc", "G4GeometryNotifierSvc", "Detector name (same as the Tool name if not set"}

protectedinherited

Definition at line 66 of file DetectorGeometryBase.h.

66{this, "GeometryNotifierSvc", "G4GeometryNotifierSvc", "Detector name (same as the Tool name if not set"};

◆ m_offsetX

Gaudi::Property<double> DetectorGeometryBase::m_offsetX {this, "OffsetX" , 0.0, "Offset in the X-direction"}

protectedinherited

Definition at line 76 of file DetectorGeometryBase.h.

76{this, "OffsetX" , 0.0, "Offset in the X-direction"};

◆ m_offsetY

Gaudi::Property<double> DetectorGeometryBase::m_offsetY {this, "OffsetY" , 0.0, "Offset in the Y-direction"}

protectedinherited

Definition at line 77 of file DetectorGeometryBase.h.

77{this, "OffsetY" , 0.0, "Offset in the Y-direction"};

◆ m_offsetZ

Gaudi::Property<double> DetectorGeometryBase::m_offsetZ {this, "OffsetZ" , 0.0, "Offset in the Z-direction"}

protectedinherited

Definition at line 78 of file DetectorGeometryBase.h.

78{this, "OffsetZ" , 0.0, "Offset in the Z-direction"};

◆ m_rotateX

Gaudi::Property<double> DetectorGeometryBase::m_rotateX {this, "RotateX" , 0.0, "Rotation around the X-axis"}

protectedinherited

Definition at line 73 of file DetectorGeometryBase.h.

73{this, "RotateX" , 0.0, "Rotation around the X-axis"};

◆ m_rotateY

Gaudi::Property<double> DetectorGeometryBase::m_rotateY {this, "RotateY" , 0.0, "Rotation around the Y-axis"}

protectedinherited

Definition at line 74 of file DetectorGeometryBase.h.

74{this, "RotateY" , 0.0, "Rotation around the Y-axis"};

◆ m_rotateZ

Gaudi::Property<double> DetectorGeometryBase::m_rotateZ {this, "RotateZ" , 0.0, "Rotation around the Z-axis"}

protectedinherited

Definition at line 75 of file DetectorGeometryBase.h.

75{this, "RotateZ" , 0.0, "Rotation around the Z-axis"};

◆ m_subDetTools

ToolHandleArray<IDetectorGeometryTool> DetectorGeometryBase::m_subDetTools {this, "SubDetectors", {}, "Tool handle array of all subdetector tools"}

protectedinherited

Definition at line 64 of file DetectorGeometryBase.h.

64{this, "SubDetectors", {}, "Tool handle array of all subdetector tools"};

◆ m_theParent

IDetectorGeometryTool* DetectorGeometryBase::m_theParent {}

protectedinherited

Definition at line 68 of file DetectorGeometryBase.h.

68{};

◆ m_topTransform

G4Transform3D GDMLDetectorTool::m_topTransform

private

Definition at line 46 of file GDMLDetectorTool.h.

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GDMLDetectorTool()

◆ ~GDMLDetectorTool()

Member Function Documentation

◆ Build()

◆ BuildGeometry()

◆ BuildSubDetectors()

◆ GetDetectorName()

◆ GetEnvelope()

◆ GetWorldVolume()

◆ initialize()

◆ IsTopTransform()

◆ PositionInParent()

◆ ResetEnvelope()

◆ SetAsWorld()

◆ SetDetectorName()

◆ SetEnvelope()

◆ SetInitialTransformation()

◆ SetParent()

◆ SetRotationAndOffset()

Member Data Documentation

◆ m_blGetTopTransform

◆ m_builderName

◆ m_detectorName

◆ m_envelope

◆ m_GDMLFileName

◆ m_geoDetectorName

◆ m_isWorld

◆ m_notifierSvc

◆ m_offsetX

◆ m_offsetY

◆ m_offsetZ

◆ m_rotateX

◆ m_rotateY

◆ m_rotateZ

◆ m_subDetTools

◆ m_theParent

◆ m_topTransform