Algorithm to filter CaloCellContainer. More...

#include <CaloCellFilterAlg.h>

Inheritance diagram for CaloCellFilterAlg:

Collaboration diagram for CaloCellFilterAlg:

Public Member Functions
	CaloCellFilterAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Regular Gaudi Algorithm constructor.
virtual StatusCode	initialize ()
	Function executed before the event loop starts.
virtual StatusCode	execute ()
	Function executed for each event.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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	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

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
std::string	m_cellsName
	Cell container.
std::string	m_outputCellsName
	output Cell container
int	m_maxNCells
	Maximum number of cells to accept.
std::vector< unsigned int >	m_caloNums
	which calo to treat
float	m_cellEnergyThreshold
	threshold on cell energy for ntuple
float	m_sigmaCut
	cut on abs(E)/sigmaNoise (no cut if <0 )
std::vector< unsigned int >	m_caloSamplings
	which calo samplings to treat
const LArEM_ID *	m_emid
const LArFCAL_ID *	m_fcalid
const LArHEC_ID *	m_hecid
const TileID *	m_tileid
SG::ReadCondHandleKey< CaloNoise >	m_caloNoiseKey
	Key of the CaloNoise Conditions data object.
bool	m_caloSelection
bool	m_caloSamplingSelection
DataObjIDColl	m_extendedExtraObjects
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

Algorithm to filter CaloCellContainer.

Author: Hong Ma March 2010

$Revision$ $Date$

Definition at line 35 of file CaloCellFilterAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CaloCellFilterAlg()

CaloCellFilterAlg::CaloCellFilterAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Regular Gaudi Algorithm constructor.

Definition at line 21 of file CaloCellFilterAlg.cxx.

   : AthAlgorithm( name, pSvcLocator ), 
     m_cellsName( "AllCalo" ), m_outputCellsName( "SelectedCells" ),
     m_maxNCells( 0 ),m_cellEnergyThreshold( 0. ),
     m_sigmaCut( -1 ),
     m_emid( 0 ),
     m_fcalid( 0 ),
     m_hecid( 0 ),
     m_tileid( 0 ),
     m_caloSelection( false ),
     m_caloSamplingSelection( false ) {
 
   // string property for Cell container 
   declareProperty( "CellsName", m_cellsName );
   // string property for Cell container 
   declareProperty( "OutputCellsName", m_outputCellsName );
   // list of calo to treat
   declareProperty( "CaloNums", m_caloNums );
   // string property for Cell container 
   declareProperty( "MaxNCells", m_maxNCells );
   //  declareProperty("ThresholdGeVCells",m_thresholdGeVCells);
   // m_thresholdGeVCells --> m_cellEnergyThreshold
   declareProperty( "CellEnergyThreshold", m_cellEnergyThreshold );
   declareProperty( "CellSigmaCut", m_sigmaCut );
   // list of calo samplings to treat
   declareProperty( "CaloSamplings", m_caloSamplings );
}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode CaloCellFilterAlg::execute ( )

virtual

Function executed for each event.

