InDetDD::TRT_BaseElement Class Reference

#include <TRT_BaseElement.h>

Inheritance diagram for InDetDD::TRT_BaseElement:

Collaboration diagram for InDetDD::TRT_BaseElement:

Public Types
enum	Type { BARREL, ENDCAP }

Public Member Functions
	TRT_BaseElement (const GeoVFullPhysVol *volume, const Identifier &id, const TRT_ID *idHelper, const TRT_Conditions *conditions)
	Constructor: More...
	TRT_BaseElement (const TRT_BaseElement &right)
virtual	~TRT_BaseElement ()=default
	Destructor: More...
virtual TRT_BaseElement::Type	type () const =0
	Type information: returns BARREL or ENDCAP. More...
virtual Identifier	identify () const override final
	identifier of this detector element: More...
virtual IdentifierHash	identifyHash () const override final
	identifier hash More...
const GeoTrf::Transform3D &	defTransform () const
	Get Default Transform (of module in barrel, layer in endcap) from GeoModel before alignment corrections. More...
const HepGeom::Transform3D	getAbsoluteTransform (int straw) const
	This is an alias to strawTransform(int straw) More...
virtual const Trk::Surface &	surface () const override final
	Element Surface: access to the Surface (straw layer) More...
virtual const Trk::SurfaceBounds &	bounds () const override final
	Straw layer bounds. More...
virtual const Amg::Transform3D &	transform () const override final
	Element Surface: Get Transform of element in Tracking frame: Amg. More...
virtual const Amg::Vector3D &	center () const override final
	Element Surface: center of a straw layer. More...
virtual const Amg::Vector3D &	normal () const override final
	Element Surface: normal of a straw layer. More...
virtual Trk::DetectorElemType	detectorType () const override final
	TrkDetElementBase interface detectorTyoe. More...
virtual const Trk::Surface &	surface (const Identifier &id) const override final
	Straw Surface: access to the surface via identifier. More...
const std::vector< const Trk::Surface * > &	surfaces () const
	Returns the full list of all detection surfaces associated to this detector element. More...
virtual const Trk::SurfaceBounds &	bounds (const Identifier &id) const override final
	Straw Surface: access to the bounds via Identifier. More...
virtual const Amg::Transform3D &	transform (const Identifier &id) const override final
	Straw Surface: access to the transform of individual straw in Tracking frame: Amg. More...
const Amg::Transform3D &	strawTransform (unsigned int straw) const
	Straw transform - fast access in array, in Tracking frame: Amg. More...
virtual const Amg::Vector3D &	center (const Identifier &id) const override final
	Straw Surface: Center of a straw using Identifier Straw center and straw axis can be obtained by the following: (The straw center is the center of the active region) Amg::Transform3D& transform = element->strawTransform(straw); Amb::Vector3D& center = element->strawCenter(); double r = element->strawCenter()->perp(); double phi = element->strawCenter()->phi(); Amg::Vector3D strawAxis = element->strawTransform(straw)* Vector3D(0,0,1) * strawDirection() More...
virtual const Amg::Vector3D &	normal (const Identifier &id) const override final
	Normal of a straw. More...
const Trk::StraightLineSurface &	strawSurface (int straw) const
	Straw Surface: access to the surface via integer. More...
const Amg::Transform3D &	strawTransform (int straw) const
	Straw Surface: Local -> global transform of the straw via integer. More...
const Amg::Vector3D &	strawCenter (int straw) const
	Straw Surface: Local -> global transform of the straw via integer. More...
Amg::Vector3D	strawAxis (int straw) const
	Straw axis. More...
unsigned int	nStraws () const
	Number of straws in the element. More...
virtual const double &	strawLength () const =0
	Active straw length. More...
virtual int	strawDirection () const =0
	StrawDirection. More...
void	invalidate ()
	Invalidate cache. More...
void	updateAllCaches ()
	Update all caches. More...
const TRT_Conditions *	conditions () const
	Return the TRT_Conditions object associated to this Detector element. More...
