#include <LArCaliWaveSelector.h>

Inheritance diagram for LArCaliWaveSelector:

Collaboration diagram for LArCaliWaveSelector:

Public Member Functions
	LArCaliWaveSelector (const std::string &name, ISvcLocator *pSvcLocator)
	~LArCaliWaveSelector ()
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	stop ()
StatusCode	finalize ()
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
void	parseSelection ()
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}
const CaloCell_ID *	m_cellID
std::map< DetGain, int >	m_mapDAC
unsigned short	m_gmask
std::vector< std::string >	m_keyList
std::vector< std::string >	m_selectionList
std::string	m_outputKey
std::string	m_groupingType
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

Definition at line 28 of file LArCaliWaveSelector.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

◆ LArCaliWaveSelector()

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

Definition at line 23 of file LArCaliWaveSelector.cxx.

 : AthAlgorithm(name, pSvcLocator),
   m_cellID(nullptr),
   m_gmask(0),
   m_groupingType("ExtendedFeedThrough") 
{
 declareProperty("SelectionList",    m_selectionList); // Vector of strings of det/lay/gain/DAC -> "EMB/0/0/200"
                                                       // Known detectors EMB, EMEC, HEC, FCAL
                                                       // Available layers 0-3, gains 0-2, DAC 0-65000
 declareProperty("KeyList",          m_keyList);
 declareProperty("KeyOutput",        m_outputKey); 
 declareProperty("GroupingType",     m_groupingType);
}

◆ ~LArCaliWaveSelector()

LArCaliWaveSelector::~LArCaliWaveSelector ( )

default

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 LArCaliWaveSelector::execute ( )

inline

Definition at line 35 of file LArCaliWaveSelector.h.

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

◆ finalize()

StatusCode LArCaliWaveSelector::finalize ( )

inline

Definition at line 37 of file LArCaliWaveSelector.h.

37{ return StatusCode::SUCCESS;}

◆ initialize()

StatusCode LArCaliWaveSelector::initialize ( )

Definition at line 40 of file LArCaliWaveSelector.cxx.

