This class compares two sets of TileRawChannels. More...

#include <TileRawChannelVerify.h>

Inheritance diagram for TileRawChannelVerify:

Collaboration diagram for TileRawChannelVerify:

Public Member Functions
	TileRawChannelVerify (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual	~TileRawChannelVerify ()
	Destructor.
StatusCode	initialize ()
	initialize method
StatusCode	execute ()
	execute method
StatusCode	finalize ()
	finalize method
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
const TileHWID *	m_tileHWID
	Pointer to TileHWID.
SG::ReadHandleKey< TileRawChannelContainer >	m_rawChannelContainer1Key
SG::ReadHandleKey< TileRawChannelContainer >	m_rawChannelContainer2Key
double	m_precision
	maximum difference between the amplitudes of the TileRawChannels to be compared
bool	m_dumpRawChannels
	if true=> Differences found in the TileRawChannels are dumped on the screen
bool	m_sortFlag
	if true=> TileRawChannels are sorted by amplitude
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

This class compares two sets of TileRawChannels.

It is meant to check if both sets of TileRawChannels contain the same information, since the output is just one line confirming that. Optionally the differences are simply dumped to the screen. They TileRawChannels may have been obtained from different input data or from the same data reconstructed by different methods.

Definition at line 50 of file TileRawChannelVerify.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

◆ TileRawChannelVerify()

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

Constructor.

Definition at line 60 of file TileRawChannelVerify.cxx.

  : AthAlgorithm(name, pSvcLocator)
  , m_tileHWID(0)
{
  declareProperty("Precision", m_precision = 0);
  declareProperty("DumpRawChannels", m_dumpRawChannels = false);
  declareProperty("SortFlag", m_sortFlag = false);
}

◆ ~TileRawChannelVerify()

TileRawChannelVerify::~TileRawChannelVerify ( )

virtual

Destructor.

Definition at line 69 of file TileRawChannelVerify.cxx.

69 {

70}

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

execute method

Definition at line 86 of file TileRawChannelVerify.cxx.

                                         {
 
  // step1: read two cell containers from TES
  SG::ReadHandle<TileRawChannelContainer> rawChannelContainer1(m_rawChannelContainer1Key);
  SG::ReadHandle<TileRawChannelContainer> rawChannelContainer2(m_rawChannelContainer2Key);
 
  SelectAllObject<TileRawChannelContainer> selAll1(rawChannelContainer1.cptr());
  SelectAllObject<TileRawChannelContainer>::const_iterator rawItr1 = selAll1.begin();
  SelectAllObject<TileRawChannelContainer>::const_iterator end1 = selAll1.end();
 
  SelectAllObject<TileRawChannelContainer> selAll2(rawChannelContainer2.cptr());
  SelectAllObject<TileRawChannelContainer>::const_iterator rawItr2 = selAll2.begin();
  SelectAllObject<TileRawChannelContainer>::const_iterator end2 = selAll2.end();
 
  // step2: first compare the number of cells in the two containers 
  int nSize1 = 0;
  for (; rawItr1 != end1; ++rawItr1) ++nSize1;
 
  int nSize2 = 0;
  for (; rawItr2 != end2; ++rawItr2) ++nSize2;
 
  ATH_MSG_INFO( "The number of cells in " << m_rawChannelContainer1Key.key() << " is " << nSize1 );
  ATH_MSG_INFO( "The number of cells in " << m_rawChannelContainer2Key.key() << " is " << nSize2 );
 
  if (nSize1 != nSize2) {
    ATH_MSG_ERROR( "The number of rawChannels is not equal in the two containers" );
    return (StatusCode::SUCCESS);
  }
 
  // step3: to sort the cells in the containers by amplitude
  vector<const TileRawChannel*> rawChannels1;
  vector<const TileRawChannel*> rawChannels2;
  const TileRawChannel* rawChannel1;
  const TileRawChannel* rawChannel2;
  if (m_sortFlag) {
    rawItr1 = selAll1.begin();
    end1 = selAll1.end();
    for (; rawItr1 != end1; ++rawItr1)
      rawChannels1.push_back((*rawItr1));
 
    sort(rawChannels1.begin(), rawChannels1.end(), CompRawChannel());
 
    rawItr2 = selAll2.begin();
    end2 = selAll2.end();
    for (; rawItr2 != end2; ++rawItr2)
      rawChannels2.push_back((*rawItr2));
 
    sort(rawChannels2.begin(), rawChannels2.end(), CompRawChannel());
  }
 
  rawItr1 = selAll1.begin();
  end1 = selAll1.end();
 
  rawItr2 = selAll2.begin();
  end2 = selAll2.end();
 
  // step4: then compare every cell-pair in the containers
  bool bErrorFlag = false;
  bool bHeaderFlag = true;
  for (int i = 0; i < nSize1; ++i) {
    if (m_sortFlag) {
      rawChannel1 = rawChannels1[i];
      rawChannel2 = rawChannels2[i];
    } else {
      rawChannel1 = (*rawItr1);
      ++rawItr1;
      rawChannel2 = (*rawItr2);
      ++rawItr2;
    }
    HWIdentifier id1 = rawChannel1->adc_HWID();
    HWIdentifier id2 = rawChannel2->adc_HWID();
    double amp1 = rawChannel1->amplitude();
    double amp2 = rawChannel2->amplitude();
    double diff = fabs(amp1 - amp2);
    if (id1 != id2 || diff > m_precision) bErrorFlag = true;
    if (msgLvl(MSG::VERBOSE) && (m_dumpRawChannels || bErrorFlag)) {
      if (bHeaderFlag) {
        msg(MSG::VERBOSE) << "             ===" << m_rawChannelContainer1Key.key() 
                          << "===      ===" << m_rawChannelContainer2Key.key() << "===" << endmsg;
        msg(MSG::VERBOSE) << "  Index      e1            id1        |        e2           id2" << endmsg;
        msg(MSG::VERBOSE) << "--------------------------------------------------------------------------------" << endmsg;
        bHeaderFlag = false;
      }
      msg(MSG::VERBOSE) << setw(5) << i
                        << "   " << setw(12)  << amp1
                        << "   [" << m_tileHWID->to_string(id1) << "]"
                        << "  |  " << setw(12) << amp2
                        << "   [" << m_tileHWID->to_string(id2) << "]";
      if (diff > m_precision) {
        msg(MSG::VERBOSE) << " A* ";
      }
      if (id1 != id2) {
        msg(MSG::VERBOSE) << " I* ";
      }
      msg(MSG::VERBOSE) << endmsg;
    } else if (bErrorFlag) {
      break;
    }
  }
  if (!bHeaderFlag) {
    msg(MSG::VERBOSE) << "--------------------------------------------------------------------------------" << endmsg;
  }
  if (!bErrorFlag) {
    ATH_MSG_INFO( "The two cellContainers (" << m_rawChannelContainer1Key.key()
                  << " and " << m_rawChannelContainer2Key.key() << ") are the same!!!" );
  } else {
    ATH_MSG_INFO( "The two cellContainers (" << m_rawChannelContainer1Key.key()
                  << " and " << m_rawChannelContainer2Key.key() << ") are not the same!!!" );
  }
 
  // Execution completed.
  ATH_MSG_INFO( "TileRawChannelVerify execution completed successfully" );
 
  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 TileRawChannelVerify::finalize ( )

finalize method

Definition at line 202 of file TileRawChannelVerify.cxx.

                                          {
 
  ATH_MSG_INFO( "TileRawChannelVerify finalized successfully" );
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TileRawChannelVerify::initialize ( )

initialize method

Definition at line 73 of file TileRawChannelVerify.cxx.

                                            {
 
  // retrieve TileHWID helper from det store
  CHECK( detStore()->retrieve(m_tileHWID) );
 
  ATH_CHECK( m_rawChannelContainer1Key.initialize() );
  ATH_CHECK( m_rawChannelContainer2Key.initialize() );
 
  ATH_MSG_INFO( "TileRawChannelVerify 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_dumpRawChannels

bool TileRawChannelVerify::m_dumpRawChannels

private

if true=> Differences found in the TileRawChannels are dumped on the screen

Definition at line 75 of file TileRawChannelVerify.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_precision

double TileRawChannelVerify::m_precision

private

maximum difference between the amplitudes of the TileRawChannels to be compared

Definition at line 73 of file TileRawChannelVerify.h.

◆ m_rawChannelContainer1Key

SG::ReadHandleKey<TileRawChannelContainer> TileRawChannelVerify::m_rawChannelContainer1Key

private

Initial value:

{this, "TileRawChannelContainer1",

"", "Input Tile raw channel container 1 key"}

Definition at line 65 of file TileRawChannelVerify.h.

65 {this, "TileRawChannelContainer1",

66 "", "Input Tile raw channel container 1 key"};

◆ m_rawChannelContainer2Key

SG::ReadHandleKey<TileRawChannelContainer> TileRawChannelVerify::m_rawChannelContainer2Key

private

Initial value:

{this, "TileRawChannelContainer2",

"", "Input Tile raw channel container 2 key"}

Definition at line 69 of file TileRawChannelVerify.h.

69 {this, "TileRawChannelContainer2",

70 "", "Input Tile raw channel container 2 key"};

◆ m_sortFlag

bool TileRawChannelVerify::m_sortFlag

private

if true=> TileRawChannels are sorted by amplitude

Definition at line 76 of file TileRawChannelVerify.h.

◆ m_tileHWID

const TileHWID* TileRawChannelVerify::m_tileHWID

private

Pointer to TileHWID.

Definition at line 63 of file TileRawChannelVerify.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

◆ TileRawChannelVerify()

◆ ~TileRawChannelVerify()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_dumpRawChannels

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_precision

◆ m_rawChannelContainer1Key

◆ m_rawChannelContainer2Key

◆ m_sortFlag

◆ m_tileHWID

◆ m_varHandleArraysDeclared

◆ m_vhka