#include <acts/blob/master/Core/include/Acts/Material/AccumulatedSurfaceMaterial.hpp>

Collaboration diagram for Acts::AccumulatedSurfaceMaterial:

Public Types
using	AccumulatedVector = std::vector< AccumulatedMaterialProperties >

using	AccumulatedMatrix = std::vector< AccumulatedVector >

Public Member Functions
	AccumulatedSurfaceMaterial (double splitFactor=0.)

	AccumulatedSurfaceMaterial (const BinUtility &binUtility, double splitFactor=0.)

	AccumulatedSurfaceMaterial (const AccumulatedSurfaceMaterial &asma)=default

	AccumulatedSurfaceMaterial (AccumulatedSurfaceMaterial &&asma)=default

AccumulatedSurfaceMaterial &	operator= (AccumulatedSurfaceMaterial &&asma)=default

AccumulatedSurfaceMaterial &	operator= (const AccumulatedSurfaceMaterial &asma)=default

	~AccumulatedSurfaceMaterial ()=default
	Destructor.

const BinUtility &	binUtility () const
	Return the BinUtility.

std::array< size_t, 3 >	accumulate (const Vector2D &lp, const MaterialProperties &mp, double pathCorrection=1.)

std::array< size_t, 3 >	accumulate (const Vector3D &gp, const MaterialProperties &mp, double pathCorrection=1.)

void	trackAverage (const std::vector< std::array< size_t, 3 >> &trackBins={}, bool emptyHit=false)

void	trackAverage (const Vector3D &gp, bool emptyHit=false)

std::unique_ptr< const ISurfaceMaterial >	totalAverage ()
	Total average creates SurfaceMaterial.

const AccumulatedMatrix &	accumulatedMaterial () const
	Access to the accumulated material.

double	splitFactor () const
	Access to the split factor.

Private Attributes
BinUtility	m_binUtility {}
	The helper for the bin finding.

double	m_splitFactor {0.}
	the split factor

AccumulatedMatrix	m_accumulatedMaterial
	The stored accumulated material matrix.

Detailed Description

This class is used by the SurfaceMaterialMapper in order to accumulate/collect material information during the mapping process.

It performs event- and run-average when called, and returns a new SurfaceMaterial object as a unique_ptr after finalisation

Definition at line 29 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 29 of file AccumulatedSurfaceMaterial.hpp

Member Typedef Documentation

using Acts::AccumulatedSurfaceMaterial::AccumulatedMatrix = std::vector<AccumulatedVector>

Definition at line 32 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 32 of file AccumulatedSurfaceMaterial.hpp

using Acts::AccumulatedSurfaceMaterial::AccumulatedVector = std::vector<AccumulatedMaterialProperties>

Definition at line 31 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 31 of file AccumulatedSurfaceMaterial.hpp

Constructor & Destructor Documentation

Acts::AccumulatedSurfaceMaterial::AccumulatedSurfaceMaterial ( double splitFactor = 0. )

Default Constructor - for homogeneous material

Parameters

splitFactor is the pre/post splitting directive

Definition at line 14 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 14 of file AccumulatedSurfaceMaterial.cpp

References m_accumulatedMaterial.

Acts::AccumulatedSurfaceMaterial::AccumulatedSurfaceMaterial	(	const BinUtility &	binUtility,
		double	splitFactor = `0.`
	)

Explicit constructor with only full MaterialProperties, for one-dimensional binning.

The split factors:

1. : oppositePre
0. : alongPre ===> 1 Dimensional array

Parameters

binUtility	defines the binning structure on the surface
splitFactor	is the pre/post splitting directive

Definition at line 21 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 21 of file AccumulatedSurfaceMaterial.cpp

References Acts::BinUtility::bins(), m_accumulatedMaterial, and m_binUtility.

Here is the call graph for this function:

Acts::AccumulatedSurfaceMaterial::AccumulatedSurfaceMaterial ( const AccumulatedSurfaceMaterial & asma )

default

Copy Constructor

Parameters

asma	is the source object to be copied

Acts::AccumulatedSurfaceMaterial::AccumulatedSurfaceMaterial ( AccumulatedSurfaceMaterial && asma )

default

Copy Move Constructor

Parameters

asma	is the source object to be copied

Acts::AccumulatedSurfaceMaterial::~AccumulatedSurfaceMaterial ( )

default

Destructor.

Member Function Documentation