virtual HepGeom::Transform3D	calculateStrawTransform (int straw) const =0
	to be overloaded by the extended classes More...
virtual const Trk::SurfaceBounds &	strawBounds () const =0
	the straw bounds More...
virtual const Trk::Surface &	elementSurface () const =0
	creates surface for detector element, to be implemented in derived class More...
virtual void	createSurfaceCache () const =0
	create the surface cache of the detector element, to be implementd in the deried class More...
void	createSurfaceCache (Identifier id) const
	create the surface & surface cache for the straw More...
void	invalidateOther () const
	invalidate action on the cache More...
std::string	detectorTypeString () const
	Returns a string of the Detector element type. More...

Protected Attributes
Identifier	m_id
IdentifierHash	m_idHash
unsigned int	m_nstraws = 0
const TRT_ID *	m_idHelper =nullptr
const TRT_Conditions *	m_conditions =nullptr
CxxUtils::CachedUniquePtr< Trk::Surface >	m_surface
std::vector< CxxUtils::CachedUniquePtr< Trk::StraightLineSurface > >	m_strawSurfaces {}
std::vector< CxxUtils::CachedUniquePtr< SurfaceCacheBase > >	m_strawSurfacesCache {}
	helper element surface for the cache More...
CxxUtils::CachedValue< std::vector< const Trk::Surface * > >	m_surfaces
CxxUtils::CachedValue< SurfaceCache >	m_surfaceCache

Private Member Functions
const TRT_BaseElement &	operator= (const TRT_BaseElement &right)
	Illegal operations: More...
void	deleteCache ()
	Helper method for cache dealing. More...
std::unique_ptr< SurfaceCacheBase >	createSurfaceCacheHelper (int straw) const

Detailed Description

Virtual base class of TRT readout elements. Differently to the Silicon readout elements, the TRT readoutelements describe multiple readout surfaces, i.e. several straws that are described by a surface, such as e.g. a planar sector surface in the barrel, or a disc surface in the endcap.

Author

Grant Gorfine

• modified& maintained: Andreas Salzburger, Nick Styles

Definition at line 57 of file TRT_BaseElement.h.

Member Enumeration Documentation

Type

enum InDetDD::TRT_BaseElement::Type

Enumerator
BARREL
ENDCAP

Definition at line 61 of file TRT_BaseElement.h.

{BARREL, ENDCAP};

Constructor & Destructor Documentation

TRT_BaseElement() [1/2]

InDetDD::TRT_BaseElement::TRT_BaseElement	(	const GeoVFullPhysVol *	volume,
		const Identifier &	id,
		const TRT_ID *	idHelper,
		const TRT_Conditions *	conditions
	)

Constructor:

Definition at line 17 of file TRT_BaseElement.cxx.

  : Trk::TrkDetElementBase(volume)
  , m_id(id)
  , m_idHelper(idHelper)
  , m_conditions(conditions)
  , m_surface{}
  , m_surfaces{}
  , m_surfaceCache{}
{
  m_idHash = m_idHelper->straw_layer_hash(id);
}

TRT_BaseElement() [2/2]

InDetDD::TRT_BaseElement::TRT_BaseElement

(

const TRT_BaseElement &

right

)

Definition at line 32 of file TRT_BaseElement.cxx.

  : Trk::TrkDetElementBase(right.getMaterialGeom())
  , m_id(right.m_id)
  , m_idHash(right.m_idHash)
  , m_idHelper(right.m_idHelper)
  , m_conditions(right.m_conditions)
{}

~TRT_BaseElement()

virtual InDetDD::TRT_BaseElement::~TRT_BaseElement ( )

virtualdefault

Destructor:

Member Function Documentation

bounds() [1/2]

virtual const Trk::SurfaceBounds& InDetDD::TRT_BaseElement::bounds ( ) const

finaloverridevirtual

Straw layer bounds.

Implements Trk::TrkDetElementBase.

bounds() [2/2]

