LArRawChannelBuilderToolTileInfo Class Reference

Obtain ADC_max for the Tile using Optimal Filtering. More...

#include <LArRawChannelBuilderToolTileInfo.h>

Inheritance diagram for LArRawChannelBuilderToolTileInfo:

Collaboration diagram for LArRawChannelBuilderToolTileInfo:

Public Member Functions
	LArRawChannelBuilderToolTileInfo (const std::string &type, const std::string &name, const IInterface *parent)
bool	buildRawChannel (const LArDigit *digit, float pedestal, const std::vector< float > &ramps, MsgStream *pLog)
StatusCode	initTool ()
void	initEventHidden ()
int	energy ()
int	time ()
CaloGain::CaloGain	gain ()
void	BuildLArCell (int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
void	BuildLArRawChannel (int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)
StatusCode	initToolHidden (LArRawChannelBuilderParams *myParent)
virtual void	initEvent ()
virtual void	finalEventHidden ()
virtual void	finalEvent ()
virtual void	printSummary ()
Identifier	currentID ()
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Public Attributes
void(LArRawChannelBuilderToolBase::*	m_buildIt )(int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Protected Attributes
LArRawChannelContainer *	m_larRawChannelContainer
int	m_energy
int	m_time
CaloGain::CaloGain	m_gain
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKeySC {this,"SCCablingKey","LArOnOffIdMapSC","SG Key of SC LArOnOffIdMapping object"}
LArRawChannelBuilderParams *	m_parent
LArRawChannelBuilderStatistics *	m_helper
bool	m_isSC

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	LArRawChannelBuilderToolTileInfo (const LArRawChannelBuilderToolTileInfo &)
LArRawChannelBuilderToolTileInfo &	operator= (const LArRawChannelBuilderToolTileInfo &)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
float	m_Ecut
bool	m_skipSaturatedCells
unsigned short	m_AdcMax
bool	m_doQual
unsigned int	m_defaultPhase
unsigned int	m_minSample
unsigned int	m_maxSample
double	m_globaltimeoffsettop
double	m_globaltimeoffsetbottom
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}
std::string	m_comTimeKey
ToolHandle< LArOFPeakRecoTool >	m_peakReco
double	m_delayTile
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Obtain ADC_max for the Tile using Optimal Filtering.

Author

Hong Ma

Definition at line 29 of file LArRawChannelBuilderToolTileInfo.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

LArRawChannelBuilderToolTileInfo() [1/2]

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

Definition at line 34 of file LArRawChannelBuilderToolTileInfo.cxx.

                                                                 : 
  LArRawChannelBuilderToolBase(type,name,parent),
  m_peakReco("LArOFPeakRecoTool"),
  m_delayTile(0)
{
  m_helper = new LArRawChannelBuilderStatistics( 3,      // number of possible errors
                                               0x06);  // bit pattern special for this tool,
                                                       // to be stored in  "uint16_t provenance"
  m_helper->setErrorString(0, "no errors");
  m_helper->setErrorString(1, "channel saturated");
  m_helper->setErrorString(2, "OFC not valid");
 
  declareProperty("ComTimeKey",m_comTimeKey="ComTimeTileMuon");
  declareProperty("GlobalTimeOffsetTop", m_globaltimeoffsettop=-23.7);
  declareProperty("GlobalTimeOffsetBottom", m_globaltimeoffsetbottom=-19.2);
  declareProperty("defaultPhase", m_defaultPhase=12);
  declareProperty("ADCMax", m_AdcMax=4095);
  declareProperty("Skip", m_skipSaturatedCells=true);
  declareProperty("ECut", m_Ecut=50);
  declareProperty("doQual", m_doQual=true);
  declareProperty("minSample", m_minSample=0);
  declareProperty("maxSample", m_maxSample=31);
}

LArRawChannelBuilderToolTileInfo() [2/2]

LArRawChannelBuilderToolTileInfo::LArRawChannelBuilderToolTileInfo ( const LArRawChannelBuilderToolTileInfo &  )

private

Member Function Documentation

BuildLArCell()

void LArRawChannelBuilderToolBase::BuildLArCell ( int  energy, int  time, uint16_t  quality, uint16_t  provenance, const LArDigit *  digit  )

inlineinherited

Definition at line 72 of file LArRawChannelBuilderToolBase.h.

                                                                                                             {
        m_energy = energy;
        m_time   = time;
        m_gain   = digit->gain();
}

BuildLArRawChannel()

void LArRawChannelBuilderToolBase::BuildLArRawChannel ( int  energy, int  time, uint16_t  quality, uint16_t  provenance, const LArDigit *  digit  )

inlineinherited

Definition at line 79 of file LArRawChannelBuilderToolBase.h.

                                                                                                                                  {
        // It is assumed that m_larRawChannelContainer exists
        LArRawChannel larRawChannel(digit->channelID(),
                    energy,time,
                    quality,provenance,digit->gain());
        m_larRawChannelContainer->add(larRawChannel);
}

buildRawChannel()

bool LArRawChannelBuilderToolTileInfo::buildRawChannel ( const LArDigit *  digit, float  pedestal, const std::vector< float > &  ramps, MsgStream *  pLog  )

virtual

Implements LArRawChannelBuilderToolBase.

Definition at line 79 of file LArRawChannelBuilderToolTileInfo.cxx.

{
 
  HWIdentifier chid=m_parent->curr_chid;
  if(bool(pLog))
    (*pLog) << MSG::DEBUG << "Start " <<MSG::hex<< chid<<MSG::dec<< endmsg;
  CaloGain::CaloGain gain=m_parent->curr_gain;
  
  if ( m_parent->curr_maximum > m_AdcMax )
    {
      if(bool(pLog))
    (*pLog) << MSG::DEBUG << "Saturation on channel 0x"
         << MSG::hex << chid.get_compact() << MSG::dec << ". ";
      if ( m_skipSaturatedCells )
    {
      if(bool(pLog))
        (*pLog) << "Skipping channel." << endmsg; 
      m_helper->incrementErrorCount(1);
      return false;
    }
      if(bool(pLog))
    (*pLog) << endmsg;
    }
 
  const std::vector < short >& samples = digit->samples();
  unsigned int sampsize = (unsigned int) samples.size();
  //float peakval = -999.;
  unsigned int ipeak = 0;  
  std::vector<float> signal ; 
  float currval = 0.;
  for (unsigned int ii = 0; ii < sampsize; ii++) {
      currval = (float)(samples[ii] - pedestal);
      signal.push_back(currval);
      //if ((ii >= m_minSample)&&(ii <= m_maxSample)&&(currval > peakval)) { ipeak = ii; peakval = currval; }
  }
  
  ipeak = m_parent->curr_shiftTimeSamples + 2;
  m_parent->curr_Phase =  m_defaultPhase;
  double globaltimeoffset = -25;
 
  //Retrieve TileMuonFitter ComTime object
  const ComTime* comTime;
  StatusCode sc = evtStore()->retrieve(comTime, m_comTimeKey);
 
  if (sc.isFailure()) {
    if(bool(pLog))
      (*pLog) << MSG::ERROR
          << "Unable to retrieve ComTime from StoreGate" << endmsg;
    return static_cast<bool>(sc);
  }
  
  else {//TileComTime exists
    SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey};
    const CaloDetDescrManager* caloDDMgr = *caloMgrHandle;
 
    Identifier id=currentID();
    const CaloDetDescrElement* caloDDE = caloDDMgr->get_element(id);
 
    double tileComTime = comTime->getTime();
    Hep3Vector muonpos = comTime->GetCounterPosition();
    Hep3Vector muondir = comTime->GetcosThetaDirection();
 
    if(tileComTime!=0 || muonpos.x()!=0 || muonpos.z()!=0) {
        
      double timeTOF = 0.; //For time of flight correction from TileComTime Y=0 position to LAr cell position
      double IPTOF = 0.; //For time of flight correction to Interaction Point
      globaltimeoffset = 0.; //Determined from cosmic data (LArTime-TileComTime) 
    
      if (caloDDE != nullptr) {
 
    double xpos=caloDDE->x();
    double ypos=caloDDE->y();
    double zpos=caloDDE->z();
 
        const double inv_c_light = 1. / c_light;
    timeTOF = (sqrt((muonpos.x()-xpos)*(muonpos.x()-xpos) + (muonpos.y()-ypos)*(muonpos.y()-ypos) + (muonpos.z()-zpos)*(muonpos.z()-zpos))) * inv_c_light;
    IPTOF = (sqrt(xpos*xpos+ypos*ypos+zpos*zpos)) * inv_c_light;
    IPTOF = (-1)*IPTOF;
      
    if (ypos>0) {//top
      globaltimeoffset = m_globaltimeoffsettop;
    }
    else {//bottom
      globaltimeoffset = m_globaltimeoffsetbottom;
    }
 
    if ((ypos>0 && muondir.y()<0) || (ypos<0 && muondir.y()>0)) timeTOF=timeTOF*(-1); //Correct TOF for downward going muons at top and upward going muons at bottom
 
      }
 
      double larTimeOffset = tileComTime + timeTOF + IPTOF + globaltimeoffset; //Predicted time at LAr cell from all time offsets and corrections
      //peakSampleTile = int(((larTimeOffset*24./25. - 25.)/24. + 5) + 0.5) ; 
      //m_delayTile = int((24*(peakSampleTile-3) - larTimeOffset*24./25. + 25.) + 0.5) ;
 
      // adapt to current OFC timing, such that delay is between 0 ns and 25 ns
      // assumes that larTimeOffset = 0 corresponds to peak exactly at the third sample (ipeak==2 and delay=0 ns)
      //  (delay = 25 means that the peak is 1 sample before the sample used to center OFC)
      double peakSampleTile = int( (larTimeOffset*(1./25.)) + 2.);
      m_delayTile = 25.*(peakSampleTile-2) - larTimeOffset;
      // the following logic is suited to the regular case where OFC phases are between 0 and 25 ns
      //   for dedicated OFC sets where phase<0 are produced this is not optimal
      if (m_delayTile<0) {
        peakSampleTile += 1;
        m_delayTile += 25.;
      }
 
      m_parent->curr_shiftTimeSamples = peakSampleTile;
      m_parent->curr_Phase = static_cast<int> (m_delayTile);
    }
    ipeak = m_parent->curr_shiftTimeSamples;
  }
 
   
  float delay = m_delayTile;
 
  if (ipeak < 2) ipeak = 2; 
  if (ipeak > sampsize - 3) ipeak = sampsize - 3 ; 
 
  LArOFPeakRecoTool::Result results ; 
 
  unsigned int peak_min = ipeak - 1 ; 
  if (peak_min < 2) peak_min = 2; 
 
  unsigned int peak_max = ipeak + 1 ; 
  if (peak_max > sampsize - 3) peak_max = sampsize - 3 ;  
 
  float ADCPeak=0;
  float time=0.;
  results = m_peakReco->peak(signal, chid, gain, delay, 0, ipeak, peak_min, peak_max);
 
  if (results.getValid()) {
    ADCPeak = results.getAmplitude();
    // FIXME: this time definition still misses the tstart from the OFC to be absolutely computed
    time = (25.*((int)(results.getPeakSample_final())-2-1)-(results.getDelay_final()-results.getTau()-25));
  }
  else {
    if(bool(pLog))
      (*pLog) << MSG::DEBUG << ". OFC not valid for channel 0x"
          << MSG::hex << chid.get_compact() << MSG::dec 
          << " Gain = " << gain << ". Skipping channel." << endmsg;
    m_helper->incrementErrorCount(2);
    return false;
  }
 
  float power=1;
  float energy=0;
  for( unsigned int i=0; i<ramps.size(); i++)
    {
      energy += ramps[i] * power;
      power  *= ADCPeak;
    }
 
  //(*pLog) << MSG::DEBUG << "ADCPeak = " << ADCPeak <<", time = "<< time<<
  //    " energy "<<energy <<endmsg;
 
  uint16_t iquality=0;
  uint16_t iprovenance=0;
  if ((m_doQual) && (energy>m_Ecut) && (results.getValid())) {
    iquality = ((int)(results.getQuality())) & 0xFFFF;
    iprovenance = iprovenance | 0x2000;
  }
 
  iprovenance |= m_parent->qualityBitPattern;
  iprovenance |= m_helper->returnBitPattern();
  iprovenance = iprovenance & 0x3FFF;
  
  time=time*(nanosecond/picosecond); //Convert time to ps
 
  const float fMAXINT = static_cast<float>(MAXINT);
  const float fMAXINT2 = static_cast<float>(MAXINT2);
 
  if (time>fMAXINT) time=fMAXINT;
  if (time<fMAXINT2) time=fMAXINT2;
 
  if (energy>fMAXINT) energy=fMAXINT;
  if (energy<fMAXINT2) energy=fMAXINT2;
  
  //Make LArRawChannel Object with new data
  LArRawChannel larRawChannel(digit->channelID(),
                  (int)floor(energy+0.5),
                  int(time),
                  iquality,iprovenance,digit->gain());   
  m_larRawChannelContainer->add(larRawChannel);
  
  m_helper->incrementErrorCount(0);
  
  return true;
}

