Trk::CompressedLayerMaterial Class Reference

It extends the LayerMaterialProperties base class. More...

#include <CompressedLayerMaterial.h>

Inheritance diagram for Trk::CompressedLayerMaterial:

Collaboration diagram for Trk::CompressedLayerMaterial:

Public Member Functions
	CompressedLayerMaterial ()
	Default Constructor - needed by POOL.
	CompressedLayerMaterial (BinUtility &binutility)
	Default Constructor for emptly material.
	CompressedLayerMaterial (const Trk::BinUtility &binutility, const MaterialPropertiesVector &fullProperties, const std::vector< unsigned short int > &materialIndices, double splitFactor=0.)
	Explizit constructor with only full MaterialProperties, and split factors:
	CompressedLayerMaterial (std::unique_ptr< Trk::BinUtility > binutility, const MaterialPropertiesVector &&fullProperties, const std::vector< unsigned short int > &materialIndices, double splitFactor=0.)
	CompressedLayerMaterial (const CompressedLayerMaterial &mprop)
	Copy Constructor.
virtual	~CompressedLayerMaterial () override
	Destructor.
virtual CompressedLayerMaterial *	clone () const override final
	Pseudo-Constructor clone()
CompressedLayerMaterial &	operator= (const CompressedLayerMaterial &lmp)
	Assignment operator.
virtual CompressedLayerMaterial &	operator*= (double scale) override final
	Scale operator.
virtual const BinUtility *	binUtility () const override final
	Return the BinUtility.
virtual void	updateBinning (BinUtility *bu) override final
	Update the BinUtility if necessary - passing ownership of the utility class.
const MaterialPropertiesVector &	fullMaterial () const
	Return method for full material description of the Layer - for all bins.
const std::vector< unsigned short int > &	materialBins () const
	Return method for index vector, needs BinUtility to interpret this.
virtual const MaterialProperties *	fullMaterial (const Amg::Vector3D &gp) const override
	Return method for full material description of the Layer.
virtual const MaterialProperties *	material (size_t bin0, size_t bin1) const override final
	Access the single bin.
virtual MsgStream &	dump (MsgStream &sl) const override final
	Output Method for MsgStream, to be overloaded by child classes.
virtual std::ostream &	dump (std::ostream &sl) const override final
	Output Method for std::ostream, to be overloaded by child classes.
void	updateElementTable (const std::shared_ptr< const ElementTable > &) const
	Update the ElementTable.
const ElementTable *	elementTable () const
	Get the ElementTable.
double	factor (PropDirection pDir, MaterialUpdateStage mStage) const
	Update pre factor.
double	alongPreFactor () const
	Return method for pre update material description of the Layer along normalvector.
double	alongPostFactor () const
	Return method for post update material description of the Layer along normalvector.
double	oppositePreFactor () const
	Return method for pre update material description of the Layer along normalvector.
double	oppositePostFactor () const
	Return method for post update material description of the Layer along normalvector.

Protected Attributes
double	m_splitFactor
	the split factor in favour of oppositePre

Private Member Functions
void	clearMaterial ()
	helper method - to clear the material
void	fillMaterial (const MaterialPropertiesVector &matVector)
	helper method - to refill the material

Private Attributes
BinUtility *	m_binUtility
	the helper for the bin finding
MaterialPropertiesVector	m_fullMaterial
	The five different MaterialProperties.
std::vector< unsigned short int >	m_materialBins

Detailed Description

It extends the LayerMaterialProperties base class.

Author

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

Definition at line 31 of file CompressedLayerMaterial.h.

Constructor & Destructor Documentation

CompressedLayerMaterial() [1/5]

Trk::CompressedLayerMaterial::CompressedLayerMaterial

(

)

Default Constructor - needed by POOL.

Definition at line 13 of file CompressedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(), m_binUtility(nullptr) {}

CompressedLayerMaterial() [2/5]

Trk::CompressedLayerMaterial::CompressedLayerMaterial

(

Trk::BinUtility &

binutility

)

Default Constructor for emptly material.

Definition at line 16 of file CompressedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(), m_binUtility(binutility.clone()) {}

CompressedLayerMaterial() [3/5]

Trk::CompressedLayerMaterial::CompressedLayerMaterial	(	const Trk::BinUtility &	binutility,
		const MaterialPropertiesVector &	fullProperties,
		const std::vector< unsigned short int > &	materialIndices,
		double	splitFactor = 0. )

Explizit constructor with only full MaterialProperties, and split factors:

• 1. : oppositePre
• 0. : alongPre

