GeoDetectorTool Class Reference

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

#include "G4AtlasTools/GeoDetectorTool.h"

Inheritance diagram for GeoDetectorTool:

Collaboration diagram for GeoDetectorTool:

Public Member Functions
	GeoDetectorTool (const std::string &type, const std::string &name, const IInterface *parent)
	~GeoDetectorTool ()
virtual StatusCode	initialize () override final
	Athena method.
virtual void	BuildGeometry () override final
	virtual methods being implemented here
virtual void	PositionInParent () override final
virtual void	Build () override
	purely virtual methods being implemented here
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
G4LogicalVolume *	Convert ()
bool	IsTopTransform ()
void	SetInitialTransformation ()

Private Attributes
std::string	m_builderName
std::string	m_dumpGDMLFile =""
bool	m_blParamOn
bool	m_blGetTopTransform
G4Transform3D	m_topTransform
std::string	m_geoDetectorName
ServiceHandle< IGeo2G4Svc >	m_geo2G4Svc {this, "Geo2G4Svc", "Geo2G4Svc", ""}

Detailed Description

Tool for building detectors out of a GeoModel description.

Basically a carbon copy of GeoDetectorFacility in GeoDetectorPlugins which is supposed to replace.

Author

Andrea Dell'Acqua

Date

2015-03-10

Definition at line 30 of file GeoDetectorTool.h.

Constructor & Destructor Documentation

GeoDetectorTool()

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

Definition at line 18 of file GeoDetectorTool.cxx.

  : DetectorGeometryBase(type,name,parent),m_blParamOn(false),m_blGetTopTransform(true),m_geoDetectorName("")
{
  m_topTransform.setIdentity();
  ATH_MSG_DEBUG( "GeoDetectorTool constructor for " << name );
  declareProperty("GeoDetectorName",m_geoDetectorName, "Name of the detector in GeoModel, if different from G4.");
  declareProperty("GDMLFileOut",m_dumpGDMLFile,"File name where the GDML description for the detector will be dumped.");
 
}

~GeoDetectorTool()

GeoDetectorTool::~GeoDetectorTool ( )

inline

Definition at line 35 of file GeoDetectorTool.h.

{}

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 GeoDetectorTool::BuildGeometry ( )

finaloverridevirtual

virtual methods being implemented here

Reimplemented from DetectorGeometryBase.

Definition at line 59 of file GeoDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::BuildGeometry(): Starting" );
  G4LogicalVolume* temp = this->Convert();
  m_envelope.theEnvelope=temp;
 
  if (this->IsTopTransform())
    {
      this->SetInitialTransformation();
    }
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::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");
}

Convert()

G4LogicalVolume * GeoDetectorTool::Convert ( )

private

Definition at line 83 of file GeoDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::Convert(): Starting" );
  ATH_MSG_DEBUG( name() << " GeoDetectorTool::Convert(): GeoDetectorName:builderName = "<<m_geoDetectorName<<":"<<m_builderName);
  Geo2G4Builder Builder(m_geoDetectorName);
  VolumeBuilder *b=Builder.GetVolumeBuilder(m_builderName);
  b->SetParam(m_blParamOn);
  G4LogicalVolume *temp=Builder.BuildTree();
  if(this->IsTopTransform())
    {
      m_topTransform = Builder.GetDetectorTransform();
    }
 
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::Convert(): Finished" );
  return temp;
}

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 GeoDetectorTool::initialize ( )

finaloverridevirtual

Athena method.

called at initialization time, being customized here