currentID()

Identifier LArRawChannelBuilderToolBaseClass::currentID ( )

inherited

Definition at line 94 of file LArRawChannelBuilderToolBaseClass.cxx.

{
  const LArOnOffIdMapping *cabling=nullptr;
  if(m_isSC) {
    SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKeySC};
    cabling = *cablingHdl;
  } else {
    SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey};
    cabling = *cablingHdl;
  }   
  if(!cabling) {
     m_parent->curr_id=0;
  } else {
    if(m_parent->curr_id==0) {
      try {
        m_parent->curr_id = cabling->cnvToIdentifier(m_parent->curr_chid);
      } catch ( LArID_Exception & except ) {
        ATH_MSG_INFO("Cabling exception was caught for channel 0x!"
        << MSG::hex << m_parent->curr_chid.get_compact() << MSG::dec );
        m_parent->curr_id=0;
      }
    }
  }
  return m_parent->curr_id;
}

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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.

{ return m_detStore; }

energy()

int LArRawChannelBuilderToolBase::energy ( )

inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 46 of file LArRawChannelBuilderToolBase.h.

{ return m_energy; }

evtStore() [1/2]

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.

{ return m_evtStore; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

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

finalEvent()

virtual void LArRawChannelBuilderToolBaseClass::finalEvent ( )

inlinevirtualinherited

Definition at line 63 of file LArRawChannelBuilderToolBaseClass.h.

{ };

finalEventHidden()

void LArRawChannelBuilderToolBaseClass::finalEventHidden ( )

virtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 87 of file LArRawChannelBuilderToolBaseClass.cxx.

{
  m_helper->resetErrorcountPerEvent();
  finalEvent();
}

gain()

CaloGain::CaloGain LArRawChannelBuilderToolBase::gain ( )

inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 48 of file LArRawChannelBuilderToolBase.h.

{ return m_gain; }

initEvent()

virtual void LArRawChannelBuilderToolBaseClass::initEvent ( )

inlinevirtualinherited

Reimplemented in LArRawChannelBuilderToolOFCIter.

Definition at line 59 of file LArRawChannelBuilderToolBaseClass.h.

{ };

initEventHidden()

void LArRawChannelBuilderToolBase::initEventHidden ( )

inlinevirtualinherited

Implements LArRawChannelBuilderToolBaseClass.

Definition at line 39 of file LArRawChannelBuilderToolBase.h.

    { m_larRawChannelContainer=m_parent->m_larRawChannelContainer;
      if ( m_larRawChannelContainer !=NULL )
        m_buildIt = &LArRawChannelBuilderToolBase::BuildLArRawChannel;
      else
        m_buildIt = &LArRawChannelBuilderToolBase::BuildLArCell;
      initEvent(); }

initTool()

StatusCode LArRawChannelBuilderToolTileInfo::initTool ( )

virtual

Reimplemented from LArRawChannelBuilderToolBase.

Definition at line 60 of file LArRawChannelBuilderToolTileInfo.cxx.

{
  MsgStream log(msgSvc(), name());
  
  StatusCode sc=m_peakReco.retrieve();
  if( sc.isFailure() ) {
    log << MSG::ERROR << "Unable to retrieve LArOFPeakRecoTool" <<endmsg;
    return StatusCode::FAILURE;
  }
  
  log << MSG::INFO << " DefaultPhase  "<<m_defaultPhase <<endmsg;
  
 
  ATH_CHECK(m_caloMgrKey.initialize());
 
  return StatusCode::SUCCESS;
}

initToolHidden()

StatusCode LArRawChannelBuilderToolBaseClass::initToolHidden ( LArRawChannelBuilderParams *  myParent )

inlinevirtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 43 of file LArRawChannelBuilderToolBaseClass.h.

    {
      m_parent=myParent; 
      if ( m_isSC ) {
         ATH_CHECK( m_cablingKeySC.initialize() );
      } else {
         ATH_CHECK( m_cablingKey.initialize() );
      }
      return initTool();
    };

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()

static const InterfaceID& ILArRawChannelBuilderToolBase::interfaceID ( )

inlinestaticinherited

Definition at line 30 of file ILArRawChannelBuilderToolBase.h.

{ return IID_ILArRawChannelBuilderToolBase; }

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

operator=()

LArRawChannelBuilderToolTileInfo& LArRawChannelBuilderToolTileInfo::operator= ( const LArRawChannelBuilderToolTileInfo &  )

private

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.

printSummary()

void LArRawChannelBuilderToolBaseClass::printSummary ( )

virtualinherited

Implements ILArRawChannelBuilderToolBaseClass.

Definition at line 33 of file LArRawChannelBuilderToolBaseClass.cxx.

{
  MsgStream log(msgSvc(), name());
  ulonglong sum=0;
  for( unsigned int i=0; i<m_helper->returnMaxErrors(); i++ )
    sum+=m_helper->returnErrorCount(i);
  
  log << MSG::INFO << "Printing Summary for tool " << name() << " :" << endmsg;
  log << MSG::INFO
      << std::setw(40) << " " << " : "
      << std::setw(12) << " total "
      << std::setw(10) << " percent " << "  "
      << std::setw(12) << " per event "
      << std::setw(12) << " RMS "
      << endmsg;
 
  double inv_sum = sum > 0 ? 1./sum : 1;
  for( unsigned int i=0; i<m_helper->returnMaxErrors(); i++ )
    {
      double fraction = 0.0;
      double perEvent = 0.0;
      double rmsPerEv = 0.0;
      if(sum>0)
        fraction=100 * double(m_helper->returnErrorCount(i)) * inv_sum;
      if(m_helper->returnEvents()>0)
        {
          perEvent = double(m_helper->returnErrorCountPerEvent(i)) / double(m_helper->returnEvents());
          rmsPerEv = double(m_helper->returnErrorCountSqPerEvent(i)) / double(m_helper->returnEvents());
          rmsPerEv = sqrt(std::max(0.,rmsPerEv-perEvent*perEvent));
        }
      
      log << MSG::INFO
      << std::setw(40)
      << m_helper->returnErrorString(i) << " : "
      << std::setw(12)
      << m_helper->returnErrorCount(i)
      << std::setw(10)
      << std::fixed
      << std::setprecision(4)
      << fraction
      << " %"
      << std::setw(12)
      << std::fixed
      << std::setprecision(4)
      << perEvent
      << std::setw(12)
      << std::fixed
      << std::setprecision(4)
      << rmsPerEv
      << endmsg;
    }
}

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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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.

time()

int LArRawChannelBuilderToolBase::time ( )

inlinevirtualinherited

Implements ILArRawChannelBuilderToolBase.

Definition at line 47 of file LArRawChannelBuilderToolBase.h.

{ return m_time; }

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_AdcMax

unsigned short LArRawChannelBuilderToolTileInfo::m_AdcMax

private

Definition at line 48 of file LArRawChannelBuilderToolTileInfo.h.

m_buildIt

void(LArRawChannelBuilderToolBase::* LArRawChannelBuilderToolBase::m_buildIt) (int energy, int time, uint16_t quality, uint16_t provenance, const LArDigit *digit)

inherited

Definition at line 57 of file LArRawChannelBuilderToolBase.h.

m_cablingKey

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

protectedinherited

Definition at line 77 of file LArRawChannelBuilderToolBaseClass.h.

m_cablingKeySC

SG::ReadCondHandleKey<LArOnOffIdMapping> LArRawChannelBuilderToolBaseClass::m_cablingKeySC {this,"SCCablingKey","LArOnOffIdMapSC","SG Key of SC LArOnOffIdMapping object"}

protectedinherited

Definition at line 78 of file LArRawChannelBuilderToolBaseClass.h.

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> LArRawChannelBuilderToolTileInfo::m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}

