#include <CompoundLayerMaterial.h>

Inheritance diagram for Trk::CompoundLayerMaterial:

Collaboration diagram for Trk::CompoundLayerMaterial:

Public Member Functions
	CompoundLayerMaterial ()
	Default Constructor - needed by POOL. More...

	CompoundLayerMaterial (const Trk::BinUtility &binutility, const ValueStore &thicknessBins, const ValueStore &x0Bins, const ValueStore &l0Bins, const ValueStore &aBins, const ValueStore &zBins, const ValueStore &rhoBins, const std::vector< std::vector< MaterialComposition > > &composition, bool fComposition=false)
	Explizit constructor. More...

	CompoundLayerMaterial (const CompoundLayerMaterial &mprop)
	Copy Constructor. More...

virtual	~CompoundLayerMaterial () override
	Destructor. More...

virtual CompoundLayerMaterial *	clone () const override final
	Pseudo-Constructor clone() More...

CompoundLayerMaterial &	operator= (const CompoundLayerMaterial &lmp)
	Assignment operator. More...

virtual CompoundLayerMaterial &	operator*= (double scale) override final
	Scale operator. More...

virtual const BinUtility *	binUtility () const override final
	Return the BinUtility. More...

virtual void	updateBinning (BinUtility *bu) override final
	Update the BinUtility if necessary - passing ownership of the utility class. More...

virtual const MaterialProperties *	fullMaterial (const Amg::Vector3D &gp) const override final
	Return method for full material description of the Layer. More...

virtual const MaterialProperties *	material (size_t bin0, size_t bin1) const override final
	Access the single bin. More...

void	updateElementTable (const SharedObject< const ElementTable > &set)
	Update the ElementTable. More...

const ElementTable *	elementTable () const
	Get the ElementTable. More...

virtual MsgStream &	dump (MsgStream &sl) const override final
	Output Method for MsgStream, to be overloaded by child classes. More...

virtual std::ostream &	dump (std::ostream &sl) const override final
	Output Method for std::ostream, to be overloaded by child classes. More...

void	updateElementTable (const SharedObject< const ElementTable > &) const
	Update the ElementTable. More...

double	factor (PropDirection pDir, MaterialUpdateStage mStage) const
	Update pre factor. More...

double	alongPreFactor () const
	Return method for pre update material description of the Layer along normalvector. More...

double	alongPostFactor () const
	Return method for post update material description of the Layer along normalvector. More...

double	oppositePreFactor () const
	Return method for pre update material description of the Layer along normalvector. More...

double	oppositePostFactor () const
	Return method for post update material description of the Layer along normalvector. More...

Protected Attributes
double	m_splitFactor
	the split factor in favour of oppositePre More...

Private Types
using	MaterialPropertiesCUP = CxxUtils::CachedUniquePtr< MaterialProperties >

Private Member Functions
void	resizeMaterialProperties ()

Private Attributes
std::vector< std::vector< MaterialPropertiesCUP > >	m_materialProperties
	the ones you return More...

BinUtility *	m_binUtility
	the helper for the bin finding More...

ValueStore	m_thicknessBins
	thickness parameter More...

ValueStore	m_x0Bins
	x0 parameter More...

ValueStore	m_l0Bins
	l0 parameter More...

ValueStore	m_aBins
	A parameters (averaged) More...

ValueStore	m_zBins
	Z parameter (averaged) More...

ValueStore	m_rhoBins
	rho parameter (averaged) More...

std::vector< std::vector< MaterialComposition > >	m_composition
	composition matrix More...

bool	m_fullComposition
	full composition calculation More...

SharedObject< const ElementTable >	m_elementTable

Friends
class	::CompoundLayerMaterialCnv_p1

Detailed Description

It extends the LayerMaterialProperties base class, and has a intrinsic accuracy of about 0.5 % on the dynamic range from using unsigned char

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

Definition at line 60 of file CompoundLayerMaterial.h.

Member Typedef Documentation

◆ MaterialPropertiesCUP

