Trk::MaterialLayer Class Reference

#include <MaterialLayer.h>

Inheritance diagram for Trk::MaterialLayer:

Collaboration diagram for Trk::MaterialLayer:

Public Member Functions
	MaterialLayer ()=default
virtual	~MaterialLayer ()=default
virtual const Surface &	surfaceRepresentation () const override=0
	Transforms the layer into a Surface representation for extrapolation. More...
virtual Surface &	surfaceRepresentation () override=0
virtual bool	isOnLayer (const Amg::Vector3D &gp, const BoundaryCheck &bcheck=BoundaryCheck(true)) const override=0
	isOnLayer() method, using isOnSurface() with Layer specific tolerance More...
virtual void	moveLayer (Amg::Transform3D &) override final
	Move the layer - not implemented. More...
virtual void	resizeLayer (const VolumeBounds &, double) override final
	Resize the layer to the tracking volume - not implemented. More...
virtual void	resizeAndRepositionLayer (const VolumeBounds &, const Amg::Vector3D &, double) override final
	Resize the layer to the tracking volume - not implemented. More...
const SurfaceArray *	surfaceArray () const
	Return the entire SurfaceArray, returns nullptr if no SurfaceArray. More...
SurfaceArray *	surfaceArray ()
	Return the entire SurfaceArray, returns nullptr if no SurfaceArray. More...
const Surface *	subSurface (const Amg::Vector3D &gp) const
	If no subSurface array is defined or no subSurface can be found to the given Amg::Vector3D, it would return 0. More...
const Surface *	subSurface (const Amg::Vector2D &lp) const
	If no subSurface array is defined or no subSurface can be found to the given Amg::Vector2D, it would return 0. More...
const Surface *	subSurfaceReference (unsigned int idx=0) const
	Return a reference sub surface of the layer, usually the first one in the array. More...
double	thickness () const
	Return the Thickness of the Layer. More...
template<class T >
bool	onLayer (const T &parameters, const BoundaryCheck &bcheck=BoundaryCheck(true)) const
	templated on Layer method More...
const LayerMaterialProperties *	layerMaterialProperties () const
	getting the LayerMaterialProperties including full/pre/post update More...
const MaterialProperties *	fullUpdateMaterialProperties (const TrackParameters &par) const
	getting the MaterialProperties back - for full update More...
virtual double	preUpdateMaterialFactor (const TrackParameters &, PropDirection) const
	getting the MaterialProperties back - for pre-update More...
virtual double	postUpdateMaterialFactor (const TrackParameters &, PropDirection) const
	getting the MaterialProperties back - for pre-update More...
const OverlapDescriptor *	overlapDescriptor () const
	gettint hte overlap descriptor More...
const Layer *	previousLayer (bool skipNavLayer=false) const
	getting what's stored to be the previous Layer, boolean to skip navigation layers More...
void	setPreviousLayer (const Layer *)
	set the previous Layer More...
const Layer *	nextLayer (const Amg::Vector3D &gp, const Amg::Vector3D &udir) const
	getting the next/previous Layer if registered - unit for direction vector required More...
const Layer *	nextLayer (bool skipNavLayer=false) const
	getting what's stored to be the next Layer, boolean to skip navigation layers More...
void	setNextLayer (const Layer *)
	set the next Layer More...
const BinUtility *	binUtility () const
	access the BinUtility More...
void	setBinUtility (const BinUtility *)
	set the BinUtility More...
virtual const Surface &	surfaceOnApproach (const Amg::Vector3D &pos, const Amg::Vector3D &dir, PropDirection pdir, const BoundaryCheck &bcheck, bool resolveSubSurfaces=0, const ICompatibilityEstimator *ice=nullptr) const
	Surface seen on approach - if not defined differently, it is the surfaceRepresentation() More...
size_t	compatibleSurfaces (std::vector< SurfaceIntersection > &cSurfaces, const TrackParameters &pars, PropDirection pdir, const BoundaryCheck &bcheck, bool materialSurfacesOnly=true, const Surface *startSurface=nullptr, const Surface *endSurface=nullptr, const ICompatibilityEstimator *ice=nullptr) const
	get compatible surfaces starting from charged parameters More...