const Trk::SurfaceBounds & InDetDD::TRT_BaseElement::bounds ( const Identifier &  id ) const

finaloverridevirtual

Straw Surface: access to the bounds via Identifier.

Implements Trk::TrkDetElementBase.

Definition at line 72 of file TRT_BaseElement.cxx.

{
  return strawBounds();
}

calculateStrawTransform()

virtual HepGeom::Transform3D InDetDD::TRT_BaseElement::calculateStrawTransform ( int  straw ) const

pure virtual

to be overloaded by the extended classes

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

center() [1/2]

virtual const Amg::Vector3D& InDetDD::TRT_BaseElement::center ( ) const

finaloverridevirtual

Element Surface: center of a straw layer.

Implements Trk::TrkDetElementBase.

center() [2/2]

const Amg::Vector3D & InDetDD::TRT_BaseElement::center ( const Identifier &  id ) const

finaloverridevirtual

Straw Surface: Center of a straw using Identifier Straw center and straw axis can be obtained by the following: (The straw center is the center of the active region) Amg::Transform3D& transform = element->strawTransform(straw); Amb::Vector3D& center = element->strawCenter(); double r = element->strawCenter()->perp(); double phi = element->strawCenter()->phi(); Amg::Vector3D strawAxis = element->strawTransform(straw)* Vector3D(0,0,1) * strawDirection()

Implements Trk::TrkDetElementBase.

Definition at line 110 of file TRT_BaseElement.cxx.

{
  int straw = m_idHelper->straw(id);
  if (!m_strawSurfacesCache[straw]) {
    createSurfaceCache(id);
  }
  // forward the transform of the cache
  return m_strawSurfacesCache[straw]->center();
}

conditions()

const TRT_Conditions* InDetDD::TRT_BaseElement::conditions

(

)

const

Return the TRT_Conditions object associated to this Detector element.

createSurfaceCache() [1/2]

virtual void InDetDD::TRT_BaseElement::createSurfaceCache ( ) const

pure virtual

create the surface cache of the detector element, to be implementd in the deried class

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

createSurfaceCache() [2/2]

void InDetDD::TRT_BaseElement::createSurfaceCache

(

Identifier

id

)

const

create the surface & surface cache for the straw

Definition at line 161 of file TRT_BaseElement.cxx.

{
  int straw = m_idHelper->straw(id);
 
  // convert neccessary parts to Amg
  if (!m_strawSurfacesCache[straw]) {
    // create the surface cache & fill it
    m_strawSurfacesCache[straw].set(createSurfaceCacheHelper(straw));
  }
  // creaete the surface only if needed (the links are still intact)
  if (!m_strawSurfaces[straw]) {
    m_strawSurfaces[straw].set(
      std::make_unique<Trk::StraightLineSurface>(*this, id));
  }
}

createSurfaceCacheHelper()

std::unique_ptr< SurfaceCacheBase > InDetDD::TRT_BaseElement::createSurfaceCacheHelper ( int  straw ) const

private

Definition at line 178 of file TRT_BaseElement.cxx.

{
  // get the StrawTransform from GeoModel
  HepGeom::Transform3D cStrawTransform = calculateStrawTransform(straw);
  auto sTransform =
    Amg::Transform3D(Amg::CLHEPTransformToEigen(cStrawTransform));
  auto sCenter = Amg::Vector3D(sTransform.translation());
  // create the surface cache & fill it
  return std::make_unique<SurfaceCacheBase>(sTransform, sCenter);
}

defTransform()

const GeoTrf::Transform3D& InDetDD::TRT_BaseElement::defTransform

(

)

const

Get Default Transform (of module in barrel, layer in endcap) from GeoModel before alignment corrections.

deleteCache()

void InDetDD::TRT_BaseElement::deleteCache ( )

private

Helper method for cache dealing.

Definition at line 200 of file TRT_BaseElement.cxx.

{
  // for all straws
  for (auto & i : m_strawSurfacesCache) {
    i.store(nullptr);
  }
}

detectorType()