===> 1 Dimensional array, 1 dimensional indices ( can represent 2-dim indices)

ATTENTION: Ownership of MaterialProperties objects is given!

Definition at line 20 of file CompressedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(splitFactor),
      m_binUtility(binutility.clone()),
      m_fullMaterial(fullProperties),
      m_materialBins(materialIndices) {}

CompressedLayerMaterial() [4/5]

Trk::CompressedLayerMaterial::CompressedLayerMaterial	(	std::unique_ptr< Trk::BinUtility >	binutility,
		const MaterialPropertiesVector &&	fullProperties,
		const std::vector< unsigned short int > &	materialIndices,
		double	splitFactor = 0. )

Definition at line 29 of file CompressedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(splitFactor),
      m_binUtility(binutility.release()),
      m_fullMaterial(fullProperties),
      m_materialBins(materialIndices) {}

CompressedLayerMaterial() [5/5]

Trk::CompressedLayerMaterial::CompressedLayerMaterial

(

const CompressedLayerMaterial &

mprop

)

Copy Constructor.

Definition at line 43 of file CompressedLayerMaterial.cxx.

    : Trk::LayerMaterialProperties(lmp),
      m_binUtility(lmp.m_binUtility->clone()),
      m_materialBins(lmp.m_materialBins) {
  // clear the material
  clearMaterial();
  // and fill the material
  fillMaterial(lmp.m_fullMaterial);
}

~CompressedLayerMaterial()

Trk::CompressedLayerMaterial::~CompressedLayerMaterial ( )

overridevirtual

Destructor.

Definition at line 38 of file CompressedLayerMaterial.cxx.

                                                     {
  delete m_binUtility;
  clearMaterial();
}

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::CompressedLayerMaterial::binUtility ( ) const

inlinefinaloverridevirtual

Return the BinUtility.

Implements Trk::LayerMaterialProperties.

Definition at line 116 of file CompressedLayerMaterial.h.

                                                                   {
  return m_binUtility;
}

clearMaterial()

void Trk::CompressedLayerMaterial::clearMaterial ( )

private

helper method - to clear the material

Definition at line 74 of file CompressedLayerMaterial.cxx.

                                               {
  // loop over the matrix
  for (auto& matIter : m_fullMaterial) delete matIter;
  m_fullMaterial.clear();
}

clone()

Trk::CompressedLayerMaterial * Trk::CompressedLayerMaterial::clone ( ) const

finaloverridevirtual

Pseudo-Constructor clone()

Implements Trk::LayerMaterialProperties.

Definition at line 70 of file CompressedLayerMaterial.cxx.

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

dump() [1/2]

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

finaloverridevirtual

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

Implements Trk::LayerMaterialProperties.

Definition at line 118 of file CompressedLayerMaterial.cxx.

                                                               {
  sl << "Trk::CompressedLayerMaterial : " << std::endl;
  sl << "   - Number of Material bins (1/2) : " << m_binUtility->max(0) + 1
     << " / " << m_binUtility->max(1) + 1 << std::endl;
  sl << "   - Parse full update material    : " << std::endl;
  // -------------------------
  size_t imat1 = 0;
  for (const auto& matIter : m_fullMaterial) {
    if (matIter)
      sl << " Bin [" << imat1 << "] - " << matIter << std::endl;
    else
      sl << " Bin [" << imat1 << "] -  empty " << std::endl;
    ++imat1;
  }
  return sl;
}

dump() [2/2]

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

finaloverridevirtual

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

Implements Trk::LayerMaterialProperties.

Definition at line 135 of file CompressedLayerMaterial.cxx.

                                                                 {
  sl << "Trk::CompressedLayerMaterial : " << std::endl;
  sl << "   - Number of Material bins (1/2) : " << m_binUtility->max(0) + 1
     << " / " << m_binUtility->max(1) + 1 << std::endl;
  sl << "   - Parse full update material    : " << std::endl;  //
  size_t imat1 = 0;
  for (const auto& matIter : m_fullMaterial) {
    if (matIter)
      sl << " Bin [" << imat1 << "] - " << matIter << std::endl;
    else
      sl << " Bin [" << imat1 << "] -  empty " << std::endl;
    ++imat1;
  }
  return sl;
}

elementTable()

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

inlineinherited

Get the ElementTable.

Definition at line 90 of file LayerMaterialProperties.h.

{ return nullptr; }

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);
}

fillMaterial()

void Trk::CompressedLayerMaterial::fillMaterial ( const MaterialPropertiesVector & matVector )

private

helper method - to refill the material