size_t	compatibleSurfaces (std::vector< SurfaceIntersection > &cSurfaces, const NeutralParameters &pars, PropDirection pdir, const BoundaryCheck &bcheck, bool materialSurfacesOnly=true, const Surface *startSurface=nullptr, const Surface *endSurface=nullptr, const ICompatibilityEstimator *ice=nullptr) const
	get compatible surfaces starting from neutral parameters More...
virtual bool	hasSubStructure (bool resolveSensitive=false) const
	Has sub-structure method: More...
const TrackingVolume *	enclosingTrackingVolume () const
	get the confining TrackingVolume More...
const DetachedTrackingVolume *	enclosingDetachedTrackingVolume () const
	get the confining DetachedTrackingVolume More...
const LayerIndex &	layerIndex () const
	get the layerIndex More...
int	layerType () const
	get the Layer coding More...
void	setLayerType (int identifier)
	set the Layer coding More...
void	assignMaterialProperties (const LayerMaterialProperties &, double scale=1.0)
	assignMaterialPropeties More...
void	registerRepresentingVolume (const Volume *theVol)
	register Volume associated to the layer More...
const Volume *	representingVolume () const
	get the Volume associated to the layer More...
void	setRef (double)
	set the reference measure More...
double	getRef () const
	get the reference measure More...
void	encloseTrackingVolume (const TrackingVolume &tvol)
	private method to set the enclosed detached TV More...
void	encloseDetachedTrackingVolume (const DetachedTrackingVolume &tvol)
template<class T >
size_t	getCompatibleSurfaces (std::vector< SurfaceIntersection > &cSurfaces, const T &pars, PropDirection pdir, const BoundaryCheck &bcheck, bool materialSurfacesOnly=true, const Surface *startSurface=nullptr, const Surface *endSurface=nullptr, const ICompatibilityEstimator *ice=nullptr) const
	get compatible surfaces starting from charged parameters More...
void	compactify (size_t &cSurfaces, size_t &tSurfaces)
	register layer index for material map registration More...
void	registerLayerIndex (const LayerIndex &lIdx)

Protected Attributes
std::unique_ptr< SurfaceArray >	m_surfaceArray {}
	MaterialPoperties of this layer Surface. More...
std::unique_ptr< LayerMaterialProperties >	m_layerMaterialProperties {}
	thickness of the Layer More...
double	m_layerThickness {}
	descriptor for overlap/next surface (owning ptr) More...
std::unique_ptr< OverlapDescriptor >	m_overlapDescriptor {}
const Layer *	m_previousLayer = nullptr
	< the previous Layer according to BinGenUtils More...
const Layer *	m_nextLayer = nullptr
	BinUtility for next/previous decision. More...
const BinUtility *	m_binUtility = nullptr
	Enclosing TrackingVolume. More...
const TrackingVolume *	m_enclosingTrackingVolume = nullptr
	Enclosing DetachedTrackingVolume. More...
const DetachedTrackingVolume *	m_enclosingDetachedTrackingVolume = nullptr
LayerIndex	m_index {-1}
	LayerIndex. More...
int	m_layerType {Trk::active}
	active passive layer More...
double	m_ref {}
	reference measure for local coordinate convertors More...

Detailed Description

A material layer is a simple helper class to attach material information to a boundary surface. There is a complication as they are two use cases

1) We attach the material layer to an existing surface via setMaterialLayer in this case the material layer should NOT own the surface. 2) We constuct a material layer with some surface representation. In which case it owns it

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Christos Anastopoulos (Athena MT modifications)

Definition at line 42 of file MaterialLayer.h.

Constructor & Destructor Documentation

MaterialLayer()

Trk::MaterialLayer::MaterialLayer ( )

default

~MaterialLayer()

virtual Trk::MaterialLayer::~MaterialLayer ( )

virtualdefault

Member Function Documentation

assignMaterialProperties()