private

Definition at line 56 of file LArRawChannelBuilderToolTileInfo.h.

m_comTimeKey

std::string LArRawChannelBuilderToolTileInfo::m_comTimeKey

private

Definition at line 59 of file LArRawChannelBuilderToolTileInfo.h.

m_defaultPhase

unsigned int LArRawChannelBuilderToolTileInfo::m_defaultPhase

private

Definition at line 50 of file LArRawChannelBuilderToolTileInfo.h.

m_delayTile

double LArRawChannelBuilderToolTileInfo::m_delayTile

private

Definition at line 64 of file LArRawChannelBuilderToolTileInfo.h.

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_doQual

bool LArRawChannelBuilderToolTileInfo::m_doQual

private

Definition at line 49 of file LArRawChannelBuilderToolTileInfo.h.

m_Ecut

float LArRawChannelBuilderToolTileInfo::m_Ecut

private

Definition at line 46 of file LArRawChannelBuilderToolTileInfo.h.

m_energy

int LArRawChannelBuilderToolBase::m_energy

protectedinherited

Definition at line 65 of file LArRawChannelBuilderToolBase.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_gain

CaloGain::CaloGain LArRawChannelBuilderToolBase::m_gain

protectedinherited

Definition at line 67 of file LArRawChannelBuilderToolBase.h.

