LArCalibShortCorrector Class Reference

#include <LArCalibShortCorrector.h>

Inheritance diagram for LArCalibShortCorrector:

Collaboration diagram for LArCalibShortCorrector:

Public Member Functions
	LArCalibShortCorrector (const std::string &name, ISvcLocator *pSvcLocator)
	~LArCalibShortCorrector ()
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
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 std::vector< std::pair< HWIdentifier, HWIdentifier > >::const_iterator	SHORT_IT
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
SG::ReadCondHandleKey< LArBadChannelCont >	m_BCKey {this, "BadChanKey", "LArBadChannel", "SG key for LArBadChan object"}
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this, "OnOffMap", "LArOnOffIdMap", "SG key for mapping object"}
const LArOnlineID *	m_onlineId
const CaloCell_ID *	m_caloCellId
std::vector< std::string >	m_keylist
std::string	m_pedKey
std::vector< std::pair< HWIdentifier, HWIdentifier > >	m_shortedNeighbors
bool	m_shortsCached
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 25 of file LArCalibShortCorrector.h.

Member Typedef Documentation

SHORT_IT

typedef std::vector<std::pair<HWIdentifier,HWIdentifier>>::const_iterator LArCalibShortCorrector::SHORT_IT

private

Definition at line 52 of file LArCalibShortCorrector.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArCalibShortCorrector()

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

Definition at line 16 of file LArCalibShortCorrector.cxx.

                                                                                              : 
  AthAlgorithm(name, pSvcLocator),
  m_onlineId(nullptr),
  m_caloCellId(nullptr)
{
  declareProperty("KeyList", m_keylist,
          "List of input keys (normally the 'HIGH','MEDIUM','LOW')"); 
  declareProperty("PedestalKey",m_pedKey="Pedestal",
          "Key of the pedestal object (to be subtracted)");
  m_shortsCached=false;
}

~LArCalibShortCorrector()

LArCalibShortCorrector::~LArCalibShortCorrector ( )

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode LArCalibShortCorrector::execute ( )

overridevirtual

