Trk::MaterialLayerNoOwnSurf Class Reference

#include <MaterialLayer.h>

Inheritance diagram for Trk::MaterialLayerNoOwnSurf:

Collaboration diagram for Trk::MaterialLayerNoOwnSurf:

Public Member Functions
virtual	~MaterialLayerNoOwnSurf ()=default
	MaterialLayerNoOwnSurf (Surface *surfaceRepresentation, std::unique_ptr< LayerMaterialProperties > mlprop)
	Constructor allowing the Material to be attached to an existing surface It does NOT own the representation.
virtual const Surface &	surfaceRepresentation () const override final
	Transforms the layer into a Surface representation for extrapolation.
virtual Surface &	surfaceRepresentation () override final
virtual bool	isOnLayer (const Amg::Vector3D &gp, const BoundaryCheck &bcheck=BoundaryCheck(true)) const override final
	isOnLayer() method, using isOnSurface() with Layer specific tolerance
virtual void	moveLayer (Amg::Transform3D &) override final
	Move the layer - not implemented.
virtual void	resizeLayer (const VolumeBounds &, double) override final
	Resize the layer to the tracking volume - not implemented.
virtual void	resizeAndRepositionLayer (const VolumeBounds &, const Amg::Vector3D &, double) override final
	Resize the layer to the tracking volume - not implemented.
const SurfaceArray *	surfaceArray () const
	Return the entire SurfaceArray, returns nullptr if no SurfaceArray.
SurfaceArray *	surfaceArray ()
	Return the entire SurfaceArray, returns nullptr if no SurfaceArray.
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.
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.
const Surface *	subSurfaceReference (unsigned int idx=0) const
	Return a reference sub surface of the layer, usually the first one in the array.
double	thickness () const
	Return the Thickness of the Layer.
template<class T>
bool	onLayer (const T &parameters, const BoundaryCheck &bcheck=BoundaryCheck(true)) const
	templated on Layer method
const LayerMaterialProperties *	layerMaterialProperties () const
	getting the LayerMaterialProperties including full/pre/post update
const MaterialProperties *	fullUpdateMaterialProperties (const TrackParameters &par) const
	getting the MaterialProperties back - for full update
virtual double	preUpdateMaterialFactor (const TrackParameters &, PropDirection) const
	getting the MaterialProperties back - for pre-update
virtual double	postUpdateMaterialFactor (const TrackParameters &, PropDirection) const
	getting the MaterialProperties back - for pre-update
const OverlapDescriptor *	overlapDescriptor () const
	gettint hte overlap descriptor
const Layer *	previousLayer (bool skipNavLayer=false) const
	getting what's stored to be the previous Layer, boolean to skip navigation layers
void	setPreviousLayer (const Layer *)
	set the previous Layer
const Layer *	nextLayer (const Amg::Vector3D &gp, const Amg::Vector3D &udir) const
	getting the next/previous Layer if registered - unit for direction vector required
const Layer *	nextLayer (bool skipNavLayer=false) const
	getting what's stored to be the next Layer, boolean to skip navigation layers
void	setNextLayer (const Layer *)
	set the next Layer
const BinUtility *	binUtility () const
	access the BinUtility
void	setBinUtility (const BinUtility *)
	set the BinUtility
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().
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
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
virtual bool	hasSubStructure (bool resolveSensitive=false) const
	Has sub-structure method:
const TrackingVolume *	enclosingTrackingVolume () const
	get the confining TrackingVolume
const DetachedTrackingVolume *	enclosingDetachedTrackingVolume () const
	get the confining DetachedTrackingVolume
const LayerIndex &	layerIndex () const
	get the layerIndex
int	layerType () const
	get the Layer coding
void	setLayerType (int identifier)
	set the Layer coding
void	assignMaterialProperties (const LayerMaterialProperties &, double scale=1.0)
	assignMaterialPropeties
void	registerRepresentingVolume (const Volume *theVol)
	register Volume associated to the layer
const Volume *	representingVolume () const
	get the Volume associated to the layer
void	setRef (double)
	set the reference measure
double	getRef () const
	get the reference measure
void	encloseTrackingVolume (const TrackingVolume &tvol)
	private method to set the enclosed detached TV
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
void	compactify (size_t &cSurfaces, size_t &tSurfaces)
	register layer index for material map registration
void	registerLayerIndex (const LayerIndex &lIdx)

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

Private Attributes
Surface *	m_surfaceRepresentation {}

Detailed Description

Definition at line 93 of file MaterialLayer.h.

Constructor & Destructor Documentation

~MaterialLayerNoOwnSurf()

virtual Trk::MaterialLayerNoOwnSurf::~MaterialLayerNoOwnSurf ( )

virtualdefault

MaterialLayerNoOwnSurf()

Trk::MaterialLayerNoOwnSurf::MaterialLayerNoOwnSurf ( Surface * surfaceRepresentation, std::unique_ptr< LayerMaterialProperties > mlprop )

inline

Constructor allowing the Material to be attached to an existing surface It does NOT own the representation.

Definition at line 99 of file MaterialLayer.h.

      : Trk::MaterialLayer(), m_surfaceRepresentation(surfaceRepresentation) {
    m_layerMaterialProperties = std::move(mlprop);
    m_layerThickness = 1.;
  }

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::MaterialLayerNoOwnSurf::isOnLayer ( const Amg::Vector3D & gp, const BoundaryCheck & bcheck = BoundaryCheck(true) ) const

inlinefinaloverridevirtual

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

Implements Trk::MaterialLayer.

Definition at line 112 of file MaterialLayer.h.

                                                                            {
    return m_surfaceRepresentation->isOnSurface(gp, bcheck);
  }

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

inlinefinaloverridevirtualinherited

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::ConeLayer, Trk::CylinderLayer, Trk::DiscLayer, Trk::NavigationLayer, Trk::PlaneLayer, 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::ConeLayer, Trk::CylinderLayer, Trk::DiscLayer, Trk::NavigationLayer, Trk::PlaneLayer, 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  )

inlinefinaloverridevirtualinherited

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  )

inlinefinaloverridevirtualinherited

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::CylinderLayer, and Trk::DiscLayer.

Definition at line 209 of file Layer.cxx.

                                             {
  return surfaceRepresentation();
}

surfaceRepresentation() [1/2]

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

inlinefinaloverridevirtual

Transforms the layer into a Surface representation for extrapolation.

Implements Trk::MaterialLayer.

Definition at line 106 of file MaterialLayer.h.

                                                                      {
    return *m_surfaceRepresentation;
  }

surfaceRepresentation() [2/2]

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

inlinefinaloverridevirtual

Implements Trk::MaterialLayer.

Definition at line 109 of file MaterialLayer.h.

                                                          {
    return *m_surfaceRepresentation;
  }

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.

{-1};  

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.

{Trk::active}; 

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.

{};

m_surfaceRepresentation

Surface* Trk::MaterialLayerNoOwnSurf::m_surfaceRepresentation {}

private

Definition at line 119 of file MaterialLayer.h.

{};

---

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

• MaterialLayer.h