void Trk::Layer::assignMaterialProperties ( const LayerMaterialProperties &  prop, double  scale = 1.0  )

inherited

assignMaterialPropeties

Definition at line 177 of file Layer.cxx.

                                                        {
  m_layerMaterialProperties.reset(prop.clone());
  if (scale != 1.0) {
    (*(m_layerMaterialProperties)) *= scale;
  }
}

binUtility()

const BinUtility* Trk::Layer::binUtility ( ) const

inherited

access the BinUtility

compactify()

void Trk::Layer::compactify ( size_t &  cSurfaces, size_t &  tSurfaces  )

inherited

register layer index for material map registration

Definition at line 186 of file Layer.cxx.

{
  // set the layer surface representation
  ++tSurfaces;
  if (surfaceRepresentation().owner() == Trk::noOwn) {
    surfaceRepresentation().setOwner(Trk::TGOwn);
    ++cSurfaces;
  }
  // set the subsurface representation, usually already owned by DetElement
  if (m_surfaceArray) {
    std::span<Trk::Surface * const> surfaces = m_surfaceArray->arrayObjects();
    for (Trk::Surface * const sIter : surfaces) {
      if (sIter && (*sIter).owner() == Trk::noOwn) {
        (*sIter).setOwner(Trk::TGOwn);
        ++cSurfaces;
      }
      ++tSurfaces;
    }
  }
}

compatibleSurfaces() [1/2]

size_t Trk::Layer::compatibleSurfaces ( std::vector< SurfaceIntersection > &  cSurfaces, const NeutralParameters &  pars, PropDirection  pdir, const BoundaryCheck &  bcheck, bool  materialSurfacesOnly = true, const Surface *  startSurface = nullptr, const Surface *  endSurface = nullptr, const ICompatibilityEstimator *  ice = nullptr  ) const

inherited

get compatible surfaces starting from neutral parameters

compatibleSurfaces() [2/2]

size_t Trk::Layer::compatibleSurfaces ( std::vector< SurfaceIntersection > &  cSurfaces, const TrackParameters &  pars, PropDirection  pdir, const BoundaryCheck &  bcheck, bool  materialSurfacesOnly = true, const Surface *  startSurface = nullptr, const Surface *  endSurface = nullptr, const ICompatibilityEstimator *  ice = nullptr  ) const

inherited

get compatible surfaces starting from charged parameters

encloseDetachedTrackingVolume()

void Trk::Layer::encloseDetachedTrackingVolume ( const DetachedTrackingVolume &  tvol )

inherited

encloseTrackingVolume()

void Trk::Layer::encloseTrackingVolume ( const TrackingVolume &  tvol )

inherited

private method to set the enclosed detached TV

enclosingDetachedTrackingVolume()

const DetachedTrackingVolume* Trk::Layer::enclosingDetachedTrackingVolume ( ) const

inherited

get the confining DetachedTrackingVolume

enclosingTrackingVolume()

const TrackingVolume* Trk::Layer::enclosingTrackingVolume ( ) const

inherited

get the confining TrackingVolume

fullUpdateMaterialProperties()

const Trk::MaterialProperties * Trk::Layer::fullUpdateMaterialProperties ( const TrackParameters &  par ) const

inherited

getting the MaterialProperties back - for full update

Definition at line 169 of file Layer.cxx.

                                          {
  if (m_layerMaterialProperties){
    return m_layerMaterialProperties->fullMaterial(parm.position());
  }
  return nullptr;
}

getCompatibleSurfaces()

template<class T >

size_t Trk::Layer::getCompatibleSurfaces ( std::vector< SurfaceIntersection > &  cSurfaces, const T &  pars, PropDirection  pdir, const BoundaryCheck &  bcheck, bool  materialSurfacesOnly = true, const Surface *  startSurface = nullptr, const Surface *  endSurface = nullptr, const ICompatibilityEstimator *  ice = nullptr  ) const

inherited

get compatible surfaces starting from charged parameters

propagate TrackingGeometry owner downstream

getRef()

double Trk::Layer::getRef ( ) const

inherited

get the reference measure

hasSubStructure()