Definition at line 119 of file LArCalibShortCorrector.cxx.

                                          {
  if (!m_shortsCached){
    ATH_CHECK( findShortedNeighbors() );
    m_shortsCached=true;
  }
  const size_t nShorts=m_shortedNeighbors.size();
 
  const ILArPedestal* larPedestal = nullptr;
  ATH_CHECK( detStore()->retrieve (larPedestal, m_pedKey) );
  
  //Loop over all digits in all containers to find the shorted ones
  
  const LArAccumulatedCalibDigitContainer* larAccumulatedCalibDigitContainer;
  
  // now start to deal with digits   
 
  for (const std::string& key : m_keylist) {
    StatusCode sc = evtStore()->retrieve(larAccumulatedCalibDigitContainer,key);
    if (sc.isFailure()){ 
      ATH_MSG_WARNING ( "Cannot read LArAccumulatedCalibDigitContainer from StoreGate! key=" << key );
      continue; // Try next container
    }
    
 
    std::vector<std::pair<const LArAccumulatedCalibDigit*, const LArAccumulatedCalibDigit*> > shortedDigits;
    shortedDigits.resize(nShorts);
 
    LArAccumulatedCalibDigitContainer::const_iterator it=larAccumulatedCalibDigitContainer->begin();
    LArAccumulatedCalibDigitContainer::const_iterator it_e=larAccumulatedCalibDigitContainer->end();    
    if(it == it_e) {
      ATH_MSG_VERBOSE ( "LArAccumulatedCalibDigitContainer with key = " << key << " is empty " );
      //return StatusCode::SUCCESS;
      continue; // Try next container
    } else {
      ATH_MSG_DEBUG ( "Processing LArAccumulatedCalibDigitContainer with key = " << key 
                      << ". Size: " << larAccumulatedCalibDigitContainer->size() );
    }
 
    for(;it!=it_e;++it) { //Loop over calib-digits
      const HWIdentifier chid=(*it)->hardwareID();
      size_t ii;    
      for (ii=0;ii<nShorts;ii++)
    if (m_shortedNeighbors[ii].first==chid || m_shortedNeighbors[ii].second==chid) break;
      if (ii==nShorts) continue; //Not found on the list of shorts
      
      //Got a channel on the list of shorted channels: Remember their pointers!
      if ((*it)->isPulsed()) 
    shortedDigits[ii].first=*it;
      else
    shortedDigits[ii].second=*it;
    }//end loop over cells
    
 
    for (size_t ii=0;ii<nShorts;ii++) {
      if (shortedDigits[ii].first==NULL) continue; //Not in the data at all, or only the not-pulsed channel in the data
      if (shortedDigits[ii].second==NULL) { //Only the pulsed channel in the data
    ATH_MSG_WARNING ( "Second channel of a shorted pair not found in data. Try factor 2 correction." );
    shortedDigits[ii].second=shortedDigits[ii].first;
      }
 
      const std::vector<uint64_t>& sampleSumsPulsed=shortedDigits[ii].first->sampleSum();
      const std::vector<uint64_t>& sampleSumsNeighbor=shortedDigits[ii].second->sampleSum();
 
      std::vector<uint64_t> newSampleSum(sampleSumsPulsed.size());
      
 
      if (sampleSumsPulsed.size() != sampleSumsNeighbor.size()) {
    ATH_MSG_ERROR ( "Inconsistent size of samples-vector!" );
    return StatusCode::FAILURE;
      }
 
      if (shortedDigits[ii].first->nTriggers() != shortedDigits[ii].second->nTriggers()) {
    ATH_MSG_ERROR ( "Inconsistent number of Triggers!" );
    return StatusCode::FAILURE;
      }
 
 
      float pedestal = larPedestal->pedestal(shortedDigits[ii].second->hardwareID(),
                                             shortedDigits[ii].second->gain());
      if (pedestal<= (1.0+LArElecCalib::ERRORCODE)) {
    ATH_MSG_ERROR ( "Failed to get pedestal for channel " <<  m_onlineId->channel_name(shortedDigits[ii].second->hardwareID())
                        << ", gain=" << shortedDigits[ii].second->gain() );
    return StatusCode::FAILURE;
      }
      const unsigned int ped=(unsigned)round(double(pedestal)*shortedDigits[ii].second->nTriggers());
 
     
      for (size_t is=0;is<sampleSumsPulsed.size();++is) {
    //std::cout << "Sample #"<< is << "=" << sampleSumsPulsed[is] << "+" << sampleSumsNeighbor[ii] << "-" << ped << "=";
    newSampleSum[is]=sampleSumsPulsed[is]+(sampleSumsNeighbor[is]-ped);
    //std::cout << newSampleSum[is] << std::endl;
      }
      // FIXME: const_cast can change objects in SG.
      const_cast<LArAccumulatedCalibDigit*>(shortedDigits[ii].first)->setSampleSum(newSampleSum);
    }//end loop over pairs of shorted digits
  }//end loop over container keys
  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();
}

findShortedNeighbors()

StatusCode LArCalibShortCorrector::findShortedNeighbors ( )

private