using Trk::CompoundLayerMaterial::MaterialPropertiesCUP = CxxUtils::CachedUniquePtr<MaterialProperties>

private

Definition at line 121 of file CompoundLayerMaterial.h.

Constructor & Destructor Documentation

◆ CompoundLayerMaterial() [1/3]

Trk::CompoundLayerMaterial::CompoundLayerMaterial ( )

Default Constructor - needed by POOL.

Definition at line 13 of file CompoundLayerMaterial.cxx.

     : Trk::LayerMaterialProperties(),
       m_materialProperties(),
       m_binUtility(nullptr),
       m_fullComposition(false),
       m_elementTable(Trk::SharedObject<const Trk::ElementTable>(nullptr)) {}

◆ CompoundLayerMaterial() [2/3]

Trk::CompoundLayerMaterial::CompoundLayerMaterial	(	const Trk::BinUtility &	binutility,
		const ValueStore &	thicknessBins,
		const ValueStore &	x0Bins,
		const ValueStore &	l0Bins,
		const ValueStore &	aBins,
		const ValueStore &	zBins,
		const ValueStore &	rhoBins,
		const std::vector< std::vector< MaterialComposition > > &	composition,
		bool	fComposition = `false`
	)

Explizit constructor.

Definition at line 20 of file CompoundLayerMaterial.cxx.

     : m_binUtility(binutility.clone()),
       m_thicknessBins(thicknessBins),
       m_x0Bins(x0Bins),
       m_l0Bins(l0Bins),
       m_aBins(aBins),
       m_zBins(zBins),
       m_rhoBins(rhoBins),
       m_composition(composition),
       m_fullComposition(fComposition),
       m_elementTable(Trk::SharedObject<const Trk::ElementTable>(nullptr))
 {
   resizeMaterialProperties();
 }

◆ CompoundLayerMaterial() [3/3]

Trk::CompoundLayerMaterial::CompoundLayerMaterial ( const CompoundLayerMaterial & mprop )

Copy Constructor.

Definition at line 40 of file CompoundLayerMaterial.cxx.

     : Trk::LayerMaterialProperties(clm),
       m_binUtility(clm.m_binUtility->clone()),
       m_thicknessBins(clm.m_thicknessBins),
       m_x0Bins(clm.m_x0Bins),
       m_l0Bins(clm.m_l0Bins),
       m_aBins(clm.m_aBins),
       m_zBins(clm.m_zBins),
       m_rhoBins(clm.m_rhoBins),
       m_composition(clm.m_composition),
       m_fullComposition(clm.m_fullComposition),
       m_elementTable(clm.m_elementTable)
 {
   resizeMaterialProperties();
 }

◆ ~CompoundLayerMaterial()

Trk::CompoundLayerMaterial::~CompoundLayerMaterial ( )

overridevirtual

Destructor.

Definition at line 79 of file CompoundLayerMaterial.cxx.

                                                  {
   delete m_binUtility;
 }

Member Function Documentation

◆ alongPostFactor()

double Trk::LayerMaterialProperties::alongPostFactor ( ) const

inlineinherited

Return method for post update material description of the Layer along normalvector.

Definition at line 142 of file LayerMaterialProperties.h.

                                                              {
   return m_splitFactor;
 }

◆ alongPreFactor()

double Trk::LayerMaterialProperties::alongPreFactor ( ) const

inlineinherited

Return method for pre update material description of the Layer along normalvector.

inline return methods for the pre/post factors

Definition at line 138 of file LayerMaterialProperties.h.

                                                             {
   return (1. - m_splitFactor);
 }

◆ binUtility()

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

inlinefinaloverridevirtual

Return the BinUtility.

Implements Trk::LayerMaterialProperties.

Definition at line 139 of file CompoundLayerMaterial.h.

                                                                  {
   return m_binUtility;
 }

◆ clone()

Trk::CompoundLayerMaterial * Trk::CompoundLayerMaterial::clone ( ) const

finaloverridevirtual

