Implementation of the tool compressing track particles. More...

#include <TrackParticleCompressorTool.h>

Inheritance diagram for xAODMaker::TrackParticleCompressorTool:

Collaboration diagram for xAODMaker::TrackParticleCompressorTool:

Public Member Functions
	TrackParticleCompressorTool (const std::string &type, const std::string &name, const IInterface *parent)
	Regular AlgTool constructor.
StatusCode	initialize () override
	Function initialising the tool.
StatusCode	compress (xAOD::TrackParticle &tp) const override
	The function doing the heavy lifting.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Gaudi interface definition.

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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
int	m_offDiagCovMatrixBits
	The number of mantissa bits to keep for off-diagonal covariance matrix elements.
int	m_diagCovMatrixBits
	The number of mantissa bits to keep for the diagonal covariance matrix elements.
bool	m_useOffDiagCompr
std::unique_ptr< CxxUtils::FloatCompressor >	m_diagCovMatrixCompressor
	Helper object for compressing the on-diagonal covariance matrix elements.
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

Detailed Description

Implementation of the tool compressing track particles.

This tool is used by the POOL converter code to "compress" some of the float properties of track particles before writing them to disk. To make the xAODs smaller.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Revision: 789457

Date: 2016-12-13 13:00:43 +0100 (Tue, 13 Dec 2016)

Definition at line 36 of file TrackParticleCompressorTool.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

◆ TrackParticleCompressorTool()

xAODMaker::TrackParticleCompressorTool::TrackParticleCompressorTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Regular AlgTool constructor.

Definition at line 15 of file TrackParticleCompressorTool.cxx.

      : AthAlgTool( type, name, parent ) {
 
      // Declare the interface implemented by the tool
      declareInterface< xAODMaker::ITrackParticleCompressorTool >( this );
 
      // Declare the properties of the tool:
      declareProperty( "OffDiagCovMatrixBits", m_offDiagCovMatrixBits = 23,
                       "Bits kept for the off-diagonal covariance matrix "
                       "elements" );
      declareProperty( "DiagonalCovMatrixBits", m_diagCovMatrixBits = 23,
                       "Bits kept for the diagonal covariance matrix "
                       "elements" );
      declareProperty( "UseOffDiagCompr", m_useOffDiagCompr = false,
                       "Flag to control the off-diagonal compression "
                       "scheme" );
   }

Member Function Documentation

◆ compress()

StatusCode xAODMaker::TrackParticleCompressorTool::compress ( xAOD::TrackParticle & tp ) const

overridevirtual

The function doing the heavy lifting.

Implements xAODMaker::ITrackParticleCompressorTool.

Definition at line 54 of file TrackParticleCompressorTool.cxx.

                                                                      {
 
     xAOD::ParametersCovMatrix_t covMatrix = tp.definingParametersCovMatrix();
     tp.setDefiningParametersCovMatrix(covMatrix); //Separate diag and offdiag cov matrix vectors may not have been set before
     if(m_useOffDiagCompr) tp.compressDefiningParametersCovMatrixOffDiag();
 
     //Check if determinant got negative after compression
     //If so, undo
     xAOD::ParametersCovMatrix_t covMatrixCompr = tp.definingParametersCovMatrix();
     if(covMatrixCompr.determinant()<=0.) tp.setDefiningParametersCovMatrix(covMatrix);
 
     const std::vector< float > diagVec = tp.definingParametersCovMatrixDiagVec();
     std::vector< float > diagVecCompr;
 
     diagVecCompr.reserve(diagVec.size());
     for (float i : diagVec) {
       diagVecCompr.push_back(
         m_diagCovMatrixCompressor->reduceFloatPrecision(i));
     }
 
     tp.setDefiningParametersCovMatrixDiagVec( diagVecCompr );
 
     auto compressOffDiag = []( const std::vector< float >& offDiagVec, int bits ) -> std::vector< float > {
       CxxUtils::FloatCompressor fc( bits );
       std::vector< float > offDiagVecCompr;
       offDiagVecCompr.reserve( offDiagVec.size() );
       for( float element : offDiagVec ) {
         offDiagVecCompr.push_back( fc.reduceFloatPrecision( element ) );
       }
       return offDiagVecCompr;
     };
 
     const std::vector< float > offDiagVec = tp.definingParametersCovMatrixOffDiagVec();
     tp.setDefiningParametersCovMatrixOffDiagVec( compressOffDiag( offDiagVec, m_offDiagCovMatrixBits ) );
     int offDiagComprBits = m_offDiagCovMatrixBits;
 
     // Need to check determinant of the matrix + its inverse to prevent any precision issue in inverse computation
     while( ( tp.definingParametersCovMatrix().determinant() <= 0.0 || tp.definingParametersCovMatrix().inverse().determinant() <= 0.0 ) &&
        ( ++offDiagComprBits <= m_diagCovMatrixBits ) ) {
       tp.setDefiningParametersCovMatrixOffDiagVec( compressOffDiag( offDiagVec, offDiagComprBits ) );
     }
 
     // Return gracefully:
     return StatusCode::SUCCESS;
   }

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

◆ 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

◆ initialize()

StatusCode xAODMaker::TrackParticleCompressorTool::initialize ( )

override

Function initialising the tool.

Definition at line 36 of file TrackParticleCompressorTool.cxx.

                                                      {
 
      // Greet the user:
      ATH_MSG_INFO( "Initialising");
      ATH_MSG_INFO( "  OffDiagCovMatrixBits = " << m_offDiagCovMatrixBits );
      ATH_MSG_INFO( "  DiagCovMatrixBits    = " << m_diagCovMatrixBits );
      ATH_MSG_INFO( "  UseOffDiagCompr = " << m_useOffDiagCompr );
 
 
      // Create the helper objects:
      m_diagCovMatrixCompressor = std::make_unique<CxxUtils::FloatCompressor>(
               m_diagCovMatrixBits );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

◆ 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.

◆ interfaceID()

const InterfaceID & xAODMaker::ITrackParticleCompressorTool::interfaceID ( )

inlinestaticinherited

Gaudi interface definition.

Definition at line 43 of file ITrackParticleCompressorTool.h.

                                              {
         return IID_ITrackParticleCompressorTool;
      }

◆ 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_diagCovMatrixBits

int xAODMaker::TrackParticleCompressorTool::m_diagCovMatrixBits

private

The number of mantissa bits to keep for the diagonal covariance matrix elements.

Definition at line 57 of file TrackParticleCompressorTool.h.

◆ m_diagCovMatrixCompressor

std::unique_ptr< CxxUtils::FloatCompressor > xAODMaker::TrackParticleCompressorTool::m_diagCovMatrixCompressor

private

Helper object for compressing the on-diagonal covariance matrix elements.

Definition at line 63 of file TrackParticleCompressorTool.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_offDiagCovMatrixBits

int xAODMaker::TrackParticleCompressorTool::m_offDiagCovMatrixBits

private

The number of mantissa bits to keep for off-diagonal covariance matrix elements.

Definition at line 54 of file TrackParticleCompressorTool.h.

◆ m_useOffDiagCompr

bool xAODMaker::TrackParticleCompressorTool::m_useOffDiagCompr

private

Definition at line 59 of file TrackParticleCompressorTool.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TrackParticleCompressorTool()

Member Function Documentation

◆ compress()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_diagCovMatrixBits

◆ m_diagCovMatrixCompressor

◆ m_evtStore

◆ m_offDiagCovMatrixBits

◆ m_useOffDiagCompr

◆ m_varHandleArraysDeclared

◆ m_vhka