bool Trk::Layer::hasSubStructure ( bool  resolveSensitive = false ) const

virtualinherited

Has sub-structure method:

• sub-structure depending on : (a) only when required to resolve sub surfaces for sensitive hits (b) also material is ordered with sub structure

Definition at line 238 of file Layer.cxx.

                                                          {
  return resolveSensitive && m_surfaceArray;
}

isOnLayer()

virtual bool Trk::MaterialLayer::isOnLayer ( const Amg::Vector3D &  gp, const BoundaryCheck &  bcheck = BoundaryCheck(true)  ) const

overridepure virtual

isOnLayer() method, using isOnSurface() with Layer specific tolerance

Reimplemented from Trk::Layer.

Implemented in Trk::MaterialLayerNoOwnSurf, and Trk::MaterialLayerOwnSurf.

layerIndex()

const LayerIndex& Trk::Layer::layerIndex ( ) const

inherited

get the layerIndex

layerMaterialProperties()

const LayerMaterialProperties* Trk::Layer::layerMaterialProperties ( ) const

inherited

getting the LayerMaterialProperties including full/pre/post update

layerType()

int Trk::Layer::layerType ( ) const

inherited

get the Layer coding

moveLayer()

virtual void Trk::MaterialLayer::moveLayer ( Amg::Transform3D &  )

inlinefinaloverridevirtual

Move the layer - not implemented.

Implements Trk::Layer.

Definition at line 56 of file MaterialLayer.h.

{};

nextLayer() [1/2]

const Trk::Layer * Trk::Layer::nextLayer ( bool  skipNavLayer = false ) const

inherited

getting what's stored to be the next Layer, boolean to skip navigation layers

Definition at line 151 of file Layer.cxx.

                                                           {
  if (!skipNavLayer) return m_nextLayer;
  const Trk::Layer* nextMatLayer = m_nextLayer;
  // get the next Material layer
  while (nextMatLayer && !nextMatLayer->layerMaterialProperties() &&
         !nextMatLayer->surfaceArray())
    nextMatLayer = nextMatLayer->nextLayer();
  return nextMatLayer;
}

nextLayer() [2/2]

const Trk::Layer * Trk::Layer::nextLayer ( const Amg::Vector3D &  gp, const Amg::Vector3D &  udir  ) const

inherited

getting the next/previous Layer if registered - unit for direction vector required

Definition at line 161 of file Layer.cxx.

                                                                      {
  // no binutility -> no chance to find out the direction
  if (!m_binUtility) return nullptr;
  return (m_binUtility->orderDirection(gp, mom) == Trk::next) ? m_nextLayer
                                                              : m_previousLayer;
}

onLayer()

template<class T >

bool Trk::Layer::onLayer ( const T &  parameters, const BoundaryCheck &  bcheck = BoundaryCheck(true)  ) const

inherited

templated on Layer method

overlapDescriptor()

const OverlapDescriptor* Trk::Layer::overlapDescriptor ( ) const

inherited

gettint hte overlap descriptor

postUpdateMaterialFactor()

virtual double Trk::Layer::postUpdateMaterialFactor ( const TrackParameters &  , PropDirection    ) const

inlinevirtualinherited

getting the MaterialProperties back - for pre-update

Reimplemented in Trk::CylinderLayer, Trk::DiscLayer, Trk::ConeLayer, Trk::PlaneLayer, Trk::NavigationLayer, Trk::SubtractedCylinderLayer, and Trk::SubtractedPlaneLayer.

Definition at line 150 of file Layer.h.

                                                               {
    return 0.;
  }

preUpdateMaterialFactor()

virtual double Trk::Layer::preUpdateMaterialFactor ( const TrackParameters &  , PropDirection    ) const

inlinevirtualinherited

getting the MaterialProperties back - for pre-update

Reimplemented in Trk::CylinderLayer, Trk::DiscLayer, Trk::ConeLayer, Trk::PlaneLayer, Trk::NavigationLayer, Trk::SubtractedCylinderLayer, and Trk::SubtractedPlaneLayer.