Pseudo-Constructor clone()

Implements Trk::LayerMaterialProperties.

Definition at line 83 of file CompoundLayerMaterial.cxx.

                                                                 {
   return new Trk::CompoundLayerMaterial(*this);
 }

◆ dump() [1/2]

MsgStream & Trk::CompoundLayerMaterial::dump ( MsgStream & sl ) const

finaloverridevirtual

Output Method for MsgStream, to be overloaded by child classes.

Implements Trk::LayerMaterialProperties.

Definition at line 153 of file CompoundLayerMaterial.cxx.

                                                              {
   sl << "Trk::CompoundLayerMaterial : \n";
   sl << "   - Number of Material bins (1/2) : " << m_binUtility->max(0) + 1
      << " / " << m_binUtility->max(1) + 1 << "\n";
   return sl;
 }

◆ dump() [2/2]

std::ostream & Trk::CompoundLayerMaterial::dump ( std::ostream & sl ) const

finaloverridevirtual

Output Method for std::ostream, to be overloaded by child classes.

Implements Trk::LayerMaterialProperties.

Definition at line 160 of file CompoundLayerMaterial.cxx.

                                                                {
   sl << "Trk::CompoundLayerMaterial : " << std::endl;
   sl << "   - Number of Material bins (1/2) : " << m_binUtility->max(0) + 1
      << " / " << m_binUtility->max(1) + 1 << std::endl;
   return sl;
 }

◆ elementTable()

const ElementTable * Trk::CompoundLayerMaterial::elementTable ( ) const

inline

Get the ElementTable.

Definition at line 155 of file CompoundLayerMaterial.h.

                                                                      {
   return m_elementTable.get();
 }

◆ factor()

double Trk::LayerMaterialProperties::factor	(	PropDirection	pDir,
		MaterialUpdateStage	mStage
	)		const

inlineinherited

Update pre factor.

inline return methods for the pre/post factors

Definition at line 130 of file LayerMaterialProperties.h.

                                                           {
   if (mStage == Trk::fullUpdate) return 1.;
   return (static_cast<int>(pDir) * static_cast<int>(mStage) > 0 ?
           m_splitFactor : 1. - m_splitFactor);
 }

◆ fullMaterial()

const Trk::MaterialProperties * Trk::CompoundLayerMaterial::fullMaterial ( const Amg::Vector3D & gp ) const

finaloverridevirtual

Return method for full material description of the Layer.

Implements Trk::LayerMaterialProperties.

Definition at line 93 of file CompoundLayerMaterial.cxx.

                                  {
   // first bin
   size_t bin0 = m_binUtility->bin(gp, 0);
   // second bin
   size_t bin1 = (m_binUtility->max(1) == 0) ? 0 : m_binUtility->bin(gp, 1);
   return material(bin0, bin1);
 }

◆ material()

const Trk::MaterialProperties * Trk::CompoundLayerMaterial::material	(	size_t	bin0,
		size_t	bin1
	)		const

finaloverridevirtual

Access the single bin.

<

Todo:: measure if this is slow

Implements Trk::LayerMaterialProperties.

Definition at line 102 of file CompoundLayerMaterial.cxx.

 {
   const MaterialPropertiesCUP& p = m_materialProperties[bin1][bin0];
   if (!p) {
     // get the size
     const double thickness = m_thicknessBins.value(bin0, bin1);
     // no thickness or no x0 - return a null pointer
     if (thickness == 0.) return nullptr;
     double x0 = 0.;
     double l0 = 0.;
     double a = 0.;
     double z = 0.;
     double rho = 0.;
     // the full composition calculation
     if (m_fullComposition && m_elementTable.get()) {
       for (const auto& eFraction : m_composition[bin1][bin0]) {
         double fraction = eFraction.fraction();
         const Trk::Material* material =
           m_elementTable->element(eFraction.element());
         if (material) {
           x0 += material->X0 * fraction;
           l0 += material->L0 * fraction;
           a += material->A * fraction;
           z += material->Z * fraction;
           rho += material->rho * fraction;
         }
       }
     } else {
       x0 = m_x0Bins.value(bin0, bin1);
       l0 = m_l0Bins.value(bin0, bin1);
       a = m_aBins.value(bin0, bin1);
       z = m_zBins.value(bin0, bin1);
       rho = m_rhoBins.value(bin0, bin1);
     }
     
     // check for 0 material
     if (x0 == 0.) {
       return nullptr;
     }
  
     // record the material composition
     Trk::MaterialComposition* mComposition =
       new Trk::MaterialComposition(m_composition[bin1][bin0]);
     p.set (std::make_unique<Trk::MaterialProperties>
             (Trk::Material(x0, l0, a, z, rho, 0., mComposition), thickness));
   }
   return p.get();
 }