std::array< size_t, 3 > Acts::AccumulatedSurfaceMaterial::accumulate	(	const Vector2D &	lp,
		const MaterialProperties &	mp,
		double	pathCorrection = `1.`
	)

Assign a material properites object

Parameters

lp	local position for the bin assignment
mp	material properties to be assigned

Returns: the bin triple to which the material was assigned

Definition at line 31 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 31 of file AccumulatedSurfaceMaterial.cpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

std::array< size_t, 3 > Acts::AccumulatedSurfaceMaterial::accumulate	(	const Vector3D &	gp,
		const MaterialProperties &	mp,
		double	pathCorrection = `1.`
	)

Assign a material properites object

Parameters

gp	global position for the bin assignment
mp	material properties to be assigned

Returns: the bin triple to which the material was assigned

Definition at line 44 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 44 of file AccumulatedSurfaceMaterial.cpp

const AccumulatedSurfaceMaterial::AccumulatedMatrix & Acts::AccumulatedSurfaceMaterial::accumulatedMaterial ( ) const

inline

Access to the accumulated material.

Definition at line 139 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 139 of file AccumulatedSurfaceMaterial.hpp

References m_accumulatedMaterial.

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

Here is the caller graph for this function:

const BinUtility & Acts::AccumulatedSurfaceMaterial::binUtility ( ) const

inline

Return the BinUtility.

Definition at line 134 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 134 of file AccumulatedSurfaceMaterial.hpp

References m_binUtility.

AccumulatedSurfaceMaterial& Acts::AccumulatedSurfaceMaterial::operator= ( AccumulatedSurfaceMaterial && asma )

default

Assignment Move operator

Parameters

asma	is the source object to be copied

AccumulatedSurfaceMaterial& Acts::AccumulatedSurfaceMaterial::operator= ( const AccumulatedSurfaceMaterial & asma )

default

Assignment operator

Parameters

asma	is the source object to be copied

double Acts::AccumulatedSurfaceMaterial::splitFactor ( ) const

inline

Access to the split factor.

Definition at line 143 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 143 of file AccumulatedSurfaceMaterial.hpp

References m_splitFactor.

std::unique_ptr< const Acts::ISurfaceMaterial > Acts::AccumulatedSurfaceMaterial::totalAverage ( )

Total average creates SurfaceMaterial.

Definition at line 92 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 92 of file AccumulatedSurfaceMaterial.cpp

void Acts::AccumulatedSurfaceMaterial::trackAverage	(	const std::vector< std::array< size_t, 3 >> &	trackBins = `{}`,
		bool	emptyHit = `false`
	)

Average the information accumulated from one mapped track

Parameters

trackBins	The bins that were touched by this event
emptyHit	indicator if this is an empty assignment If none is given, the average runs over all bins in the surface map

Definition at line 67 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 67 of file AccumulatedSurfaceMaterial.cpp

References bin, and mat.

void Acts::AccumulatedSurfaceMaterial::trackAverage	(	const Vector3D &	gp,
		bool	emptyHit = `false`
	)

Average the information accumulated from one mapped track

Parameters

gp	global position for the bin assignment
emptyHit	indicator if this is an empty assignment

Definition at line 56 of file AccumulatedSurfaceMaterial.cpp.

View newest version in sPHENIX GitHub at line 56 of file AccumulatedSurfaceMaterial.cpp

Member Data Documentation

AccumulatedMatrix Acts::AccumulatedSurfaceMaterial::m_accumulatedMaterial

private

The stored accumulated material matrix.

Definition at line 131 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 131 of file AccumulatedSurfaceMaterial.hpp

Referenced by accumulatedMaterial(), and AccumulatedSurfaceMaterial().

BinUtility Acts::AccumulatedSurfaceMaterial::m_binUtility {}

private

The helper for the bin finding.

Definition at line 125 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 125 of file AccumulatedSurfaceMaterial.hpp

Referenced by AccumulatedSurfaceMaterial(), and binUtility().

double Acts::AccumulatedSurfaceMaterial::m_splitFactor {0.}

private

the split factor

Definition at line 128 of file AccumulatedSurfaceMaterial.hpp.

View newest version in sPHENIX GitHub at line 128 of file AccumulatedSurfaceMaterial.hpp

Referenced by splitFactor().

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

acts/blob/master/Core/include/Acts/Material/AccumulatedSurfaceMaterial.hpp
acts/blob/master/Core/src/Material/AccumulatedSurfaceMaterial.cpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation