DetectorGeometryBase Class Reference

#include <DetectorGeometryBase.h>

Inheritance diagram for DetectorGeometryBase:

Collaboration diagram for DetectorGeometryBase:

Public Member Functions
	DetectorGeometryBase (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~DetectorGeometryBase ()
StatusCode	initialize () override
	Athena method.
virtual void	Build () override
	purely virtual methods being implemented here
virtual void	BuildGeometry () override
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"}

Detailed Description

Todo

NEEDS DOCUMENTATION

Definition at line 25 of file DetectorGeometryBase.h.

Constructor & Destructor Documentation

DetectorGeometryBase()

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

Definition at line 13 of file DetectorGeometryBase.cxx.

  : base_class(type,name,parent)
{
}

~DetectorGeometryBase()

virtual DetectorGeometryBase::~DetectorGeometryBase ( )

inlinevirtual

Definition at line 30 of file DetectorGeometryBase.h.

{}

Member Function Documentation

Build()

void DetectorGeometryBase::Build ( )

overridevirtual

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

overridevirtual

Reimplemented in BoxEnvelope, CylindricalEnvelope, DeadMaterialTool, GDMLDetectorTool, GeoDetectorTool, LArCrateTool, MuonWallTool, and PolyconicalEnvelope.

Definition at line 75 of file DetectorGeometryBase.cxx.

{
  ATH_MSG_VERBOSE( "DetectorGeometryBase::BuildGeometry(): Using base-class method. Anything going wrong?");
}

BuildSubDetectors()

void DetectorGeometryBase::BuildSubDetectors ( )

overridevirtual

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

override

Definition at line 180 of file DetectorGeometryBase.cxx.

{
  return m_detectorName.value();
}

GetEnvelope()

Envelope & DetectorGeometryBase::GetEnvelope ( )

finaloverride

Definition at line 195 of file DetectorGeometryBase.cxx.

{
  return m_envelope;
}

GetWorldVolume()

G4VPhysicalVolume * DetectorGeometryBase::GetWorldVolume ( )

finaloverride

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

override

Athena method.

called at initialization time, being customized here

Definition at line 19 of file DetectorGeometryBase.cxx.

{
  ATH_MSG_VERBOSE( name() << "::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() << "::initialize() (Base class method): Detector name = " << m_detectorName.value() );
  CHECK(m_notifierSvc.retrieve());
 
  //  This fires initialize() for each of those tools
  if (m_subDetTools.size())
    {
      ATH_MSG_DEBUG( name() << "::initialize(): Initializing list of " << m_subDetTools.size() << " detectors." );
      CHECK( m_subDetTools.retrieve() );
    }
  else
    {
      ATH_MSG_DEBUG( name() << "::initialize(): no sub-detectors to initialize." );
    }
 
  ATH_MSG_VERBOSE( name() << "::initialize(): finished." );
  return StatusCode::SUCCESS;
}

PositionInParent()

void DetectorGeometryBase::PositionInParent ( )

overridevirtual

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 ( )

overridevirtual

Definition at line 171 of file DetectorGeometryBase.cxx.

{
}

SetAsWorld()

void DetectorGeometryBase::SetAsWorld ( )

overridevirtual

Definition at line 185 of file DetectorGeometryBase.cxx.

{
  m_isWorld=true;
}

SetDetectorName()

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

override

Definition at line 175 of file DetectorGeometryBase.cxx.

{
  m_detectorName=s;
}

SetEnvelope()

void DetectorGeometryBase::SetEnvelope ( )

overridevirtual

Definition at line 167 of file DetectorGeometryBase.cxx.

{
}

SetParent()

void DetectorGeometryBase::SetParent ( IDetectorGeometryTool * p )

override

Definition at line 190 of file DetectorGeometryBase.cxx.

{
  m_theParent=p;
}

SetRotationAndOffset()

void DetectorGeometryBase::SetRotationAndOffset ( )

virtual

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_detectorName

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

protected

Definition at line 71 of file DetectorGeometryBase.h.

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

m_envelope

Envelope DetectorGeometryBase::m_envelope

protected

Definition at line 70 of file DetectorGeometryBase.h.

m_isWorld

bool DetectorGeometryBase::m_isWorld {false}

protected

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"}

protected

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"}

protected

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"}

protected

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"}

protected

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"}

protected

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"}

protected

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"}

protected

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"}

protected

Definition at line 64 of file DetectorGeometryBase.h.

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

m_theParent

IDetectorGeometryTool* DetectorGeometryBase::m_theParent {}

protected

Definition at line 68 of file DetectorGeometryBase.h.

{};

---

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

• DetectorGeometryBase.h
• DetectorGeometryBase.cxx