TileRawChannelToHit Class Reference

#include <TileRawChannelToHit.h>

Inheritance diagram for TileRawChannelToHit:

Collaboration diagram for TileRawChannelToHit:

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

Private Attributes
SG::ReadHandleKey< TileRawChannelContainer >	m_rawChannelContainerKey
SG::WriteHandleKey< TileHitVector >	m_hitVectorKey
SG::ReadCondHandleKey< TileSamplingFraction >	m_samplingFractionKey
	Name of TileSamplingFraction in condition store.
std::string	m_infoName
bool	m_useSamplFract
const TileID *	m_tileID {nullptr}
const TileHWID *	m_tileHWID {nullptr}
ToolHandle< TileCondToolEmscale >	m_tileToolEmscale
	main Tile Calibration tool
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 56 of file TileRawChannelToHit.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

TileRawChannelToHit()

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

Definition at line 46 of file TileRawChannelToHit.cxx.

  : AthAlgorithm(name, pSvcLocator)
  , m_tileToolEmscale("TileCondToolEmscale")
{
  declareProperty("UseSamplFract", m_useSamplFract = false);  // if true energy in TileHit is the as it is coming from G4 simulation
                                                              // and by default it is equal to final - TileCell energy
  declareProperty("TileCondToolEmscale"    , m_tileToolEmscale);
}

~TileRawChannelToHit()

TileRawChannelToHit::~TileRawChannelToHit ( )

virtual

Definition at line 55 of file TileRawChannelToHit.cxx.

{}

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 TileRawChannelToHit::execute

(

)