{ 
  ATH_MSG_INFO ( " in initialize.." );
 
  // Default list
  if (m_keyList.empty()) { m_keyList.emplace_back("LArCaliWave"); }
  parseSelection();
 
  ATH_CHECK( detStore()->retrieve (m_cellID, "CaloCell_ID") );
  if (!m_cellID) {
    ATH_MSG_ERROR ( "Could not access CaloCell_ID helper" );
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK(  m_cablingKey.initialize() );
 
  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.

◆ parseSelection()

void LArCaliWaveSelector::parseSelection ( )

private

Definition at line 141 of file LArCaliWaveSelector.cxx.

{
  int det,lay,gain,DAC;
  std::string selstr;
  for(unsigned i=0; i<m_selectionList.size(); ++i) {
     std::string::size_type det_delimiter( m_selectionList[i].find('/') );
     if( std::string::npos == det_delimiter ){
       ATH_MSG_WARNING ( "Bad selection string: "<< m_selectionList[i] << " skipped...." );
       continue;
     }
     std::string det_string = m_selectionList[i].substr(0, det_delimiter);
     if(det_string=="EMB") {
        det = 0;
     } else if (det_string == "EMEC") {
        det = 1;
     } else if (det_string == "HEC") {
        det = 2;
     } else if (det_string == "FCAL") {
        det = 3;
     } else {
       ATH_MSG_WARNING ( "Bad detector substring: " << det_string << " skipped ... " );
       continue;
     }
     std::string::size_type lay_delimiter( m_selectionList[i].find('/',det_delimiter+1) );
     lay = atoi(m_selectionList[i].substr(det_delimiter+1, lay_delimiter).c_str());
     if(lay < 0 || lay > 3) {
       ATH_MSG_WARNING ( "Bad layer: " << lay << " skipped..." );
       continue;
     }
     std::string::size_type gain_delimiter( m_selectionList[i].find('/',lay_delimiter+1) );
     gain = atoi(m_selectionList[i].substr(lay_delimiter+1, gain_delimiter).c_str());
     if(gain < 0 || gain > 2) {
       ATH_MSG_WARNING ( "Bad gain: " << gain << " skipped..." );
       continue;
     }
     DAC = atoi(m_selectionList[i].substr(gain_delimiter+1).c_str());
     if(DAC < 0 || DAC > 65000) {
       ATH_MSG_WARNING ( "Bad DAC: " << DAC << " skipped..." );
       continue;
     }
 
     // Now we have all numbers
     m_mapDAC[std::make_pair( std::make_pair(det,lay), gain)] = DAC;
     m_gmask |= (0x1<<gain);
  }
}

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

◆ stop()

StatusCode LArCaliWaveSelector::stop ( )

Definition at line 60 of file LArCaliWaveSelector.cxx.

{
  ATH_MSG_INFO ( " in stop.." );
 
  SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey};
  const LArOnOffIdMapping* cabling{*cablingHdl};
  if(!cabling){
     ATH_MSG_ERROR("Do not have mapping object " << m_cablingKey.key() );
     return StatusCode::FAILURE;
  }
 
  // create empty LArCaliWaveContainer to store DAC selected LArCaliWave
  // make it view container
//  LArCaliWaveContainer* selectedCaliWaveContainer = new LArCaliWaveContainer(SG::VIEW_ELEMENTS);
  auto selectedCaliWaveContainer = std::make_unique<LArCaliWaveContainer>();
  CHECK( selectedCaliWaveContainer->setGroupingType(m_groupingType,msg()));
  CHECK( selectedCaliWaveContainer->initialize());
 
  std::vector<std::string>::const_iterator key_it   = m_keyList.begin();
  std::vector<std::string>::const_iterator key_it_e = m_keyList.end();
 
  for (;key_it!=key_it_e; ++key_it) {
    const LArCaliWaveContainer* larCaliWaveContainer;    
    StatusCode sc = detStore()->retrieve(larCaliWaveContainer,*key_it);
    if (sc.isFailure()) {
      ATH_MSG_WARNING ( "No LArCaliWaveContainer in StoreGate with key = " << *key_it );
      continue; 
    } else {
      ATH_MSG_INFO ( "Reading LArCaliWaveContainer with key = " << *key_it );
    }
 
    int det, lay;
    for ( unsigned gain = CaloGain::LARHIGHGAIN ; gain < CaloGain::LARNGAIN ; ++gain ) {
         if(!( (0x1<<gain) & m_gmask) ) continue;
 
         CaliMapIt cali_it = larCaliWaveContainer->begin(gain) ;
         CaliMapIt cali_it_e = larCaliWaveContainer->end(gain) ;
 
         if ( cali_it == cali_it_e ) {
           ATH_MSG_DEBUG ( "No wave with gain = " << gain << " in container with key = " << *key_it );
           continue;
         } else {
           ATH_MSG_DEBUG ( "processing gain = " << gain );
         }
         for ( ; cali_it != cali_it_e; ++cali_it) {
            
            CaliWaveIt wave_it   = cali_it->begin();
        CaliWaveIt wave_it_e = cali_it->end();
            if ( wave_it == wave_it_e ) {
               ATH_MSG_DEBUG ( "Empty channel found..." );
           continue; 
            } 
    
       HWIdentifier chid = cali_it.channelId();
           Identifier cell_id = cabling->cnvToIdentifier(chid);
           if(m_cellID->is_em_barrel(cell_id)){ det = 0;
           } else if(m_cellID->is_em_endcap(cell_id)) { det = 1;
           } else if(m_cellID->is_hec(cell_id)) { det = 2;
           } else if(m_cellID->is_fcal(cell_id)) { det = 3;
           } else {
             ATH_MSG_ERROR ( "Wrong ID in LArCaliWaveContainer: "<<m_cellID->print_to_string(cell_id));
             continue;
           }
           lay = m_cellID->sampling(cell_id);
           DetGain dg = std::make_pair( std::make_pair(det,lay), gain);
           if( m_mapDAC.find(dg) == m_mapDAC.end() ) continue;
        
           for ( ; wave_it != wave_it_e; ++wave_it) {
              if(wave_it->getDAC() == m_mapDAC[dg]) {
                 (selectedCaliWaveContainer->get(chid,gain)).push_back(*wave_it);
                 break;
              }
           }
         }
    }
  } 
 
  ATH_CHECK( detStore()->record(std::move(selectedCaliWaveContainer),m_outputKey) );
  return StatusCode::SUCCESS;
}

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

SG::ReadCondHandleKey<LArOnOffIdMapping> LArCaliWaveSelector::m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}

private

Definition at line 41 of file LArCaliWaveSelector.h.

41{this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"};

◆ m_cellID

const CaloCell_ID* LArCaliWaveSelector::m_cellID

private

Definition at line 45 of file LArCaliWaveSelector.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_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_gmask

unsigned short LArCaliWaveSelector::m_gmask

private

Definition at line 48 of file LArCaliWaveSelector.h.

◆ m_groupingType

std::string LArCaliWaveSelector::m_groupingType

private

Definition at line 53 of file LArCaliWaveSelector.h.

◆ m_keyList

std::vector<std::string> LArCaliWaveSelector::m_keyList

private

Definition at line 50 of file LArCaliWaveSelector.h.

◆ m_mapDAC

std::map<DetGain, int> LArCaliWaveSelector::m_mapDAC

private

Definition at line 47 of file LArCaliWaveSelector.h.

◆ m_outputKey

std::string LArCaliWaveSelector::m_outputKey

private

Definition at line 52 of file LArCaliWaveSelector.h.

◆ m_selectionList

std::vector<std::string> LArCaliWaveSelector::m_selectionList

private

Definition at line 51 of file LArCaliWaveSelector.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

◆ LArCaliWaveSelector()

◆ ~LArCaliWaveSelector()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ parseSelection()

◆ renounce()

◆ renounceArray()

◆ stop()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cablingKey

◆ m_cellID

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_gmask

◆ m_groupingType

◆ m_keyList

◆ m_mapDAC

◆ m_outputKey

◆ m_selectionList

◆ m_varHandleArraysDeclared

◆ m_vhka