Definition at line 28 of file GeoDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::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_VERBOSE( "m_detectorName: " << m_detectorName.value() << " needs to be reset.");
          m_detectorName = m_detectorName.value().substr(ipos+1,length-ipos-1);
          ATH_MSG_VERBOSE( "m_detectorName default value reset to " << m_detectorName.value());
        }
    }
  ATH_MSG_DEBUG( name() << "GeoDetectorTool::initialize() : Detector name = " << m_detectorName.value() );
  if(m_geoDetectorName.empty())
    {
      m_geoDetectorName = m_detectorName.value();
    }
  ATH_MSG_DEBUG( name() << "GeoDetectorTool::initialize() : Geo Detector name = " << m_geoDetectorName );
 
  ATH_CHECK(m_geo2G4Svc.retrieve());
  m_builderName = m_geo2G4Svc->GetDefaultBuilder()->GetKey();
  m_blGetTopTransform = m_geo2G4Svc->UseTopTransforms();
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::initialize(): Finished" );
  return StatusCode::SUCCESS;
}

IsTopTransform()

bool GeoDetectorTool::IsTopTransform ( )

private

Definition at line 100 of file GeoDetectorTool.cxx.

{
  return m_blGetTopTransform;
}

PositionInParent()

void GeoDetectorTool::PositionInParent ( )

finaloverridevirtual

Reimplemented from DetectorGeometryBase.

Definition at line 72 of file GeoDetectorTool.cxx.

{
  ATH_MSG_DEBUG( name() << " GeoDetectorTool::PositionInParent(): Starting" );
 
  DetectorGeometryBase::PositionInParent();
  if (!m_dumpGDMLFile.empty()) {
    G4GDMLParser parser;
    parser.Write(m_dumpGDMLFile,m_envelope.thePositionedVolume);
  }
}

ResetEnvelope()

void DetectorGeometryBase::ResetEnvelope ( )

overridevirtualinherited

Definition at line 171 of file DetectorGeometryBase.cxx.

{
}

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.

{
}

SetInitialTransformation()

void GeoDetectorTool::SetInitialTransformation ( )

private

Definition at line 105 of file GeoDetectorTool.cxx.

{
  ATH_MSG_VERBOSE( name() << " GeoDetectorTool::SetInitialTransformation(): Starting" );
  if (!m_envelope.theRotation)
    {
      ATH_MSG_VERBOSE( name() << " GeoDetectorTool::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() << " GeoDetectorTool::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 GeoDetectorTool::m_blGetTopTransform

private

Definition at line 51 of file GeoDetectorTool.h.

m_blParamOn

bool GeoDetectorTool::m_blParamOn

private

Definition at line 50 of file GeoDetectorTool.h.

m_builderName

std::string GeoDetectorTool::m_builderName

private

Definition at line 48 of file GeoDetectorTool.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.

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

m_dumpGDMLFile

std::string GeoDetectorTool::m_dumpGDMLFile =""

private

Definition at line 49 of file GeoDetectorTool.h.

m_envelope

Envelope DetectorGeometryBase::m_envelope

protectedinherited

Definition at line 70 of file DetectorGeometryBase.h.

m_geo2G4Svc

ServiceHandle<IGeo2G4Svc> GeoDetectorTool::m_geo2G4Svc {this, "Geo2G4Svc", "Geo2G4Svc", ""}

private

Definition at line 57 of file GeoDetectorTool.h.

{this, "Geo2G4Svc", "Geo2G4Svc", ""};

m_geoDetectorName

std::string GeoDetectorTool::m_geoDetectorName

private

Definition at line 53 of file GeoDetectorTool.h.

m_isWorld

bool DetectorGeometryBase::m_isWorld {false}

protectedinherited

Definition at line 72 of file DetectorGeometryBase.h.

{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.

{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.

{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.

{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.

{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.

{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.

{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.

{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.

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

m_theParent

IDetectorGeometryTool* DetectorGeometryBase::m_theParent {}

protectedinherited

Definition at line 68 of file DetectorGeometryBase.h.

{};

m_topTransform

G4Transform3D GeoDetectorTool::m_topTransform

private

Definition at line 52 of file GeoDetectorTool.h.

---

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

• GeoDetectorTool.h
• GeoDetectorTool.cxx