LayerMaterialProperties creator for CompoundLayerMaterial (i.e. More...

#include <CompoundLayerMaterialCreator.h>

Inheritance diagram for Trk::CompoundLayerMaterialCreator:

Collaboration diagram for Trk::CompoundLayerMaterialCreator:

Public Member Functions
	CompoundLayerMaterialCreator (const std::string &, const std::string &, const IInterface *)
	Constructor.
	~CompoundLayerMaterialCreator ()
	Destructor.
LayerMaterialProperties *	createLayerMaterial (const LayerMaterialRecord &lmr) const
	process the material properties
LayerMaterialProperties *	convertLayerMaterial (const LayerMaterialProperties &lmr) const
	create layer material properties from layer material properties - simply clones
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
	DeclareInterfaceID (ILayerMaterialCreator, 1, 0)
const std::string &	layerMaterialName () const
	the name of the created material map

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
std::string	m_layerMaterialName
std::string	m_layerMaterialDirectory

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
LayerMaterialProperties *	createCompoundLayerMaterial (const MaterialPropertiesMatrix &lmm, const BinUtility &lmbu) const
	private method that can be called by both create/convertLayerMaterial
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_fullCompoundCalculation
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
CxxUtils::CachedValue< std::string >	m_layerMaterialFullName

Detailed Description

LayerMaterialProperties creator for CompoundLayerMaterial (i.e.

a composit of materials)

The convertLayerMaterial() method converts into CompoundLayerMaterial (if possible).

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

Definition at line 42 of file CompoundLayerMaterialCreator.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CompoundLayerMaterialCreator()

Trk::CompoundLayerMaterialCreator::CompoundLayerMaterialCreator	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Constructor.

Definition at line 23 of file CompoundLayerMaterialCreator.cxx.

: AthAlgTool(t,n,p),
  m_fullCompoundCalculation(false)
{
    declareInterface<Trk::ILayerMaterialCreator>(this);
    // give the map a name
    declareProperty("LayerMaterialName"                 , m_layerMaterialName);
    declareProperty("LayerMaterialDirectory"            , m_layerMaterialDirectory);
    declareProperty("FullCompoundCalculation"           , m_fullCompoundCalculation);
}

◆ ~CompoundLayerMaterialCreator()

Trk::CompoundLayerMaterialCreator::~CompoundLayerMaterialCreator ( )

default

Destructor.

Member Function Documentation

◆ convertLayerMaterial()

Trk::LayerMaterialProperties * Trk::CompoundLayerMaterialCreator::convertLayerMaterial ( const LayerMaterialProperties & lmr ) const

virtual

create layer material properties from layer material properties - simply clones

Implements Trk::ILayerMaterialCreator.

Definition at line 55 of file CompoundLayerMaterialCreator.cxx.

{
 
    // the return object
    Trk::LayerMaterialProperties* bLayerMaterial = nullptr;
    // get the binUtility of the LayerMaterialProperties
    const Trk::BinUtility* bUtility = lmProperties.binUtility();
    // we have a bin utility, get the matrix and fill it
    if (bUtility){
        // prepare the matrix
        // nF x nS
        size_t nBins0  = bUtility->max(0)+1;
        size_t nBins1  = bUtility->max(1)+1;
        // create the MaterialMatrix
        Trk::MaterialPropertiesMatrix materialMatrix;
        materialMatrix.reserve(nBins1);
        // fill the matrix
        for (size_t ibin1 = 0; ibin1 < nBins1; ++ibin1) {
            // create the vector first
            Trk::MaterialPropertiesVector materialVector;
            materialVector.reserve(nBins0);
            // loop over local 1 bins
            for (size_t ibin0 = 0; ibin0 < nBins0; ++ibin0) {
                // get the material from the properties and push them into the matrix (no cloning !)
                const Trk::MaterialProperties* mProperties = lmProperties.material(ibin0,ibin1);
                materialVector.push_back(mProperties);
            }
            // now pus the vector into the matrix
            materialMatrix.push_back(materialVector);
        }
 
        // create the material
        ATH_MSG_VERBOSE("Converting the MaterialPropertiesMatrix into a CompressedLayerMaterial.");
        bLayerMaterial = createCompoundLayerMaterial(materialMatrix,*bUtility);
 
    } else {
        // must be homogenous material, can be transformed into a 0-bin material, would be silly though
        ATH_MSG_DEBUG("No BinUtility provided - return a simple clone.");
        bLayerMaterial = lmProperties.clone();
    }
    //
    return bLayerMaterial;
}

◆ createCompoundLayerMaterial()

Trk::LayerMaterialProperties * Trk::CompoundLayerMaterialCreator::createCompoundLayerMaterial	(	const MaterialPropertiesMatrix &	lmm,
		const BinUtility &	lmbu ) const

private

private method that can be called by both create/convertLayerMaterial

Definition at line 99 of file CompoundLayerMaterialCreator.cxx.

{
 
 
    // analyse the material bins
    double tMin   = 10e10;
    double xMin  = 10e10;
    double lMin  = 10e10;
    double aMin   = 10e10;
    double zMin   = 10e10;
    double rMin = 10e10;
    double tMax   = 0.;
    double xMax  = 0.;
    double lMax  = 0.;
    double aMax   = 0.;
    double zMax   = 0.;
    double rMax = 0.;
 
    // first loop to get the min/max values
    for (const auto & mo : materialMatrix)
        for (const auto & mi : mo) {
            if (mi){
              const Trk::MaterialProperties& mp = (*mi);
              // macro defined in GeometryStatics
              minMaxValue(tMin, tMax, mp.thickness());
              minMaxValue(xMin, xMax, mp.x0());
              minMaxValue(lMin, lMax, mp.l0());
              minMaxValue(aMin, aMax, mp.averageA());
              minMaxValue(zMin, zMax, mp.averageZ());
              minMaxValue(rMin, rMax, mp.averageRho());
            }
    }
 
    ATH_MSG_DEBUG( "Preparing the store: min/max values for t, x0, l0, a, z, rho estimated." );
 
 
    // the bin matrices in the store
    Trk::ValueMatrix binMatrix( lBinUtility.max(1)+1, Trk::ValueVector(lBinUtility.max(0)+1, static_cast<unsigned char>(0) ) );
    // 255 bins, the 0 bin indicates empy
    Trk::ValueStore tStore;
    Trk::ValueStore xStore;
    Trk::ValueStore lStore;
    Trk::ValueStore aStore;
    Trk::ValueStore zStore;
    Trk::ValueStore rStore;
    // set the store min, max
    tStore.valueMin = tMin;
    xStore.valueMin = xMin;
    lStore.valueMin = lMin;
    aStore.valueMin = aMin;
    zStore.valueMin = zMin;
    rStore.valueMin = rMin;
    tStore.valueStep = fabs(tMin-tMax)<10e-8 ? 0. : (tMax-tMin)/double(static_cast<int>(UCHAR_MAX)-1);
    xStore.valueStep = (xMax-xMin)/double(static_cast<int>(UCHAR_MAX)-1);
    lStore.valueStep = (lMax-lMin)/double(static_cast<int>(UCHAR_MAX)-1);
    aStore.valueStep = (aMax-aMin)/double(static_cast<int>(UCHAR_MAX)-1);
    zStore.valueStep = (zMax-zMin)/double(static_cast<int>(UCHAR_MAX)-1);
    rStore.valueStep = (rMax-rMin)/double(static_cast<int>(UCHAR_MAX)-1);
 
    ATH_MSG_VERBOSE(" - t   [ min/max/step ] = "  << tMin  << " / " << tMax << " / " << tStore.valueStep );
    ATH_MSG_VERBOSE(" - x0  [ min/max/step ] = "  << xMin  << " / " << xMax << " / " << xStore.valueStep );
    ATH_MSG_VERBOSE(" - l0  [ min/max/step ] = "  << lMin  << " / " << lMax << " / " << lStore.valueStep );
    ATH_MSG_VERBOSE(" - a   [ min/max/step ] = "  << aMin  << " / " << aMax << " / " << aStore.valueStep );
    ATH_MSG_VERBOSE(" - z   [ min/max/step ] = "  << zMin  << " / " << zMax << " / " << zStore.valueStep );
    ATH_MSG_VERBOSE(" - rho [ min/max/step ] = "  << rMin  << " / " << rMax << " / " << rStore.valueStep );
 
    // set the initally empty - thickness store can be empty
    if (tStore.valueStep > 0.)
        tStore.valueBinMatrix = binMatrix;
    else
        ATH_MSG_VERBOSE("Thickness has been estimated to be constant - matrix is not prepared.");
    xStore.valueBinMatrix = binMatrix;
    lStore.valueBinMatrix = binMatrix;
    aStore.valueBinMatrix = binMatrix;
    zStore.valueBinMatrix = binMatrix;
    rStore.valueBinMatrix = binMatrix;
 
    ATH_MSG_VERBOSE( "Material stores prepared, now preparing composition matrix." );
 
    // the compound material
    std::vector< std::vector< Trk::MaterialComposition > > compositionMatrix( lBinUtility.max(1)+1, std::vector< Trk::MaterialComposition >( lBinUtility.max(0)+1, Trk::MaterialComposition()) );
 
    ATH_MSG_VERBOSE( "Composition matrix created." );
 
    // second loop : assign the bins & and copy the material composition
    size_t obin = 0;
    for (const auto & mo : materialMatrix){
        size_t ibin =0;
        for (const auto & mi : mo) {
            if (mi){
              const Trk::MaterialProperties& mp = (*mi);
              if (tStore.valueStep > 0.) tStore.valueBinMatrix[obin][ibin] = static_cast<unsigned char>(std::lrint(mp.thickness()/tStore.valueStep)+1);
              xStore.valueBinMatrix[obin][ibin] = static_cast<unsigned char>(std::lrint(mp.x0()/xStore.valueStep)+1);
              lStore.valueBinMatrix[obin][ibin] = static_cast<unsigned char>(std::lrint(mp.l0()/lStore.valueStep)+1);
              aStore.valueBinMatrix[obin][ibin] = static_cast<unsigned char>(std::lrint(mp.averageA()/aStore.valueStep)+1);
              zStore.valueBinMatrix[obin][ibin] = static_cast<unsigned char>(std::lrint(mp.averageZ()/zStore.valueStep)+1);
              rStore.valueBinMatrix[obin][ibin] = static_cast<unsigned char>(std::lrint(mp.averageRho()/rStore.valueStep)+1);
              // set the material composition
              if (mp.material().composition) {
                  compositionMatrix[obin][ibin] = Trk::MaterialComposition(*(mp.material().composition));
                  ATH_MSG_VERBOSE(" - composition is copied.");
              }
            }
            ++ibin;
       }
       ++obin;
   }
   ATH_MSG_VERBOSE( "Returning the new compound material." );
 
   // now create the compound material propertis
   return new Trk::CompoundLayerMaterial(lBinUtility, tStore, xStore, lStore, aStore, zStore, rStore, compositionMatrix, m_fullCompoundCalculation);
 
}

◆ createLayerMaterial()

Trk::LayerMaterialProperties * Trk::CompoundLayerMaterialCreator::createLayerMaterial ( const LayerMaterialRecord & lmr ) const

virtual

process the material properties

Implements Trk::ILayerMaterialCreator.

Definition at line 39 of file CompoundLayerMaterialCreator.cxx.

{
    // get the material matrix
    const Trk::MaterialPropertiesMatrix& materialMatrix = lmr.associatedLayerMaterial();
    // get the bin untility
    const Trk::BinUtility* binUtility = lmr.binUtility();
    // if there's no bin utility - bail out
    if (!binUtility){
        ATH_MSG_WARNING( "No BinUtility given - Bailing out." );
        return nullptr;
    } else
        ATH_MSG_DEBUG( "BinUtility provided, creating binned array in dimensions " << binUtility->max(0)+1 << " x " << binUtility->max(1)+1 );
    // return the created compound material
    return createCompoundLayerMaterial(materialMatrix,*binUtility);
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ DeclareInterfaceID()

Trk::ILayerMaterialCreator::DeclareInterfaceID	(	ILayerMaterialCreator	,
		1	,
		0	)

inherited

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ layerMaterialName()

const std::string & Trk::ILayerMaterialCreator::layerMaterialName ( ) const

inlineinherited

the name of the created material map

Definition at line 47 of file ILayerMaterialCreator.h.

                                                 {
        if (!m_layerMaterialFullName.isValid()) {
          m_layerMaterialFullName.set (m_layerMaterialDirectory+m_layerMaterialName);
        }
        return *m_layerMaterialFullName.ptr();
      }

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fullCompoundCalculation

bool Trk::CompoundLayerMaterialCreator::m_fullCompoundCalculation

private

Definition at line 61 of file CompoundLayerMaterialCreator.h.

◆ m_layerMaterialDirectory

std::string Trk::ILayerMaterialCreator::m_layerMaterialDirectory

protectedinherited

Definition at line 56 of file ILayerMaterialCreator.h.

◆ m_layerMaterialFullName

CxxUtils::CachedValue<std::string> Trk::ILayerMaterialCreator::m_layerMaterialFullName

privateinherited

Definition at line 59 of file ILayerMaterialCreator.h.

◆ m_layerMaterialName

std::string Trk::ILayerMaterialCreator::m_layerMaterialName

protectedinherited

Definition at line 55 of file ILayerMaterialCreator.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CompoundLayerMaterialCreator()

◆ ~CompoundLayerMaterialCreator()

Member Function Documentation

◆ convertLayerMaterial()

◆ createCompoundLayerMaterial()

◆ createLayerMaterial()

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ inputHandles()

◆ layerMaterialName()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_fullCompoundCalculation

◆ m_layerMaterialDirectory

◆ m_layerMaterialFullName

◆ m_layerMaterialName

◆ m_varHandleArraysDeclared

◆ m_vhka