Definition at line 144 of file Layer.h.

                                                              {
    return 1.;
  }

previousLayer()

const Trk::Layer * Trk::Layer::previousLayer ( bool  skipNavLayer = false ) const

inherited

getting what's stored to be the previous Layer, boolean to skip navigation layers

Definition at line 141 of file Layer.cxx.

                                                               {
  if (!skipNavLayer) return m_previousLayer;
  const Trk::Layer* prevMatLayer = m_previousLayer;
  // get the previoys Material layer
  while (prevMatLayer && !prevMatLayer->layerMaterialProperties() &&
         !prevMatLayer->surfaceArray())
    prevMatLayer = prevMatLayer->previousLayer();
  return prevMatLayer;
}

registerLayerIndex()

void Trk::Layer::registerLayerIndex ( const LayerIndex &  lIdx )

inherited

registerRepresentingVolume()

void Trk::Layer::registerRepresentingVolume ( const Volume *  theVol )

inherited

register Volume associated to the layer

representingVolume()

const Volume* Trk::Layer::representingVolume ( ) const

inherited

get the Volume associated to the layer

resizeAndRepositionLayer()

virtual void Trk::MaterialLayer::resizeAndRepositionLayer ( const VolumeBounds &  , const Amg::Vector3D &  , double    )

inlinefinaloverridevirtual

Resize the layer to the tracking volume - not implemented.

Implements Trk::Layer.

Definition at line 60 of file MaterialLayer.h.

                                                               {}

resizeLayer()

virtual void Trk::MaterialLayer::resizeLayer ( const VolumeBounds &  , double    )

inlinefinaloverridevirtual

Resize the layer to the tracking volume - not implemented.

Implements Trk::Layer.

Definition at line 58 of file MaterialLayer.h.

{}

setBinUtility()

void Trk::Layer::setBinUtility ( const BinUtility *  )

inherited

set the BinUtility

setLayerType()

void Trk::Layer::setLayerType ( int  identifier )

inherited

set the Layer coding

setNextLayer()

void Trk::Layer::setNextLayer ( const Layer *  )

inherited

set the next Layer

setPreviousLayer()

void Trk::Layer::setPreviousLayer ( const Layer *  )

inherited

set the previous Layer

setRef()

void Trk::Layer::setRef ( double  )

inherited

set the reference measure

subSurface() [1/2]

const Trk::Surface * Trk::Layer::subSurface ( const Amg::Vector2D &  lp ) const

inherited

If no subSurface array is defined or no subSurface can be found to the given Amg::Vector2D, it would return 0.

Definition at line 112 of file Layer.cxx.

                                                                  {
  if (m_surfaceArray) return m_surfaceArray->object(lp);
  return nullptr;
}

subSurface() [2/2]

const Trk::Surface * Trk::Layer::subSurface ( const Amg::Vector3D &  gp ) const

inherited

If no subSurface array is defined or no subSurface can be found to the given Amg::Vector3D, it would return 0.

Definition at line 107 of file Layer.cxx.

                                                                  {
  if (m_surfaceArray) return m_surfaceArray->object(gp);
  return nullptr;
}

subSurfaceReference()

const Trk::Surface * Trk::Layer::subSurfaceReference ( unsigned int  idx = 0 ) const

inherited

Return a reference sub surface of the layer, usually the first one in the array.

• if an index is given (and the index is in range), this surface is returned

Definition at line 117 of file Layer.cxx.

                                                                      {
  // the reference surface
  const Trk::Surface* referenceSurface = nullptr;
  if (m_surfaceArray) {
    // get a reference surface
    std::span<Trk::Surface const * const> surfaces =  std::as_const(*m_surfaceArray).arrayObjects();
    // get a reference surface
    unsigned int rfSurfaces = surfaces.size();
    if (idx && idx < rfSurfaces) return surfaces[idx];
    // get the first one which is non zero
    for (unsigned int rsf = 0; rsf < rfSurfaces; ++rsf) {
      referenceSurface = surfaces[rsf];
      if (referenceSurface) break;
    }
  }
  return referenceSurface;
}