Definition at line 133 of file CaloCellFilterAlg.cxx.

                                      {
 
   REPORT_MESSAGE( MSG::VERBOSE ) << " in execute";
 
   // typedef ObjectVector<CaloCell> CONTAINER; 
   typedef CaloCellContainer CONTAINER; 
 
   const CONTAINER* cellcoll = nullptr;
   CHECK( evtStore()->retrieve( cellcoll, m_cellsName ) ); 
 
   ConstDataVector<CONTAINER>* outputCont = new ConstDataVector<CaloCellContainer>( SG::VIEW_ELEMENTS );
   CHECK( evtStore()->record( outputCont, m_outputCellsName ) );
  
   REPORT_MESSAGE( MSG::VERBOSE ) << " EM Cell container: " << m_cellsName; 
  
   CONTAINER::const_iterator f_cell = cellcoll->begin();
   CONTAINER::const_iterator l_cell = cellcoll->end();
 
   int index = 0;
 
   bool useNoiseCut = false;
   if( ! m_caloNoiseKey.empty() ) useNoiseCut = true;
 
   for( ; f_cell != l_cell; ++f_cell ) {
 
      const CaloCell* cell = ( *f_cell ); 
 
      if( m_caloSelection ) {
         // keep only cells from desired calorimeter
         const unsigned int iCaloNum =
            static_cast< unsigned int >( cell->caloDDE()->getSubCalo() );
         std::vector< unsigned int >::const_iterator theFound =
            std::find( m_caloNums.begin(), m_caloNums.end(), iCaloNum );
         if( theFound == m_caloNums.end() ) continue;
      }
      
      if ( m_caloSamplingSelection ) {
        // keep only cells from desired calorimeter sampling
         const unsigned int iCaloSampling =
            static_cast< unsigned int >( cell->caloDDE()->getSampling() );
         std::vector< unsigned int >::const_iterator theFound =
            std::find( m_caloSamplings.begin(), m_caloSamplings.end(), iCaloSampling );
         if( theFound == m_caloSamplings.end() ) continue;
      }
      
      const float e = cell->energy(); 
      
      //fill cell by cell ntuple if required
      if( m_maxNCells >= 0 ) {
 
         if( ( m_maxNCells == 0 ) || ( index < m_maxNCells ) ) {
 
            const float th = m_cellEnergyThreshold;
            static const double epsilon = 0.001;
 
            if( std::abs( th ) > epsilon ) {
               if( th > 0. ) {
                  if( ! ( e > th ) ) continue;
               } else if( th < 0. ) {
                  if( ! ( std::abs( e ) > std::abs( th ) ) ) continue;
               }
            }
 
            if( useNoiseCut ) {
               SG::ReadCondHandle<CaloNoise> caloNoise{m_caloNoiseKey};
               float sigma = caloNoise->getNoise( cell->ID(), cell->gain() );
               if( std::abs( e ) < sigma * m_sigmaCut ) continue;
            }
 
            outputCont->push_back( cell ); 
            ++index;
 
         } else {
 
            if( m_maxNCells == index ) {
               ATH_MSG_WARNING( " Too many cells. Save only " 
                                << m_maxNCells );
               break;
            }
         }
      }
   }
 
   return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ initialize()

StatusCode CaloCellFilterAlg::initialize ( )

virtual

Function executed before the event loop starts.

Definition at line 50 of file CaloCellFilterAlg.cxx.

                                         {
 
   ATH_MSG_INFO( "Initializing" );
   ATH_MSG_INFO( " reading CaloCellContainer " << m_cellsName );
   ATH_MSG_INFO( " CellEnergyThreshold  " << m_cellEnergyThreshold );
   ATH_MSG_INFO( " CellSigmaCut  " << m_sigmaCut );
   if( m_maxNCells < 0 ) {
      ATH_MSG_WARNING( " no cell to select, set jobOpt MaxNCells to the max "
                       "number of cells you want" );
   } else {
      if( m_maxNCells == 0 ) {
         ATH_MSG_WARNING( " select all cells" );
      } else {
         ATH_MSG_INFO( " select cells up to " << m_maxNCells << " cells" );
      }
   }
   ATH_MSG_INFO( " ....applying threshold " << m_cellEnergyThreshold );
 
   CHECK( detStore()->retrieve( m_emid ) );
   CHECK( detStore()->retrieve( m_fcalid ) );
   CHECK( detStore()->retrieve( m_hecid ) );
   CHECK( detStore()->retrieve( m_tileid ) );
 
   ATH_CHECK( m_caloNoiseKey.initialize(SG::AllowEmpty) );
 
   const unsigned int nSubCalo = static_cast< int >( CaloCell_ID::NSUBCALO );
 
   //check calo number specified
   m_caloSelection = false;
   if( m_caloNums.size() == 0 ) {
      ATH_MSG_INFO( " No calorimeter selection" );
      return StatusCode::SUCCESS;
   } else if( m_caloNums.size() > nSubCalo ) {
      REPORT_MESSAGE( MSG::FATAL )
         << " More than " << nSubCalo << " calo specified. "
         << "Must be wrong. Stop.";
      return StatusCode::FAILURE;
   } else {
      m_caloSelection = true;
 
      for( unsigned int index = 0; index < m_caloNums.size(); ++index ) {
         if( m_caloNums[ index ]>= nSubCalo ) {
            REPORT_MESSAGE( MSG::FATAL )
               << "Invalid calo specification:" 
               << m_caloNums[index] << "Stop.";
            return StatusCode::FAILURE;
         } else {
            ATH_MSG_INFO( " Select calorimeter " << m_caloNums[ index ] );
         }
      }
   }
   
   const unsigned int nCaloSamplings = static_cast< int >( CaloCell_ID::Unknown );
 
   //check calo samplings specified
   m_caloSamplingSelection = false;
   if( m_caloSamplings.size() == 0 ) {
      ATH_MSG_INFO( " No calorimeter sampling selection" );
      return StatusCode::SUCCESS;
   } else if( m_caloSamplings.size() > nCaloSamplings ) {
      REPORT_MESSAGE( MSG::FATAL )
         << " More than " << nCaloSamplings << " calo samplings specified. "
         << "Must be wrong. Stop.";
      return StatusCode::FAILURE;
   } else {
      m_caloSamplingSelection = true;
 
      for( unsigned int index = 0; index < m_caloSamplings.size(); ++index ) {
         if( m_caloSamplings[ index ]>= nCaloSamplings ) {
            REPORT_MESSAGE( MSG::FATAL )
               << "Invalid calo sampling specification:" 
               << m_caloSamplings[index] << "Stop.";
            return StatusCode::FAILURE;
         } else {
            ATH_MSG_INFO( " Select calorimeter sampling " << m_caloSamplings[ index ] );
         }
      }
   }
 
   return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_caloNoiseKey

SG::ReadCondHandleKey<CaloNoise> CaloCellFilterAlg::m_caloNoiseKey

private

Initial value:

{this,

"CaloNoise", "", "Calo noise object name"}

Key of the CaloNoise Conditions data object.

Typical values are '"electronicNoise', 'pileupNoise', or '"totalNoise'

Definition at line 66 of file CaloCellFilterAlg.h.

66 {this,

67 "CaloNoise", "", "Calo noise object name"};

◆ m_caloNums

std::vector< unsigned int > CaloCellFilterAlg::m_caloNums

private

which calo to treat

Definition at line 51 of file CaloCellFilterAlg.h.

◆ m_caloSamplings

std::vector< unsigned int > CaloCellFilterAlg::m_caloSamplings

private

which calo samplings to treat

Definition at line 55 of file CaloCellFilterAlg.h.

◆ m_caloSamplingSelection

bool CaloCellFilterAlg::m_caloSamplingSelection

private

Definition at line 70 of file CaloCellFilterAlg.h.

◆ m_caloSelection

bool CaloCellFilterAlg::m_caloSelection

private

Definition at line 69 of file CaloCellFilterAlg.h.

◆ m_cellEnergyThreshold

float CaloCellFilterAlg::m_cellEnergyThreshold

private

threshold on cell energy for ntuple

Definition at line 52 of file CaloCellFilterAlg.h.

◆ m_cellsName

std::string CaloCellFilterAlg::m_cellsName

private

Cell container.

Definition at line 48 of file CaloCellFilterAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_emid

const LArEM_ID* CaloCellFilterAlg::m_emid

private

Definition at line 57 of file CaloCellFilterAlg.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_fcalid

const LArFCAL_ID* CaloCellFilterAlg::m_fcalid

private

Definition at line 58 of file CaloCellFilterAlg.h.

◆ m_hecid

const LArHEC_ID* CaloCellFilterAlg::m_hecid

private

Definition at line 59 of file CaloCellFilterAlg.h.

◆ m_maxNCells

int CaloCellFilterAlg::m_maxNCells

private

Maximum number of cells to accept.

Definition at line 50 of file CaloCellFilterAlg.h.

◆ m_outputCellsName

std::string CaloCellFilterAlg::m_outputCellsName

private

output Cell container

Definition at line 49 of file CaloCellFilterAlg.h.

◆ m_sigmaCut

float CaloCellFilterAlg::m_sigmaCut

private

cut on abs(E)/sigmaNoise (no cut if <0 )

Definition at line 54 of file CaloCellFilterAlg.h.

◆ m_tileid

const TileID* CaloCellFilterAlg::m_tileid

private

Definition at line 60 of file CaloCellFilterAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloCellFilterAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloNoiseKey

◆ m_caloNums

◆ m_caloSamplings

◆ m_caloSamplingSelection

◆ m_caloSelection

◆ m_cellEnergyThreshold

◆ m_cellsName

◆ m_detStore

◆ m_emid

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_fcalid

◆ m_hecid

◆ m_maxNCells

◆ m_outputCellsName

◆ m_sigmaCut

◆ m_tileid

◆ m_varHandleArraysDeclared

◆ m_vhka