Definition at line 38 of file LArCalibShortCorrector.cxx.

                                                        {
  //The current implementation assumes that we have very few shorted cells. 
  //Currently we have 2 pairs (one in EMBA, one in EMBC).
  //If we find more shorts, the simple, un-ordered vector and linear search should be 
  //replaced by something faster
  SG::ReadCondHandle<LArBadChannelCont> bcHdl{m_BCKey};
  const LArBadChannelCont* bcCont{*bcHdl};
  if(!bcCont) {
     ATH_MSG_ERROR( "Do not have bad channels !" );
     return StatusCode::FAILURE;
  }
  SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey};
  const LArOnOffIdMapping* cabling{*cablingHdl};
  if(!cabling) {
     ATH_MSG_ERROR( "Do not have cabling object LArOnOffIdMapping");
     return StatusCode::FAILURE;
  }
 
  m_shortedNeighbors.clear();
  //Loop over all identifers (maybe better if we would have a loop only over bad-cahnnels)
   for (const HWIdentifier chid1 : m_onlineId->channel_range()) {
     if (bcCont->status(chid1).shortProblem()) {
       //Already found?
       SHORT_IT sit=m_shortedNeighbors.begin();
       SHORT_IT sit_e=m_shortedNeighbors.end();
       for (;sit!=sit_e && sit->second!=chid1;++sit)
         ;
       if (sit!=sit_e) continue; //This short was already found as neighbor of another shorted cell
    
       const Identifier id1=cabling->cnvToIdentifier(chid1);
       const IdentifierHash id1_h=m_caloCellId->calo_cell_hash(id1);
       ATH_MSG_DEBUG ( "Channel " << chid1.get_compact() << " marked as short" );
       //Find neighbor
       std::vector<IdentifierHash> neighbors;
       m_caloCellId->get_neighbours(id1_h,LArNeighbours::faces2D,neighbors);
       HWIdentifier chid2;
       if (neighbors.empty()) {
     ATH_MSG_ERROR ( "No neighbors found for channel with id " << m_onlineId->channel_name(chid1) );
     return StatusCode::FAILURE;
       }
       else
     ATH_MSG_DEBUG ( " Found " << neighbors.size() << " neighbors found for channel with id " << m_onlineId->channel_name(chid1) );
 
       
       std::vector<IdentifierHash>::const_iterator nbrit=neighbors.begin();
       std::vector<IdentifierHash>::const_iterator nbrit_e=neighbors.end();
       for (;nbrit!=nbrit_e;++nbrit) {
     const HWIdentifier chid_nbr=cabling->createSignalChannelIDFromHash(*nbrit);
     if (bcCont->status(chid_nbr).shortProblem()) { //Found neighbor with 'short'
       if (chid2.is_valid()) {
         ATH_MSG_ERROR ( "Found more than one neighbor with short bit set! Identifiers: "
                             << m_onlineId->channel_name(chid1) << ", "
                             << m_onlineId->channel_name(chid2) << ", "
                             << m_onlineId->channel_name(chid_nbr) );
         return StatusCode::FAILURE;
       }
       else {
         chid2=chid_nbr;
         ATH_MSG_DEBUG ( "Found pair " << m_onlineId->channel_name(chid1) << " " <<  m_onlineId->channel_name(chid2) );
       }
     }
       }//End loop over neighbors
       if (!chid2.is_valid()) {
     ATH_MSG_ERROR ( "No neighbor with 'short' bit set for channel with id: " << chid1.get_compact() );
     return StatusCode::FAILURE;
       }
       m_shortedNeighbors.emplace_back(chid1,chid2);
     }//end this channel has a short
   }//End loop over all identifiers
 
   if (msgLvl(MSG::INFO)) {
     ATH_MSG_INFO ( "Found " << m_shortedNeighbors.size() << " pairs of shorted neighbors" );
     for (const std::pair<HWIdentifier, HWIdentifier>& p : m_shortedNeighbors)
       ATH_MSG_INFO ( " Shorted pair: " << m_onlineId->channel_name(p.first) << ", " << m_onlineId->channel_name(p.second) );
   }
 
   return StatusCode::SUCCESS;
}

initialize()

StatusCode LArCalibShortCorrector::initialize ( )

overridevirtual

Definition at line 30 of file LArCalibShortCorrector.cxx.

                                              {
  ATH_CHECK( m_BCKey.initialize() );
  ATH_CHECK( m_cablingKey.initialize() );
  ATH_CHECK( detStore()->retrieve(m_onlineId, "LArOnlineID") );
  ATH_CHECK( detStore()->retrieve(m_caloCellId, "CaloCell_ID") );
  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_BCKey

SG::ReadCondHandleKey<LArBadChannelCont> LArCalibShortCorrector::m_BCKey {this, "BadChanKey", "LArBadChannel", "SG key for LArBadChan object"}

private

Definition at line 40 of file LArCalibShortCorrector.h.

{this, "BadChanKey", "LArBadChannel", "SG key for LArBadChan object"};

m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArCalibShortCorrector::m_cablingKey {this, "OnOffMap", "LArOnOffIdMap", "SG key for mapping object"}

private

Definition at line 41 of file LArCalibShortCorrector.h.

{this, "OnOffMap", "LArOnOffIdMap", "SG key for mapping object"};

m_caloCellId

const CaloCell_ID* LArCalibShortCorrector::m_caloCellId

private

Definition at line 44 of file LArCalibShortCorrector.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_keylist

std::vector<std::string> LArCalibShortCorrector::m_keylist

private

Definition at line 47 of file LArCalibShortCorrector.h.

m_onlineId

const LArOnlineID* LArCalibShortCorrector::m_onlineId

private

Definition at line 43 of file LArCalibShortCorrector.h.

m_pedKey

std::string LArCalibShortCorrector::m_pedKey

private

Definition at line 48 of file LArCalibShortCorrector.h.

m_shortedNeighbors

std::vector<std::pair<HWIdentifier,HWIdentifier> > LArCalibShortCorrector::m_shortedNeighbors

private

Definition at line 51 of file LArCalibShortCorrector.h.

m_shortsCached

bool LArCalibShortCorrector::m_shortsCached

private

Definition at line 54 of file LArCalibShortCorrector.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:

• LArCalibShortCorrector.h
• LArCalibShortCorrector.cxx