m_globaltimeoffsetbottom

double LArRawChannelBuilderToolTileInfo::m_globaltimeoffsetbottom

private

Definition at line 54 of file LArRawChannelBuilderToolTileInfo.h.

m_globaltimeoffsettop

double LArRawChannelBuilderToolTileInfo::m_globaltimeoffsettop

private

Definition at line 54 of file LArRawChannelBuilderToolTileInfo.h.

m_helper

LArRawChannelBuilderStatistics* LArRawChannelBuilderToolBaseClass::m_helper

protectedinherited

Definition at line 82 of file LArRawChannelBuilderToolBaseClass.h.

m_isSC

bool LArRawChannelBuilderToolBaseClass::m_isSC

protectedinherited

Definition at line 84 of file LArRawChannelBuilderToolBaseClass.h.

m_larRawChannelContainer

LArRawChannelContainer* LArRawChannelBuilderToolBase::m_larRawChannelContainer

protectedinherited

Definition at line 64 of file LArRawChannelBuilderToolBase.h.

m_maxSample

unsigned int LArRawChannelBuilderToolTileInfo::m_maxSample

private

Definition at line 52 of file LArRawChannelBuilderToolTileInfo.h.

m_minSample

unsigned int LArRawChannelBuilderToolTileInfo::m_minSample

private

Definition at line 51 of file LArRawChannelBuilderToolTileInfo.h.

m_parent

LArRawChannelBuilderParams* LArRawChannelBuilderToolBaseClass::m_parent

protectedinherited

Definition at line 80 of file LArRawChannelBuilderToolBaseClass.h.

m_peakReco

ToolHandle<LArOFPeakRecoTool> LArRawChannelBuilderToolTileInfo::m_peakReco

private

Definition at line 62 of file LArRawChannelBuilderToolTileInfo.h.

m_skipSaturatedCells

bool LArRawChannelBuilderToolTileInfo::m_skipSaturatedCells

private

Definition at line 47 of file LArRawChannelBuilderToolTileInfo.h.

m_time

int LArRawChannelBuilderToolBase::m_time

protectedinherited

Definition at line 66 of file LArRawChannelBuilderToolBase.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:

• LArRawChannelBuilderToolTileInfo.h
• LArRawChannelBuilderToolTileInfo.cxx