#include <TBCellNoiseCorrection.h>

Inheritance diagram for TBCellNoiseCorrection:

Collaboration diagram for TBCellNoiseCorrection:

Public Member Functions
	TBCellNoiseCorrection (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~TBCellNoiseCorrection ()
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
void	MakeCorrection (CaloCell *theCell, const EventContext &ctx) const override
virtual void	handle (const Incident &) override
virtual StatusCode	execute (CaloCellContainer *cellCollection, const EventContext &ctx) const
	AthAlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
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	sysInitialize () override
	Perform system initialization for an algorithm.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()

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.

Static Protected Member Functions
static void	setenergy (CaloCell *lar_cell, float energy)
static void	addenergy (CaloCell *lar_cell, float energy)
static void	scaleenergy (CaloCell *lar_cell, float scale)

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
bool	m_noise_correction
std::vector< std::string >	m_noise_file
ServiceHandle< IAthRNGSvc >	m_rndmSvc { this, "RndmSvc", "AthRNGSvc", "" }
ATHRNG::RNGWrapper *	m_engine
TChain *	m_tree
float	m_xcryo
float	m_ytable
float	m_energy
std::vector< unsigned int > *	m_cell_id
std::vector< float > *	m_cell_energy
unsigned int	m_entries
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 26 of file TBCellNoiseCorrection.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

◆ TBCellNoiseCorrection()

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

Definition at line 22 of file TBCellNoiseCorrection.cxx.

  : CaloCellCorrection(type, name, parent),
    m_noise_correction(false),m_noise_file(),
    m_engine(0),
    m_tree(0), m_xcryo(0.), m_ytable(0.), m_energy(-1.), m_cell_id(0), m_cell_energy(0),m_entries(0)
    //m_myevtnum(-1)
{ 
  declareInterface<CaloCellCorrection>(this);
  declareProperty("NoiseFile", m_noise_file);
  declareProperty("NoiseAdd", m_noise_correction);
  declareProperty("NoiseX",   m_xcryo);
  declareProperty("NoiseY",   m_ytable);
  declareProperty("NoiseE",   m_energy);
}

◆ ~TBCellNoiseCorrection()

TBCellNoiseCorrection::~TBCellNoiseCorrection ( )

virtual

Definition at line 41 of file TBCellNoiseCorrection.cxx.

42{ }

Member Function Documentation

◆ addenergy()

void CaloCellCorrection::addenergy	(	CaloCell *	lar_cell,
		float	energy )

staticprotectedinherited

Definition at line 86 of file CaloCellCorrection.cxx.

{
  theCell->addEnergy( energy );
}

◆ AthAlgTool()

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

inherited

Constructor with parameters:

Definition at line 31 of file AthAlgTool.cxx.

                                       : 
  AthCommonDataStore<AthCommonMsg<AlgTool>> ( type, name, parent )
{
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode CaloCellCorrection::execute	(	CaloCellContainer *	cellCollection,
		const EventContext &	ctx ) const

virtualinherited

Definition at line 50 of file CaloCellCorrection.cxx.

{
 
  ATH_MSG_DEBUG("Executing CaloCellCorrection");
 
  if (!cellCollection) {
    ATH_MSG_ERROR( "Cell Correction tool receives invalid cell Collection"  );
    return StatusCode::FAILURE;
  }
 
  // Loop over all the CaloCell Objects and call Make Correction.
  // Note that this is the base class of all the concrete correction
  // classes which implement a Make Correction method.
 
  for (CaloCell* cell : *cellCollection) {
    MakeCorrection ( cell, ctx );
  }
 
  // Done, Return success
 
  return StatusCode::SUCCESS;
 
}

◆ 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

◆ finalize()

StatusCode TBCellNoiseCorrection::finalize ( )

overridevirtual

Definition at line 124 of file TBCellNoiseCorrection.cxx.

{
//  m_root->Close();
//  m_root = NULL;
  if(m_tree) m_tree->Delete() ;
//  m_cell_id = NULL;
//  m_cell_energy = NULL;
 
  return StatusCode::SUCCESS; 
} 

◆ handle()

void TBCellNoiseCorrection::handle ( const Incident & inc )

overridevirtual

Definition at line 164 of file TBCellNoiseCorrection.cxx.

                                                      {
  ATH_MSG_DEBUG( " Handle BeginEvent "  );
 
  if ( inc.type() == "BeginEvent") {
     m_engine->setSeed ("TBCellNoseCorrection", inc.context());
     unsigned int random = int(RandFlat::shoot(m_engine->getEngine (inc.context()), 0., m_entries-1.));
     ATH_MSG_DEBUG( "Reading noise event: "<<random );
     m_tree->GetEntry(random);
     unsigned int size = m_cell_id->size();
     unsigned int sizee = m_cell_energy->size();
     if(size != sizee) {
       ATH_MSG_ERROR( "Not equal size of noise vectors !!!! Something wrong !!!"  );
     }
  }
}

◆ initialize()

StatusCode TBCellNoiseCorrection::initialize ( )

overridevirtual

Incident Service

Definition at line 45 of file TBCellNoiseCorrection.cxx.

{
  ATH_MSG_DEBUG( " TBCellNoiseCorrection initialization " );
 
  // RandomNumbers
  ATH_CHECK( m_rndmSvc.retrieve() );
  m_engine = m_rndmSvc->getEngine(this, "TB_NOISE");
 
  if(m_energy > 0.) { // Do we have run parameters (x,y,energy) ?
     ATH_MSG_DEBUG( " Trying to patch the noise file name " );
     std::string fname = PathResolver::find_file ("xcryo_ytable.txt", "DATAPATH");
     std::ifstream xfile;
     xfile.open(fname.c_str());
     if(!xfile.good()){
        ATH_MSG_FATAL( "Could not open file  xcryo_ytable.txt"  );
    return StatusCode::FAILURE;
     }
     int runnumber;
     float x,y,en=-1;
     std::string line;
     while (getline(xfile, line, '\n')) {
    std::istringstream buf(line);
        buf >> runnumber >> x >> y >> en;
        if(en < 0. || !(x == m_xcryo && y == m_ytable && en == m_energy)) continue;
        break;
     }
     if(en < 0.) {
        ATH_MSG_FATAL( " Do not have X: "<<m_xcryo<<" Y: "<<m_ytable<< " E: "<<m_energy<<" in   xcryo_ytable.txt"  );
    return StatusCode::FAILURE;
     }
     // we have run number - let's change the file name (and take only one):
     ATH_MSG_DEBUG( "Found run number: "<<runnumber  );
     unsigned pos = m_noise_file[0].find_last_of("0123456789");
     std::ostringstream buf;
     buf<<runnumber;
     m_noise_file[0].replace(pos-3,4,buf.str());
     ATH_MSG_DEBUG( "patched name: "<<m_noise_file[0].c_str() );
  }
 
  // Open file and get Tree
  /*
  m_root = new TFile(m_noise_file.c_str(),"READ"); 
  if(!m_root->IsOpen()){
     ATH_MSG_FATAL( "Could not open root file: "<<m_noise_file );
     return StatusCode::FAILURE; 
  }
  m_tree = (TTree*) m_root->Get("NoiseTree");
  if(!m_tree) {
     ATH_MSG_FATAL( "No NoiseTree in root file: "<<m_noise_file );
     return StatusCode::FAILURE; 
  }
  */
  // Make a chain
  m_tree = new TChain("NoiseTree");
  for(unsigned int l=0; l<m_noise_file.size(); ++l) {
     m_tree->AddFile(m_noise_file[l].c_str());
  }
  m_entries = m_tree->GetEntries();
  if(m_entries < 100) {
     ATH_MSG_FATAL( "Noise chain has less then 100 events !!!!"  );
     return StatusCode::FAILURE; 
  }
  m_tree->SetBranchAddress("cell_id", &m_cell_id);
  m_tree->SetBranchAddress("cell_ener", &m_cell_energy);
  ATH_MSG_DEBUG(" Got NoiseTree with "<<m_entries<<" entries" );
  ServiceHandle<IIncidentSvc> pIncSvc("IncidentSvc", name());
  ATH_CHECK( pIncSvc.retrieve() );
 
  //start listening to "BeginEvent"
  const int PRIORITY = 100;
  pIncSvc->addListener(this, "BeginEvent", PRIORITY);
 
  ATH_MSG_DEBUG( " TBCellNoiseCorrection initialization finished"  );
  
  return StatusCode::SUCCESS; 
}

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

const InterfaceID & CaloCellCorrection::interfaceID ( )

inlinestaticinherited

Definition at line 51 of file CaloCellCorrection.h.

51{ return IID_CaloCellCorrection;}

IID_CaloCellCorrection

static const InterfaceID IID_CaloCellCorrection("CaloCellCorrection", 1, 0)

◆ MakeCorrection()

void TBCellNoiseCorrection::MakeCorrection	(	CaloCell *	theCell,
		const EventContext &	ctx ) const

overridevirtual

Implements CaloCellCorrection.

Definition at line 136 of file TBCellNoiseCorrection.cxx.

{
 
//   const CaloDetDescrElement* elt = theCell->caloDDE();
 
   if (m_noise_correction) {
    unsigned int cid = theCell->ID().get_identifier32().get_compact();    
    double e = theCell->energy();
    unsigned int size = m_cell_id->size();
    unsigned int i;
    // removing this, should use the BadChannel now
    // if(cid == 810049536)  e = 0.; // Not working cell in data
    for(i = 0; i < size; ++i) {
       if(std::as_const(m_cell_id)->at(i) == cid) {
          e += std::as_const(m_cell_energy)->at(i);
          break;
       }
    }
    if(i == size) {
      ATH_MSG_ERROR( "Could not find a noise value for cell: "<<std::hex<<cid<<std::dec );
    }
 
    theCell->setEnergy(e);
  }
 
}  

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::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< 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.

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

◆ scaleenergy()

void CaloCellCorrection::scaleenergy	(	CaloCell *	lar_cell,
		float	scale )

staticprotectedinherited

Definition at line 91 of file CaloCellCorrection.cxx.

{
  theCell->scaleEnergy( scale );
}

◆ setenergy()

void CaloCellCorrection::setenergy	(	CaloCell *	lar_cell,
		float	energy )

staticprotectedinherited

Definition at line 81 of file CaloCellCorrection.cxx.

{
  theCell->setEnergy( energy );
}

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

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

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

std::vector<float>* TBCellNoiseCorrection::m_cell_energy

private

Definition at line 59 of file TBCellNoiseCorrection.h.

◆ m_cell_id

std::vector<unsigned int>* TBCellNoiseCorrection::m_cell_id

private

Definition at line 58 of file TBCellNoiseCorrection.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_energy

float TBCellNoiseCorrection::m_energy

private

Definition at line 56 of file TBCellNoiseCorrection.h.

◆ m_engine

ATHRNG::RNGWrapper* TBCellNoiseCorrection::m_engine

private

Definition at line 51 of file TBCellNoiseCorrection.h.

◆ m_entries

unsigned int TBCellNoiseCorrection::m_entries

private

Definition at line 60 of file TBCellNoiseCorrection.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_noise_correction

bool TBCellNoiseCorrection::m_noise_correction

private

Definition at line 45 of file TBCellNoiseCorrection.h.

◆ m_noise_file

std::vector<std::string> TBCellNoiseCorrection::m_noise_file

private

Definition at line 46 of file TBCellNoiseCorrection.h.

◆ m_rndmSvc

ServiceHandle<IAthRNGSvc> TBCellNoiseCorrection::m_rndmSvc { this, "RndmSvc", "AthRNGSvc", "" }

private

Definition at line 49 of file TBCellNoiseCorrection.h.

50{ this, "RndmSvc", "AthRNGSvc", "" };

◆ m_tree

TChain* TBCellNoiseCorrection::m_tree

private

Definition at line 53 of file TBCellNoiseCorrection.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.

◆ m_xcryo

float TBCellNoiseCorrection::m_xcryo

private

Definition at line 54 of file TBCellNoiseCorrection.h.

◆ m_ytable

float TBCellNoiseCorrection::m_ytable

private

Definition at line 55 of file TBCellNoiseCorrection.h.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TBCellNoiseCorrection()

◆ ~TBCellNoiseCorrection()

Member Function Documentation

◆ addenergy()

◆ AthAlgTool()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ finalize()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ MakeCorrection()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ scaleenergy()

◆ setenergy()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cell_energy

◆ m_cell_id

◆ m_detStore

◆ m_energy

◆ m_engine

◆ m_entries

◆ m_evtStore

◆ m_noise_correction

◆ m_noise_file

◆ m_rndmSvc

◆ m_tree

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xcryo

◆ m_ytable