Definition at line 80 of file CompressedLayerMaterial.cxx.

                                                  {
  // reassign
  m_fullMaterial.clear();
  m_fullMaterial.reserve(matVector.size());
  for (const auto& matIter : matVector)
    m_fullMaterial.push_back(matIter ? matIter->clone() : nullptr);
}

fullMaterial() [1/2]

const MaterialPropertiesVector & Trk::CompressedLayerMaterial::fullMaterial ( ) const

inline

Return method for full material description of the Layer - for all bins.

Definition at line 120 of file CompressedLayerMaterial.h.

          {
  return m_fullMaterial;
}

fullMaterial() [2/2]

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

overridevirtual

Return method for full material description of the Layer.

Implements Trk::LayerMaterialProperties.

Definition at line 107 of file CompressedLayerMaterial.cxx.

                                 {
  if (m_fullMaterial.empty() || !m_binUtility) return nullptr;
  // first bin
  size_t ibin1 = m_binUtility->bin(gp, 0);
  // second bin
  size_t ibin2 = (m_binUtility->max(1) == 0) ? 0 : m_binUtility->bin(gp, 1);
  // out of bounds check and return
  return (ibin2 > m_binUtility->max(1)) ? nullptr : material(ibin1, ibin2);
}

material()

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

inlinefinaloverridevirtual

Access the single bin.

Implements Trk::LayerMaterialProperties.

Definition at line 130 of file CompressedLayerMaterial.h.

                                    {
  int accessBin = bin1 * (m_binUtility->max(0) + 1) + bin0;
  // safety check
  if (bin0 <= (unsigned int)m_binUtility->max(0) &&
      bin1 <= (unsigned int)m_binUtility->max(1) && !m_fullMaterial.empty() &&
      accessBin < int(m_materialBins.size()))
    return m_fullMaterial[m_materialBins[accessBin]];
  return nullptr;
}

materialBins()

const std::vector< unsigned short int > & Trk::CompressedLayerMaterial::materialBins ( ) const

inline

Return method for index vector, needs BinUtility to interpret this.

Definition at line 126 of file CompressedLayerMaterial.h.

                                            {
  return m_materialBins;
}

operator*=()

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

finaloverridevirtual

Scale operator.

Implements Trk::LayerMaterialProperties.

Definition at line 89 of file CompressedLayerMaterial.cxx.

                  {
  size_t imat1 = 0;
  // the vector iterator
  for (auto& matIter : m_fullMaterial) {
    if (matIter) {
      // clone needed for const correctness
      Trk::MaterialProperties* mprop = (matIter)->clone();
      (*mprop) *= scale;
      delete matIter;
      m_fullMaterial[imat1] = mprop;
    }
  }
 
  // scale the reference material
  return (*this);
}

operator=()

Trk::CompressedLayerMaterial & Trk::CompressedLayerMaterial::operator=

(

const CompressedLayerMaterial &

lmp

)

Assignment operator.

Definition at line 54 of file CompressedLayerMaterial.cxx.

                                           {
  if (this != &lmp) {
    Trk::LayerMaterialProperties::operator=(lmp);
    // first delete everything
    delete m_binUtility;
    clearMaterial();
    // reassign the material
    fillMaterial(lmp.m_fullMaterial);
    // reassign the binutility and the material bins
    m_binUtility = lmp.binUtility()->clone();
    m_materialBins = lmp.m_materialBins;
  }
  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;
}

updateBinning()

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

inlinefinaloverridevirtual

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

Implements Trk::LayerMaterialProperties.

Definition at line 141 of file CompressedLayerMaterial.h.

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

updateElementTable()

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

inlineinherited

Update the ElementTable.

Definition at line 87 of file LayerMaterialProperties.h.

{}

Member Data Documentation

m_binUtility

BinUtility* Trk::CompressedLayerMaterial::m_binUtility

private

the helper for the bin finding

Definition at line 103 of file CompressedLayerMaterial.h.

m_fullMaterial

MaterialPropertiesVector Trk::CompressedLayerMaterial::m_fullMaterial

private

The five different MaterialProperties.

Definition at line 106 of file CompressedLayerMaterial.h.

m_materialBins

std::vector<unsigned short int> Trk::CompressedLayerMaterial::m_materialBins

private

Definition at line 107 of file CompressedLayerMaterial.h.

m_splitFactor

double Trk::LayerMaterialProperties::m_splitFactor

protectedinherited

the split factor in favour of oppositePre

Definition at line 126 of file LayerMaterialProperties.h.

---

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

• CompressedLayerMaterial.h
• CompressedLayerMaterial.cxx