virtual Trk::DetectorElemType InDetDD::TRT_BaseElement::detectorType ( ) const

finaloverridevirtual

TrkDetElementBase interface detectorTyoe.

Implements Trk::TrkDetElementBase.

detectorTypeString()

std::string Trk::TrkDetElementBase::detectorTypeString ( ) const

inherited

Returns a string of the Detector element type.

Definition at line 10 of file TrkDetElementBase.cxx.

                                                         {
  auto type = detectorType();
  if (type == Trk::DetectorElemType::SolidState)
    return "SolidState";
  else if (type == Trk::DetectorElemType::Silicon)
    return "Silicon";
  else if (type == Trk::DetectorElemType::TRT)
    return "TRT";
  else if (type == Trk::DetectorElemType::Csc)
    return "Csc";
  else if (type == Trk::DetectorElemType::Mdt)
    return "Mdt";
  else if (type == Trk::DetectorElemType::Rpc)
    return "Rpc";
  else if (type == Trk::DetectorElemType::Tgc)
    return "Tgc";
  else if (type == Trk::DetectorElemType::sTgc)
    return "sTgc";
  else if (type == Trk::DetectorElemType::MM)
    return "Mm";
  return "Unknown";
}

elementSurface()

virtual const Trk::Surface& InDetDD::TRT_BaseElement::elementSurface ( ) const

pure virtual

creates surface for detector element, to be implemented in derived class

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

getAbsoluteTransform()

const HepGeom::Transform3D InDetDD::TRT_BaseElement::getAbsoluteTransform

(

int

straw

)

const

This is an alias to strawTransform(int straw)

Definition at line 42 of file TRT_BaseElement.cxx.

{
  return Amg::EigenTransformToCLHEP(strawTransform(straw));
}

identify()

virtual Identifier InDetDD::TRT_BaseElement::identify ( ) const

finaloverridevirtual

identifier of this detector element:

Implements Trk::TrkDetElementBase.

identifyHash()

virtual IdentifierHash InDetDD::TRT_BaseElement::identifyHash ( ) const

finaloverridevirtual

identifier hash

Implements Trk::TrkDetElementBase.

invalidate()

void InDetDD::TRT_BaseElement::invalidate

(

)

Invalidate cache.

Definition at line 190 of file TRT_BaseElement.cxx.

{
  // Invalidate the caches
  // Call and barrel or endcap specific invalidation
  invalidateOther();
  // Its enough to delete and zero the caches.
  deleteCache();
}

invalidateOther()

void InDetDD::TRT_BaseElement::invalidateOther ( ) const

inline

invalidate action on the cache

Definition at line 193 of file TRT_BaseElement.h.

{};

normal() [1/2]

virtual const Amg::Vector3D& InDetDD::TRT_BaseElement::normal ( ) const

finaloverridevirtual

Element Surface: normal of a straw layer.

Implements Trk::TrkDetElementBase.

normal() [2/2]

const Amg::Vector3D & InDetDD::TRT_BaseElement::normal ( const Identifier &  id ) const

finaloverridevirtual

Normal of a straw.

(Not very meaningful).

Implements Trk::TrkDetElementBase.

Definition at line 100 of file TRT_BaseElement.cxx.

{
  // Not sure if the normal of the straw is ever used.
  // nor is there a well defined normal.
  // This wont be corrected for alignments.
  // Just return the element normal
  return normal();
}

nStraws()

unsigned int InDetDD::TRT_BaseElement::nStraws

(

)

const

Number of straws in the element.

operator=()

const TRT_BaseElement& InDetDD::TRT_BaseElement::operator= ( const TRT_BaseElement &  right )

private

Illegal operations:

strawAxis()

Amg::Vector3D InDetDD::TRT_BaseElement::strawAxis

(

int

straw

)

const

Straw axis.

Always in direction of increasing eta. +ve z direction in barrel (for both +ve and -ve half) Away from beam pipe in -ve z endcap, Towards beam pipe in +ve endcap.