◆ operator*=()

Trk::CompoundLayerMaterial & Trk::CompoundLayerMaterial::operator*= ( double scale )

finaloverridevirtual

Scale operator.

<

Todo:: implement

Implements Trk::LayerMaterialProperties.

Definition at line 87 of file CompoundLayerMaterial.cxx.

                                                                      {
   // scale the reference material
   return (*this);
 }

◆ operator=()

Trk::CompoundLayerMaterial & Trk::CompoundLayerMaterial::operator= ( const CompoundLayerMaterial & lmp )

Assignment operator.

Definition at line 57 of file CompoundLayerMaterial.cxx.

                                          {
   if (this != &clm) {
     delete m_binUtility;
     m_materialProperties.clear();
  
     m_binUtility = clm.m_binUtility->clone();
     m_thicknessBins = clm.m_thicknessBins;
     m_x0Bins = clm.m_x0Bins;
     m_l0Bins = clm.m_l0Bins;
     m_aBins = clm.m_aBins;
     m_zBins = clm.m_zBins;
     m_rhoBins = clm.m_rhoBins;
     m_composition = clm.m_composition;
     m_fullComposition = clm.m_fullComposition;
     m_elementTable = clm.m_elementTable;
  
     resizeMaterialProperties();
   }
   return (*this);
 }

◆ oppositePostFactor()

double Trk::LayerMaterialProperties::oppositePostFactor ( ) const

inlineinherited

Return method for post update material description of the Layer along normalvector.

Definition at line 150 of file LayerMaterialProperties.h.

                                                                 {
   return (1. - m_splitFactor);
 }

◆ oppositePreFactor()

double Trk::LayerMaterialProperties::oppositePreFactor ( ) const

inlineinherited

Return method for pre update material description of the Layer along normalvector.

Definition at line 146 of file LayerMaterialProperties.h.

                                                                {
   return m_splitFactor;
 }

◆ resizeMaterialProperties()

void Trk::CompoundLayerMaterial::resizeMaterialProperties ( )

private

Definition at line 168 of file CompoundLayerMaterial.cxx.

 {
   m_materialProperties.clear();
   m_materialProperties.resize (m_thicknessBins.valueBinMatrix.size());
   for (size_t i = 0; i < m_materialProperties.size(); i++) {
     m_materialProperties[i].resize (m_thicknessBins.valueBinMatrix[i].size());
   }
 }

◆ updateBinning()

void Trk::CompoundLayerMaterial::updateBinning ( BinUtility * bu )

inlinefinaloverridevirtual

Update the BinUtility if necessary - passing ownership of the utility class.

Implements Trk::LayerMaterialProperties.

Definition at line 148 of file CompoundLayerMaterial.h.

                                                                {
   if (bu) {
     delete m_binUtility;
     m_binUtility = bu;
   }
 }

◆ updateElementTable() [1/2]

void Trk::LayerMaterialProperties::updateElementTable ( const SharedObject< const ElementTable > & ) const

inlineinherited

Update the ElementTable.

Definition at line 87 of file LayerMaterialProperties.h.

87 {}

◆ updateElementTable() [2/2]

void Trk::CompoundLayerMaterial::updateElementTable ( const SharedObject< const ElementTable > & set )

