Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::MappingMaterialDecorator Class Reference

Material decorator using a map as input. More...

#include <acts/blob/sPHENIX/Examples/Algorithms/MaterialMapping/include/ActsExamples/MaterialMapping/MappingMaterialDecorator.hpp>

+ Inheritance diagram for Acts::MappingMaterialDecorator:
+ Collaboration diagram for Acts::MappingMaterialDecorator:

Public Types

using BinningMap = std::map< uint64_t, std::pair< int, int >>
 
using VolumeMaterialMap = std::map< GeometryIdentifier, std::shared_ptr< const IVolumeMaterial >>
 

Public Member Functions

 MappingMaterialDecorator (const Acts::TrackingGeometry &tGeometry, Acts::Logging::Level level, bool clearSurfaceMaterial=true, bool clearVolumeMaterial=true)
 
void decorate (Surface &surface) const final
 
void decorate (TrackingVolume &volume) const final
 
void volumeLoop (const Acts::TrackingVolume *tVolume)
 
std::shared_ptr< const
Acts::ISurfaceMaterial
binnedSurfaceMaterial (const std::shared_ptr< const Acts::Surface > &surface) const
 
BinningMapbinningMap ()
 Readonly access to the BinningMap.
 
void setBinningMap (BinningMap binningMap)
 set the binning map
 
- Public Member Functions inherited from Acts::IMaterialDecorator
virtual ~IMaterialDecorator ()=default
 Virtual Destructor.
 

Private Member Functions

const Loggerlogger () const
 

Private Attributes

BinningMap m_binningMap
 
VolumeMaterialMap m_volumeMaterialMap
 
bool m_clearSurfaceMaterial {true}
 
bool m_clearVolumeMaterial {true}
 
std::unique_ptr< const Loggerm_logger
 

Detailed Description

Material decorator using a map as input.

This reads in map with binning information to decorate the detector with proto-material for material mapping. This allows us to change the mapping parameters directly in the C++ code. Takes a tracking geometry in input, all the surface with mapMaterial=true will be added to a binning map.

Definition at line 37 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 37 of file MappingMaterialDecorator.hpp

Member Typedef Documentation

using Acts::MappingMaterialDecorator::BinningMap = std::map<uint64_t, std::pair<int, int>>

Definition at line 39 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 39 of file MappingMaterialDecorator.hpp

Definition at line 42 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 42 of file MappingMaterialDecorator.hpp

Constructor & Destructor Documentation

Acts::MappingMaterialDecorator::MappingMaterialDecorator ( const Acts::TrackingGeometry tGeometry,
Acts::Logging::Level  level,
bool  clearSurfaceMaterial = true,
bool  clearVolumeMaterial = true 
)
inline

Definition at line 44 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 44 of file MappingMaterialDecorator.hpp

References Acts::getDefaultLogger().

+ Here is the call graph for this function:

Member Function Documentation

std::shared_ptr<const Acts::ISurfaceMaterial> Acts::MappingMaterialDecorator::binnedSurfaceMaterial ( const std::shared_ptr< const Acts::Surface > &  surface) const
inline
BinningMap& Acts::MappingMaterialDecorator::binningMap ( )
inline

Readonly access to the BinningMap.

Definition at line 266 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 266 of file MappingMaterialDecorator.hpp

References m_binningMap.

void Acts::MappingMaterialDecorator::decorate ( Surface surface) const
inlinefinalvirtual

Decorate a surface

Parameters
surfacethe non-cost surface that is decorated

Implements Acts::IMaterialDecorator.

Definition at line 57 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 57 of file MappingMaterialDecorator.hpp

References Acts::ACTS_VERBOSE(), binnedSurfaceMaterial(), bins, m_binningMap, m_clearSurfaceMaterial, and writeMapConfig::surface.

+ Here is the call graph for this function:

void Acts::MappingMaterialDecorator::decorate ( TrackingVolume volume) const
inlinefinalvirtual

Decorate a TrackingVolume

Parameters
volumethe non-cost volume that is decorated

Implements Acts::IMaterialDecorator.

Definition at line 76 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 76 of file MappingMaterialDecorator.hpp

References Acts::ACTS_VERBOSE(), m_clearVolumeMaterial, and m_volumeMaterialMap.

+ Here is the call graph for this function:

const Logger& Acts::MappingMaterialDecorator::logger ( ) const
inlineprivate

Definition at line 283 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 283 of file MappingMaterialDecorator.hpp

References m_logger.

void Acts::MappingMaterialDecorator::setBinningMap ( BinningMap  binningMap)
inline

set the binning map

Definition at line 269 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 269 of file MappingMaterialDecorator.hpp

References m_binningMap, and testing::internal::move().

+ Here is the call graph for this function:

void Acts::MappingMaterialDecorator::volumeLoop ( const Acts::TrackingVolume tVolume)
inline

Loop over all subvolumes and there surfaces and add all the surface with protomaterial to the binning map.

Parameters
volumeto be looped onto

Definition at line 95 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 95 of file MappingMaterialDecorator.hpp

References Acts::BinnedArray< T >::arrayObjects(), Acts::TrackingVolume::boundarySurfaces(), Acts::TrackingVolume::confinedLayers(), Acts::TrackingVolume::confinedVolumes(), Acts::TrackingVolume::denseVolumes(), Acts::GeometryObject::geometryId(), m_binningMap, m_volumeMaterialMap, Acts::GeometryIdentifier::volume(), Acts::TrackingVolume::volumeMaterial(), Acts::TrackingVolume::volumeMaterialSharedPtr(), and volumes.

+ Here is the call graph for this function:

Member Data Documentation

BinningMap Acts::MappingMaterialDecorator::m_binningMap
private

Definition at line 274 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 274 of file MappingMaterialDecorator.hpp

Referenced by binnedSurfaceMaterial(), binningMap(), decorate(), setBinningMap(), and volumeLoop().

bool Acts::MappingMaterialDecorator::m_clearSurfaceMaterial {true}
private

Definition at line 278 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 278 of file MappingMaterialDecorator.hpp

Referenced by decorate().

bool Acts::MappingMaterialDecorator::m_clearVolumeMaterial {true}
private

Definition at line 279 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 279 of file MappingMaterialDecorator.hpp

Referenced by decorate().

std::unique_ptr<const Logger> Acts::MappingMaterialDecorator::m_logger
private

Definition at line 281 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 281 of file MappingMaterialDecorator.hpp

Referenced by logger().

VolumeMaterialMap Acts::MappingMaterialDecorator::m_volumeMaterialMap
private

Definition at line 276 of file MappingMaterialDecorator.hpp.

View newest version in sPHENIX GitHub at line 276 of file MappingMaterialDecorator.hpp

Referenced by decorate(), and volumeLoop().


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