Definition at line 154 of file TRT_BaseElement.cxx.

{
  return (strawTransform(straw).linear() * Amg::Vector3D::UnitZ() *
          strawDirection());
}

strawBounds()

virtual const Trk::SurfaceBounds& InDetDD::TRT_BaseElement::strawBounds ( ) const

pure virtual

the straw bounds

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

strawCenter()

const Amg::Vector3D & InDetDD::TRT_BaseElement::strawCenter

(

int

straw

)

const

Straw Surface: Local -> global transform of the straw via integer.

Definition at line 143 of file TRT_BaseElement.cxx.

{
  if (!m_strawSurfacesCache[straw]) {
    Identifier id = m_idHelper->straw_id(identify(), straw);
    createSurfaceCache(id);
  }
  // forward the transform of the cache
  return m_strawSurfacesCache[straw]->center();
}

strawDirection()

virtual int InDetDD::TRT_BaseElement::strawDirection ( ) const

pure virtual

StrawDirection.

+1 if axis is in same direction as local z axis, -1 otherwise.

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

strawLength()

virtual const double& InDetDD::TRT_BaseElement::strawLength ( ) const

pure virtual

Active straw length.

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

strawSurface()

const Trk::StraightLineSurface & InDetDD::TRT_BaseElement::strawSurface

(

int

straw

)

const

Straw Surface: access to the surface via integer.

Definition at line 121 of file TRT_BaseElement.cxx.

{
  if (!m_strawSurfaces[straw]) {
    // get the straw identifier to the given straw number and element identifier
    Identifier id = m_idHelper->straw_id(identify(), straw);
    createSurfaceCache(id);
  }
  return *(m_strawSurfaces[straw].get());
}

strawTransform() [1/2]

const Amg::Transform3D & InDetDD::TRT_BaseElement::strawTransform

(

int

straw

)

const

Straw Surface: Local -> global transform of the straw via integer.

Definition at line 132 of file TRT_BaseElement.cxx.

{
  if (!m_strawSurfacesCache[straw]) {
    Identifier id = m_idHelper->straw_id(identify(), straw);
    createSurfaceCache(id);
  }
  // forward the transform of the cache
  return m_strawSurfacesCache[straw]->transform();
}

strawTransform() [2/2]

const Amg::Transform3D & InDetDD::TRT_BaseElement::strawTransform

(

unsigned int

straw

)

const

Straw transform - fast access in array, in Tracking frame: Amg.

Straw Surface: access to the transform of individual straw in Tracking frame: Amg

Definition at line 89 of file TRT_BaseElement.cxx.

{
  if (!m_strawSurfacesCache[straw]) {
    Identifier id = m_idHelper->straw_id(identify(), straw);
    createSurfaceCache(id);
  }
  // forward the transform of the cache
  return m_strawSurfacesCache[straw]->transform();
}

surface() [1/2]

virtual const Trk::Surface& InDetDD::TRT_BaseElement::surface ( ) const

finaloverridevirtual

Element Surface: access to the Surface (straw layer)

Implements Trk::TrkDetElementBase.

surface() [2/2]

const Trk::Surface & InDetDD::TRT_BaseElement::surface ( const Identifier &  id ) const

finaloverridevirtual

Straw Surface: access to the surface via identifier.

Implements Trk::TrkDetElementBase.

Definition at line 48 of file TRT_BaseElement.cxx.

{
  int straw = m_idHelper->straw(id);
  if (!m_strawSurfaces[straw]) {
    createSurfaceCache(id);
  }
  return *(m_strawSurfaces[straw]);
}

surfaces()

const std::vector< const Trk::Surface * > & InDetDD::TRT_BaseElement::surfaces

(

)

const

Returns the full list of all detection surfaces associated to this detector element.

Definition at line 58 of file TRT_BaseElement.cxx.