inline

Update the ElementTable.

Definition at line 143 of file CompoundLayerMaterial.h.

                                                  {
   m_elementTable = set;
 }

Friends And Related Function Documentation

◆ ::CompoundLayerMaterialCnv_p1

friend class ::CompoundLayerMaterialCnv_p1

friend

Definition at line 117 of file CompoundLayerMaterial.h.

Member Data Documentation

◆ m_aBins

ValueStore Trk::CompoundLayerMaterial::m_aBins

private

A parameters (averaged)

Definition at line 129 of file CompoundLayerMaterial.h.

◆ m_binUtility

BinUtility* Trk::CompoundLayerMaterial::m_binUtility

private

the helper for the bin finding

Definition at line 125 of file CompoundLayerMaterial.h.

◆ m_composition

std::vector<std::vector<MaterialComposition> > Trk::CompoundLayerMaterial::m_composition

private

composition matrix

Definition at line 133 of file CompoundLayerMaterial.h.

◆ m_elementTable

SharedObject<const ElementTable> Trk::CompoundLayerMaterial::m_elementTable

private

Definition at line 136 of file CompoundLayerMaterial.h.

◆ m_fullComposition

bool Trk::CompoundLayerMaterial::m_fullComposition

private

full composition calculation

Definition at line 134 of file CompoundLayerMaterial.h.

◆ m_l0Bins

ValueStore Trk::CompoundLayerMaterial::m_l0Bins

private

l0 parameter

Definition at line 128 of file CompoundLayerMaterial.h.

◆ m_materialProperties

std::vector<std::vector<MaterialPropertiesCUP> > Trk::CompoundLayerMaterial::m_materialProperties

private

the ones you return

Definition at line 123 of file CompoundLayerMaterial.h.

◆ m_rhoBins

ValueStore Trk::CompoundLayerMaterial::m_rhoBins

private

rho parameter (averaged)

Definition at line 131 of file CompoundLayerMaterial.h.

◆ m_splitFactor

double Trk::LayerMaterialProperties::m_splitFactor

protectedinherited

the split factor in favour of oppositePre

Definition at line 126 of file LayerMaterialProperties.h.

◆ m_thicknessBins

ValueStore Trk::CompoundLayerMaterial::m_thicknessBins

private

thickness parameter

Definition at line 126 of file CompoundLayerMaterial.h.

◆ m_x0Bins

ValueStore Trk::CompoundLayerMaterial::m_x0Bins

private

x0 parameter

Definition at line 127 of file CompoundLayerMaterial.h.

◆ m_zBins

ValueStore Trk::CompoundLayerMaterial::m_zBins

private

Z parameter (averaged)

Definition at line 130 of file CompoundLayerMaterial.h.

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

Public Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ MaterialPropertiesCUP

Constructor & Destructor Documentation

◆ CompoundLayerMaterial() [1/3]

◆ CompoundLayerMaterial() [2/3]

◆ CompoundLayerMaterial() [3/3]

◆ ~CompoundLayerMaterial()

Member Function Documentation

◆ alongPostFactor()

◆ alongPreFactor()

◆ binUtility()

◆ clone()

◆ dump() [1/2]

◆ dump() [2/2]

◆ elementTable()

◆ factor()

◆ fullMaterial()

◆ material()

◆ operator*=()

◆ operator=()

◆ oppositePostFactor()

◆ oppositePreFactor()

◆ resizeMaterialProperties()

◆ updateBinning()

◆ updateElementTable() [1/2]

◆ updateElementTable() [2/2]

Friends And Related Function Documentation

◆ ::CompoundLayerMaterialCnv_p1

Member Data Documentation

◆ m_aBins

◆ m_binUtility

◆ m_composition

◆ m_elementTable

◆ m_fullComposition

◆ m_l0Bins

◆ m_materialProperties

◆ m_rhoBins

◆ m_splitFactor

◆ m_thicknessBins

◆ m_x0Bins

◆ m_zBins