Definition at line 91 of file TileRawChannelToHit.cxx.

                                        {
 
  /* zero all counters and sums */
  int nHit = 0;
  int nChan = 0;
  float eCh = 0.0;
  float eHitTot = 0.0;
 
  const TileSamplingFraction* samplingFraction = nullptr;
  if (m_useSamplFract) {
    SG::ReadCondHandle<TileSamplingFraction> samplingFractionHandle(m_samplingFractionKey);
    ATH_CHECK( samplingFractionHandle.isValid() );
    samplingFraction = samplingFractionHandle.cptr();
  }
 
  SG::WriteHandle<TileHitVector> hitVector(m_hitVectorKey);
 
  /* Register the set of TileHits to the event store. */
  ATH_CHECK( hitVector.record(std::make_unique<TileHitVector>()) );
 
  //**
  //* Get TileRawChannels
  //**
  SG::ReadHandle<TileRawChannelContainer> rawChannelContainer(m_rawChannelContainerKey);
 
  if (!rawChannelContainer.isValid()) {
    ATH_MSG_WARNING( " Could not find container " << m_rawChannelContainerKey.key() );
    ATH_MSG_WARNING( " creating empty TileHitVector container " );
 
  } else {
 
    TileRawChannelUnit::UNIT rChUnit = rawChannelContainer->get_unit();
    //TileFragHash::TYPE rChType = rawChannelContainer->get_type();
 
    // iterate over all collections in a container
    for(const TileRawChannelCollection* rawChannelCollection : *rawChannelContainer) {
 
      HWIdentifier drawer_id = m_tileHWID->drawer_id(rawChannelCollection->identify());
      int ros = m_tileHWID->ros(drawer_id);
      int drawer = m_tileHWID->drawer(drawer_id);
      int drawerIdx = TileCalibUtils::getDrawerIdx(ros, drawer);
 
      bool is_calibration = (rawChannelCollection->size() == 96);
      if (is_calibration)
        ATH_MSG_DEBUG( "Calibration mode, ignore high gain" );
 
      // iterate over all raw channels in a collection, creating new TileHits
      // Add each new TileHit to the TileHitContainer.
 
      for (const TileRawChannel* rawChannel : *rawChannelCollection) {
 
        HWIdentifier adc_id = rawChannel->adc_HWID();
        int channel = m_tileHWID->channel(adc_id);
        int adc = m_tileHWID->adc(adc_id);
 
        // skip high gain in calibration mode
        if (is_calibration && TileHWID::HIGHGAIN == adc)
          continue;
 
        float amp = rawChannel->amplitude();
        float time = rawChannel->time();
 
        ++nChan;
        eCh += amp;
 
        Identifier pmt_id = rawChannel->pmt_ID();
        if (pmt_id.is_valid()) {
 
          float ener = m_tileToolEmscale->channelCalib(drawerIdx, channel, adc,
                                                       amp, rChUnit, 
                                                       TileRawChannelUnit::MegaElectronVolts);
 
          if (m_useSamplFract) { // divide by sampling fraction (about 40)
            ener /= samplingFraction->getSamplingFraction(drawerIdx, channel);
          }
 
          TileHit hit(pmt_id, ener, time);
          eHitTot += ener;
          ++nHit;
 
          ATH_MSG_VERBOSE( "TileRawChannelToHit: "
                          << " pmt_id=" << m_tileID->to_string(pmt_id, -1)
                          << " adc_id=" << m_tileHWID->to_string(adc_id)
                          << " nHit=" << nHit
                          << " amp="  << amp
                          << " ene=" << ener
                          << " time=" << time );
 
          hitVector->push_back(hit);
 
        } else {
 
          ATH_MSG_VERBOSE( "TileRawChannelToHit: "
                           << " channel with adc_id=" << m_tileHWID->to_string(adc_id)
                           << " is not connected" );
        }
      }
    }
  }
  
 
 
 
  // Execution completed.
  ATH_MSG_DEBUG( "TileRawChannelToHit execution completed." );
  ATH_MSG_DEBUG( " nChan=" << nChan
                << " RawChSum=" << eCh
                << " nHit=" << nHit
                << " eneTot=" << eHitTot );
 
 
  ATH_MSG_VERBOSE( "TileHitVector container registered to the TES with name"
                   << m_hitVectorKey.key() );
 
  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 TileRawChannelToHit::finalize

(

)

Definition at line 215 of file TileRawChannelToHit.cxx.

                                         {
 
  ATH_MSG_INFO( "TileRawChannelToHit::finalize() end" );
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode TileRawChannelToHit::initialize

(

)

Definition at line 62 of file TileRawChannelToHit.cxx.

                                           {
 
  if (m_useSamplFract)
    ATH_MSG_INFO( "Sampling fraction is taken into account for TileHit energy" );
  else
    ATH_MSG_INFO( "TileHit will contain CELL energy (not divided by sampling fraction)" );
 
  // retrieve TileID helper and TileIfno from det store
  ATH_CHECK( detStore()->retrieve(m_tileID) );
  ATH_CHECK( detStore()->retrieve(m_tileHWID) );
 
  //=== get TileCondToolEmscale
  ATH_CHECK( m_tileToolEmscale.retrieve() );
 
  ATH_CHECK( m_rawChannelContainerKey.initialize() );
  ATH_CHECK( m_hitVectorKey.initialize() );
 
  ATH_CHECK( m_samplingFractionKey.initialize(m_useSamplFract) );
 
  ATH_MSG_INFO( "TileRawChannelToHit initialization completed" );
 
  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_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_hitVectorKey

SG::WriteHandleKey<TileHitVector> TileRawChannelToHit::m_hitVectorKey

private

Initial value:

{this,"TileHitContainer",
                                                      "TileHitVec","Output Tile hit container key"}

Definition at line 75 of file TileRawChannelToHit.h.

                                                  {this,"TileHitContainer",
                                                      "TileHitVec","Output Tile hit container key"};

m_infoName

std::string TileRawChannelToHit::m_infoName

private

Definition at line 85 of file TileRawChannelToHit.h.

m_rawChannelContainerKey

SG::ReadHandleKey<TileRawChannelContainer> TileRawChannelToHit::m_rawChannelContainerKey

private

Initial value:

{this,"TileRawChannelContainer",
                                                                        "TileRawChannelCnt", 
                                                                        "Input Tile raw channel container key"}

Definition at line 71 of file TileRawChannelToHit.h.

                                                                     {this,"TileRawChannelContainer",
                                                                        "TileRawChannelCnt", 
                                                                        "Input Tile raw channel container key"};

m_samplingFractionKey

SG::ReadCondHandleKey<TileSamplingFraction> TileRawChannelToHit::m_samplingFractionKey

private

Initial value:

{this,
        "TileSamplingFraction", "TileSamplingFraction", "Input Tile sampling fraction"}

Name of TileSamplingFraction in condition store.

Definition at line 82 of file TileRawChannelToHit.h.

                                                                   {this,
        "TileSamplingFraction", "TileSamplingFraction", "Input Tile sampling fraction"};

m_tileHWID

const TileHWID* TileRawChannelToHit::m_tileHWID {nullptr}

private

Definition at line 89 of file TileRawChannelToHit.h.

{nullptr};

m_tileID

const TileID* TileRawChannelToHit::m_tileID {nullptr}

private

Definition at line 88 of file TileRawChannelToHit.h.

{nullptr};

m_tileToolEmscale

ToolHandle<TileCondToolEmscale> TileRawChannelToHit::m_tileToolEmscale

private

main Tile Calibration tool

Definition at line 91 of file TileRawChannelToHit.h.

m_useSamplFract

bool TileRawChannelToHit::m_useSamplFract

private

Definition at line 86 of file TileRawChannelToHit.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:

• TileRawChannelToHit.h
• TileRawChannelToHit.cxx