surfaceArray() [1/2]

SurfaceArray* Trk::Layer::surfaceArray ( )

inherited

Return the entire SurfaceArray, returns nullptr if no SurfaceArray.

surfaceArray() [2/2]

const SurfaceArray* Trk::Layer::surfaceArray ( ) const

inherited

Return the entire SurfaceArray, returns nullptr if no SurfaceArray.

surfaceOnApproach()

const Trk::Surface & Trk::Layer::surfaceOnApproach ( const Amg::Vector3D &  pos, const Amg::Vector3D &  dir, PropDirection  pdir, const BoundaryCheck &  bcheck, bool  resolveSubSurfaces = 0, const ICompatibilityEstimator *  ice = nullptr  ) const

virtualinherited

Surface seen on approach - if not defined differently, it is the surfaceRepresentation()

Reimplemented in Trk::DiscLayer, and Trk::CylinderLayer.

Definition at line 209 of file Layer.cxx.

                                             {
  return surfaceRepresentation();
}

surfaceRepresentation() [1/2]

virtual const Surface& Trk::MaterialLayer::surfaceRepresentation ( ) const

overridepure virtual

Transforms the layer into a Surface representation for extrapolation.

Implements Trk::Layer.

Implemented in Trk::MaterialLayerNoOwnSurf, and Trk::MaterialLayerOwnSurf.

surfaceRepresentation() [2/2]

virtual Surface& Trk::MaterialLayer::surfaceRepresentation ( )

overridepure virtual

Implements Trk::Layer.

Implemented in Trk::MaterialLayerNoOwnSurf, and Trk::MaterialLayerOwnSurf.

thickness()

double Trk::Layer::thickness ( ) const

inherited

Return the Thickness of the Layer.

Member Data Documentation

m_binUtility

const BinUtility* Trk::Layer::m_binUtility = nullptr

protectedinherited

Enclosing TrackingVolume.

Definition at line 300 of file Layer.h.

m_enclosingDetachedTrackingVolume

const DetachedTrackingVolume* Trk::Layer::m_enclosingDetachedTrackingVolume = nullptr

protectedinherited

Definition at line 304 of file Layer.h.

m_enclosingTrackingVolume

const TrackingVolume* Trk::Layer::m_enclosingTrackingVolume = nullptr

protectedinherited

Enclosing DetachedTrackingVolume.

Definition at line 302 of file Layer.h.

m_index

LayerIndex Trk::Layer::m_index {-1}

protectedinherited

LayerIndex.

Definition at line 306 of file Layer.h.

m_layerMaterialProperties

std::unique_ptr<LayerMaterialProperties> Trk::Layer::m_layerMaterialProperties {}

protectedinherited

thickness of the Layer

Definition at line 288 of file Layer.h.

m_layerThickness

double Trk::Layer::m_layerThickness {}

protectedinherited

descriptor for overlap/next surface (owning ptr)

Definition at line 290 of file Layer.h.

m_layerType

int Trk::Layer::m_layerType {Trk::active}

protectedinherited

active passive layer

Definition at line 307 of file Layer.h.

m_nextLayer

const Layer* Trk::Layer::m_nextLayer = nullptr

protectedinherited

BinUtility for next/previous decision.

Definition at line 298 of file Layer.h.

m_overlapDescriptor

std::unique_ptr<OverlapDescriptor> Trk::Layer::m_overlapDescriptor {}

protectedinherited

Definition at line 292 of file Layer.h.

m_previousLayer

const Layer* Trk::Layer::m_previousLayer = nullptr

protectedinherited

< the previous Layer according to BinGenUtils

next Layer according to BinGenUtils

Definition at line 296 of file Layer.h.

m_ref

double Trk::Layer::m_ref {}

protectedinherited

reference measure for local coordinate convertors

Definition at line 308 of file Layer.h.

m_surfaceArray

std::unique_ptr<SurfaceArray> Trk::Layer::m_surfaceArray {}

protectedinherited

MaterialPoperties of this layer Surface.

Definition at line 286 of file Layer.h.

---

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

• MaterialLayer.h