#include <CaloCellRandomizer.h>

Inheritance diagram for CaloCellRandomizer:

Collaboration diagram for CaloCellRandomizer:

Public Member Functions
	CaloCellRandomizer (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~CaloCellRandomizer ()
virtual StatusCode	initialize () override
virtual void	MakeCorrection (CaloCell *theCell, const EventContext &ctx) const 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
SG::ReadCondHandleKey< CaloNoise >	m_caloNoiseKey
int	m_corrSampleMin
int	m_corrSampleMax
float	m_fractionSigma
bool	m_GaussRand
bool	m_GaussRandGroupedSamples
bool	m_GaussRandShifted
bool	m_GaussRandShifted_Custom
float	m_shift_EMB
float	m_shift_EMEC
float	m_shift_HEC
float	m_shift_TileBar
float	m_shift_TileGap
float	m_shift_TileExt
float	m_shift_FCAL
ServiceHandle< IAthRNGSvc >	m_athRNGSvc
std::string	m_randomStream
ATHRNG::RNGWrapper *	m_randomEngine
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 18 of file CaloCellRandomizer.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

◆ CaloCellRandomizer()

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

Definition at line 26 of file CaloCellRandomizer.cxx.

  : CaloCellCorrection(type, name, parent),
    m_corrSampleMin(0),m_corrSampleMax(0),m_fractionSigma(1),m_GaussRand(false),m_GaussRandGroupedSamples(false),m_GaussRandShifted(false),m_GaussRandShifted_Custom(false), m_shift_EMB(1),m_shift_EMEC(1),m_shift_HEC(1),m_shift_TileBar(1),m_shift_TileGap(1),m_shift_TileExt(1),m_shift_FCAL(1),
    m_athRNGSvc ("AthRNGSvc", name),
    m_randomEngine (nullptr)
{
 declareInterface<CaloCellCorrection>(this);
 // declareProperty("SampleNums",m_sampleNums);
 declareProperty("DoRandomSampleMin",m_corrSampleMin);
 declareProperty("DoRandomSampleMax",m_corrSampleMax);
 declareProperty("RandomiseGroupedSampleCells",m_GaussRandGroupedSamples);
 declareProperty("DoGaussRandomization",m_GaussRand);
 declareProperty("DoShiftedGaussRandomization",m_GaussRandShifted);
 declareProperty("FractionOfSigmaNoiseInShifting",m_fractionSigma);
 
 declareProperty("DoShiftedGaussRandomizationCustomisedInCalo",m_GaussRandShifted_Custom);
 declareProperty("CustomShiftEMB",m_shift_EMB);
 declareProperty("CustomShiftEMEC",m_shift_EMEC);
 declareProperty("CustomShiftHEC",m_shift_HEC);
 declareProperty("CustomShiftTileBar",m_shift_TileBar);
 declareProperty("CustomShiftTileGap",m_shift_TileGap);
 declareProperty("CustomShiftTileExt",m_shift_TileExt);
 declareProperty("CustomShiftFCAL",m_shift_FCAL);
 declareProperty("AthRNGSvc", m_athRNGSvc);
 declareProperty("RandomStream", m_randomStream = "CaloCellRandomizer");
}

◆ ~CaloCellRandomizer()

virtual CaloCellRandomizer::~CaloCellRandomizer ( )

inlinevirtual

Definition at line 28 of file CaloCellRandomizer.h.

28{};

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

◆ initialize()

StatusCode CaloCellRandomizer::initialize ( )

overridevirtual

Definition at line 59 of file CaloCellRandomizer.cxx.

{
  ATH_MSG_INFO( " in CaloCellRandomizer::initialize() "  );
  ATH_CHECK( m_caloNoiseKey.initialize() );
  ATH_MSG_INFO( "Noise Tool retrieved"  );
  ATH_MSG_INFO( "CaloCellRandomizer initialize() end"  );
  ATH_CHECK( m_athRNGSvc.retrieve() );
  m_randomEngine = m_athRNGSvc->getEngine (this, m_randomStream);
  if (!m_randomEngine) {
    ATH_MSG_ERROR("Could not get random number engine from AthRNGSvc. Abort.");
    return StatusCode::FAILURE;
  }
  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 CaloCellRandomizer::MakeCorrection	(	CaloCell *	theCell,
		const EventContext &	ctx ) const

overridevirtual

Implements CaloCellCorrection.

Definition at line 77 of file CaloCellRandomizer.cxx.

{
  CLHEP::HepRandomEngine* engine = m_randomEngine->getEngine (ctx);
 
  int sampl = 0;
  float Gauss = 0;
  float GaussShifted = 0;
 
  const CaloDetDescrElement* caloDDE = theCell->caloDDE();
  sampl=caloDDE->getSampling();    
   
  //CaloNoise
  SG::ReadCondHandle<CaloNoise> caloNoise (m_caloNoiseKey, ctx);
  double SigmaNoise = caloNoise->getNoise(theCell->ID(), theCell->gain());
  
 
  Gauss = RandGauss::shoot(engine, 0.,1.);
 
  GaussShifted = Gauss+m_fractionSigma;
 
 
  if( m_GaussRand  ){
    setenergy(theCell,(Gauss*SigmaNoise));
  }
  
    
  if(m_GaussRandShifted){
    //    setenergy(theCell,(GaussShifted)); 
    setenergy(theCell,(GaussShifted*SigmaNoise)); 
  }
  
  
  if(m_GaussRandShifted_Custom){//var 
    if (sampl<4){ 
      GaussShifted = RandGauss::shoot(engine, m_shift_EMB*SigmaNoise,SigmaNoise); 
      setenergy(theCell,(GaussShifted)); 
    }
    if (sampl>3 && sampl<8){ 
      GaussShifted = RandGauss::shoot(engine, m_shift_EMEC*SigmaNoise,SigmaNoise); 
      setenergy(theCell,(GaussShifted)); 
    }
    if (sampl>7 && sampl<12){ 
      GaussShifted = RandGauss::shoot(engine, m_shift_HEC*SigmaNoise,SigmaNoise); 
      setenergy(theCell,(GaussShifted)); 
    } 
    if (sampl>11 && sampl<15){ 
      GaussShifted = RandGauss::shoot(engine, m_shift_TileBar*SigmaNoise,SigmaNoise); 
      setenergy(theCell,(GaussShifted)); 
    } 
    if (sampl>14 && sampl<18){ 
      GaussShifted = RandGauss::shoot(engine, m_shift_TileGap*SigmaNoise,SigmaNoise); 
      setenergy(theCell,(GaussShifted)); 
    }  
    if (sampl>17 && sampl<21){
      GaussShifted = RandGauss::shoot(engine, m_shift_TileExt*SigmaNoise,SigmaNoise);
      setenergy(theCell,(GaussShifted));
    }
    if (sampl>20 && sampl<24){
      GaussShifted = RandGauss::shoot(engine, m_shift_FCAL*SigmaNoise,SigmaNoise);
      setenergy(theCell,(GaussShifted));
    } 
    
  }
  
  
  if(m_GaussRandGroupedSamples){
    if(sampl>m_corrSampleMin && sampl<m_corrSampleMax){
      setenergy(theCell,(Gauss*SigmaNoise));
    }
  }
  
  
  //check if cells were masked before from tile reco alg, so to remove them, Tile Case only
  //  const TileCell* aTileCell = dynamic_cast<const TileCell*> (theCell);
  //if CaloNoise big values means we have bad cells (for tile when badcell is not applicalble). get ride of these cells
  if ( (sampl>11 && sampl<21) && SigmaNoise>999){
    setenergy(theCell,0);
  }
  
  
}

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

ServiceHandle<IAthRNGSvc> CaloCellRandomizer::m_athRNGSvc

private

Definition at line 58 of file CaloCellRandomizer.h.

◆ m_caloNoiseKey

SG::ReadCondHandleKey<CaloNoise> CaloCellRandomizer::m_caloNoiseKey

private

Initial value:

{this, "CaloNoise",
      "electronicNoise",
      "CaloNoise object to read."}

Definition at line 39 of file CaloCellRandomizer.h.

                                               {this, "CaloNoise",
      "electronicNoise",
      "CaloNoise object to read."};

◆ m_corrSampleMax

int CaloCellRandomizer::m_corrSampleMax

private

Definition at line 44 of file CaloCellRandomizer.h.

◆ m_corrSampleMin

int CaloCellRandomizer::m_corrSampleMin

private

Definition at line 43 of file CaloCellRandomizer.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_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_fractionSigma

float CaloCellRandomizer::m_fractionSigma

private

Definition at line 45 of file CaloCellRandomizer.h.

◆ m_GaussRand

bool CaloCellRandomizer::m_GaussRand

private

Definition at line 46 of file CaloCellRandomizer.h.

◆ m_GaussRandGroupedSamples

bool CaloCellRandomizer::m_GaussRandGroupedSamples

private

Definition at line 47 of file CaloCellRandomizer.h.

◆ m_GaussRandShifted

bool CaloCellRandomizer::m_GaussRandShifted

private

Definition at line 48 of file CaloCellRandomizer.h.

◆ m_GaussRandShifted_Custom

bool CaloCellRandomizer::m_GaussRandShifted_Custom

private

Definition at line 49 of file CaloCellRandomizer.h.

◆ m_randomEngine

ATHRNG::RNGWrapper* CaloCellRandomizer::m_randomEngine

private

Definition at line 60 of file CaloCellRandomizer.h.

◆ m_randomStream

std::string CaloCellRandomizer::m_randomStream

private

Definition at line 59 of file CaloCellRandomizer.h.

◆ m_shift_EMB

float CaloCellRandomizer::m_shift_EMB

private

Definition at line 50 of file CaloCellRandomizer.h.

◆ m_shift_EMEC

float CaloCellRandomizer::m_shift_EMEC

private

Definition at line 51 of file CaloCellRandomizer.h.

◆ m_shift_FCAL

float CaloCellRandomizer::m_shift_FCAL

private

Definition at line 56 of file CaloCellRandomizer.h.

◆ m_shift_HEC

float CaloCellRandomizer::m_shift_HEC

private

Definition at line 52 of file CaloCellRandomizer.h.

◆ m_shift_TileBar

float CaloCellRandomizer::m_shift_TileBar

private

Definition at line 53 of file CaloCellRandomizer.h.

◆ m_shift_TileExt

float CaloCellRandomizer::m_shift_TileExt

private

Definition at line 55 of file CaloCellRandomizer.h.

◆ m_shift_TileGap

float CaloCellRandomizer::m_shift_TileGap

private

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

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

◆ CaloCellRandomizer()

◆ ~CaloCellRandomizer()

Member Function Documentation

◆ addenergy()

◆ AthAlgTool()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ MakeCorrection()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ scaleenergy()

◆ setenergy()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_athRNGSvc

◆ m_caloNoiseKey

◆ m_corrSampleMax

◆ m_corrSampleMin

◆ m_detStore

◆ m_evtStore

◆ m_fractionSigma

◆ m_GaussRand

◆ m_GaussRandGroupedSamples

◆ m_GaussRandShifted

◆ m_GaussRandShifted_Custom

◆ m_randomEngine

◆ m_randomStream

◆ m_shift_EMB

◆ m_shift_EMEC

◆ m_shift_FCAL

◆ m_shift_HEC

◆ m_shift_TileBar

◆ m_shift_TileExt

◆ m_shift_TileGap

◆ m_varHandleArraysDeclared

◆ m_vhka