{
  if (!m_surfaces.isValid()) {
    std::vector<const Trk::Surface*> tmp_surfaces;
    tmp_surfaces.reserve(nStraws());
    for (unsigned is = 0; is < nStraws(); ++is) {
      tmp_surfaces.push_back(&strawSurface(is));
    }
    m_surfaces.set(tmp_surfaces);
  }
  return *(m_surfaces.ptr());
}

transform() [1/2]

virtual const Amg::Transform3D& InDetDD::TRT_BaseElement::transform ( ) const

finaloverridevirtual

Element Surface: Get Transform of element in Tracking frame: Amg.

Implements Trk::TrkDetElementBase.

transform() [2/2]

const Amg::Transform3D & InDetDD::TRT_BaseElement::transform ( const Identifier &  id ) const

finaloverridevirtual

Straw Surface: access to the transform of individual straw in Tracking frame: Amg.

Implements Trk::TrkDetElementBase.

Definition at line 78 of file TRT_BaseElement.cxx.

{
  int straw = m_idHelper->straw(id);
  if (!m_strawSurfacesCache[straw]) {
    createSurfaceCache(id);
  }
  // forward the transform of the cache
  return m_strawSurfacesCache[straw]->transform();
}

type()

virtual TRT_BaseElement::Type InDetDD::TRT_BaseElement::type ( ) const

pure virtual

Type information: returns BARREL or ENDCAP.

Implemented in InDetDD::TRT_BarrelElement, and InDetDD::TRT_EndcapElement.

updateAllCaches()

void InDetDD::TRT_BaseElement::updateAllCaches

(

)

Update all caches.

Definition at line 209 of file TRT_BaseElement.cxx.

{
  // delete the caches first
  deleteCache();
  // Strawlayer caches
  if (!m_surfaceCache.isValid()){
    createSurfaceCache();
  }
  // Loop over all straws and request items that get cached.
  for (unsigned int iStraw = 0; iStraw < nStraws(); iStraw++) {
    Identifier strawId = m_idHelper->straw_id(identify(), iStraw);
    createSurfaceCache(strawId);
  }
}

Member Data Documentation

m_conditions

const TRT_Conditions* InDetDD::TRT_BaseElement::m_conditions =nullptr

protected

Definition at line 213 of file TRT_BaseElement.h.

m_id

Identifier InDetDD::TRT_BaseElement::m_id

protected

Definition at line 204 of file TRT_BaseElement.h.

m_idHash

IdentifierHash InDetDD::TRT_BaseElement::m_idHash

protected

Definition at line 205 of file TRT_BaseElement.h.

m_idHelper

const TRT_ID* InDetDD::TRT_BaseElement::m_idHelper =nullptr

protected

Definition at line 212 of file TRT_BaseElement.h.

m_nstraws

unsigned int InDetDD::TRT_BaseElement::m_nstraws = 0

protected

Definition at line 211 of file TRT_BaseElement.h.

m_strawSurfaces

std::vector<CxxUtils::CachedUniquePtr<Trk::StraightLineSurface> > InDetDD::TRT_BaseElement::m_strawSurfaces {}

protected

Definition at line 216 of file TRT_BaseElement.h.

m_strawSurfacesCache

std::vector<CxxUtils::CachedUniquePtr<SurfaceCacheBase> > InDetDD::TRT_BaseElement::m_strawSurfacesCache {}

protected

helper element surface for the cache

Definition at line 217 of file TRT_BaseElement.h.

m_surface

CxxUtils::CachedUniquePtr<Trk::Surface> InDetDD::TRT_BaseElement::m_surface

protected

Definition at line 214 of file TRT_BaseElement.h.

m_surfaceCache

CxxUtils::CachedValue<SurfaceCache> InDetDD::TRT_BaseElement::m_surfaceCache

protected

Definition at line 220 of file TRT_BaseElement.h.

m_surfaces

CxxUtils::CachedValue<std::vector<const Trk::Surface*> > InDetDD::TRT_BaseElement::m_surfaces

protected

Definition at line 219 of file TRT_BaseElement.h.

---

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

• TRT_BaseElement.h
• TRT_BaseElement.cxx