LArCellEmMiscalib Class Reference

Apply miscalibration in EM calorimeter at cell level. More...

#include <LArCellEmMiscalib.h>

Inheritance diagram for LArCellEmMiscalib:

Collaboration diagram for LArCellEmMiscalib:

Public Member Functions
	LArCellEmMiscalib (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~LArCellEmMiscalib ()=default
virtual StatusCode	initialize () override
	Constructor.
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
void	smearingPerRegion (CLHEP::HepRandomEngine *engine)
void	initOnce (const EventContext &ctx)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static int	region (int barrelec, double eta, double phi)

Private Attributes
const LArEM_ID *	m_larem_id
const CaloIdManager *	m_caloIdMgr = nullptr
const CaloDetDescrManager *	m_calodetdescrmgr = nullptr
ServiceHandle< IAthRNGSvc >	m_rngSvc { this, "RndmSvc", "AthRNGSvc", "" }
int	m_seed
double	m_sigmaPerRegion
double	m_sigmaPerCell
bool	m_undo
unsigned int	m_ncellem
std::vector< float >	m_spread1
std::vector< float >	m_calib
std::once_flag	m_initOnce
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}
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

Apply miscalibration in EM calorimeter at cell level.

\ G.Unal (based on other similar tools from K.Voss)

Date

October 25, 2006

Definition at line 35 of file LArCellEmMiscalib.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

LArCellEmMiscalib()

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

Definition at line 36 of file LArCellEmMiscalib.cxx.

  : CaloCellCorrection(type, name, parent),
    m_larem_id(nullptr),
    m_seed(1234),
    m_sigmaPerRegion(0.005),
    m_sigmaPerCell(0.007),
    m_undo(false),
    m_ncellem(0)
{
  declareInterface<CaloCellCorrection>(this); 
  declareProperty("Seed",   m_seed, "seed : should always be the same");
  declareProperty("SigmaPerRegion", m_sigmaPerRegion,"smearing per region");
  declareProperty("SigmaPerCell", m_sigmaPerCell, "smearing per cell ");
  declareProperty("UndoMisCalib",m_undo,"Apply opposite sign to undo miscalibration");
}

~LArCellEmMiscalib()

virtual LArCellEmMiscalib::~LArCellEmMiscalib ( )

virtualdefault

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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 LArCellEmMiscalib::initialize ( )

overridevirtual

Constructor.

Definition at line 61 of file LArCellEmMiscalib.cxx.

{
  ATH_MSG_INFO( " in LArCellEmMiscalib::initialize()"  );
  ATH_CHECK(m_caloMgrKey.initialize());
  ATH_CHECK(m_rngSvc.retrieve());
  return StatusCode::SUCCESS;
}

initOnce()

void LArCellEmMiscalib::initOnce ( const EventContext & ctx )

private

Definition at line 69 of file LArCellEmMiscalib.cxx.

                                                         {
  StatusCode sc;
  sc=detStore()->retrieve( m_caloIdMgr );
  sc.ignore();
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey, ctx};
  m_calodetdescrmgr = *caloMgrHandle;
 
  ATHRNG::RNGWrapper* wrapper = m_rngSvc->getEngine (this);
  wrapper->setSeed (ctx.slot(), m_seed);
  CLHEP::HepRandomEngine* engine = wrapper->getEngine (ctx);
 
 
  // computes the smearing per region
  this->smearingPerRegion (engine);
 
 
  m_larem_id   = m_caloIdMgr->getEM_ID();
 
  m_ncellem=m_larem_id->channel_hash_max();
  m_calib.resize(m_ncellem,1.);
 
  ATH_MSG_DEBUG(" Number of EM cells " << m_ncellem);
 
  for (unsigned int i=0;i<m_ncellem;i++){
    IdentifierHash idHash = i;
    Identifier id = m_larem_id->channel_id(idHash);
    int barrel_ec = m_larem_id->barrel_ec(id);
    const CaloDetDescrElement* calodde = m_calodetdescrmgr->get_element(id);
    double eta = fabs(calodde->eta_raw());
    double phi = calodde->phi_raw();
    int iregion= LArCellEmMiscalib::region(barrel_ec,eta,phi);
    if (iregion>=0) {
        ATH_MSG_VERBOSE("barrel_ec,eta,phi,region " << barrel_ec << " " << eta << " " << phi << " " 
            << iregion << " " << m_spread1[iregion]);
         double spread2=m_sigmaPerCell*RandGauss::shoot(engine,0.,1.);
         m_calib[idHash] = m_spread1[iregion] + spread2;
         if (m_undo ) {
              if (m_calib[idHash] >0.) m_calib[idHash]=1./m_calib[idHash];
              else m_calib[idHash]=1.;
         }
         ATH_MSG_VERBOSE("  m_calib " << m_calib[idHash]);
    } 
    else {
      ATH_MSG_WARNING( " Cannot find region for cell " << eta << " " << phi  );
      m_calib[idHash]=1.;
    }
  }
 
 
  
}

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.

{ return IID_CaloCellCorrection;}

MakeCorrection()

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

overridevirtual

Implements CaloCellCorrection.

Definition at line 210 of file LArCellEmMiscalib.cxx.

{
  LArCellEmMiscalib* thisNC ATLAS_THREAD_SAFE = const_cast<LArCellEmMiscalib*>(this);
  std::call_once(m_initOnce, &LArCellEmMiscalib::initOnce,thisNC, ctx);
  float energy = theCell->energy();
 
  float weight=1; 
 
 
  const CaloDetDescrElement * theDDE = theCell->caloDDE();
  // Identifier id = theCell->ID();
 
  //if (m_larem_id->is_lar_em(id)) {
    
  if (theDDE->getSubCalo()==CaloCell_ID::LAREM) {
    // IdentifierHash idHash = m_larem_id->channel_hash(id);
    IdentifierHash idHash = theDDE->calo_hash();
    if (idHash < m_ncellem) {
      weight = m_calib[idHash];
      } 
    else
      {
    ATH_MSG_WARNING( "Inconsistent hash value found " << idHash 
                         << " >= " << m_ncellem  );
      }
//    if (m_larem_id->phi(id)==0)
//      std::cout << "Barrel_ec,sampl.region,eta,wt " << m_larem_id->barrel_ec(id) <<
//       " " << m_larem_id->sampling(id) << " " << m_larem_id->region(id) << " " <<
//       m_larem_id->eta(id) << " " << weight << std::endl;
 
    setenergy(theCell,energy*weight);
 
 
  }
}

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.

region()

int LArCellEmMiscalib::region ( int barrelec, double eta, double phi )

staticprivate

Definition at line 168 of file LArCellEmMiscalib.cxx.

{
 int iregion=-1;
 if (phi<0.) phi=phi+2*M_PI;
 int iphi=(int)(phi*(16./(2*M_PI)));
 if (iphi>15) iphi=15;
 if (abs(barrelec)==1) {
    int ieta=(int)(eta*(1./0.2));
    if (ieta>7) ieta=7;
    iregion=16*ieta+iphi;
    if (barrelec==1) iregion=iregion+128;
 }
 if (abs(barrelec)==2) {
    int ieta;
    if (eta<1.5) ieta=0;
    else if(eta<1.6) ieta=1;
    else if(eta<1.8) ieta=2;
    else if(eta<2.0) ieta=3;
    else if(eta<2.1) ieta=4;
    else if(eta<2.3) ieta=5;
    else  ieta=6;
    iregion=16*ieta+iphi;
    if (barrelec==-2) iregion=iregion+256;
    if (barrelec==2) iregion=iregion+256+112;
 }
 if (abs(barrelec)==3) {
   //int ieta;
   //if (eta<2.8) ieta=0;
   //else ieta=1;
    if (barrelec==-3) iregion=iregion+256+224;
    if (barrelec==3) iregion=iregion+256+224+32;
 }
 return iregion;
 
}

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

smearingPerRegion()

void LArCellEmMiscalib::smearingPerRegion ( CLHEP::HepRandomEngine * engine )

private

Definition at line 122 of file LArCellEmMiscalib.cxx.

{
  m_spread1.resize(544,1);
  for (int i=0;i<544;i++) {
    m_spread1[i]=1.+m_sigmaPerRegion*RandGauss::shoot(engine,0.,1.);
  }
 
  if (msgLvl(MSG::DEBUG)) {
    for (int i=0;i<544;i++) {
      int iregion=i;
      int ieta,iphi,barrelec,ii;
      if (iregion<128) {
          barrelec=-1;
          ii=iregion;
      }
      else if (iregion<256) {
          barrelec=1;
          ii=iregion-128;
      } 
      else if (iregion<(256+112)) {
          barrelec=-2;
          ii=iregion-256;
      }
      else if (iregion<(256+224)) {
          barrelec=2;
          ii=iregion-(256+112);
      }
      else if (iregion<(256+224+32)) {
          barrelec=-3;
          ii=iregion-(256+224);
      }
      else {
          barrelec=3;
          ii=iregion-(256+224+32);
      }
      iphi=ii%16;
      ieta=ii/16;
      ATH_MSG_DEBUG( "iregion,barrelec,ieta,iphi,spread " << iregion << " " 
                     << barrelec << " " << ieta << " " << iphi << " " << m_spread1[i]  );
    }
  }//end if msg_lvl(DEBUG)
 
}

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_calib

std::vector<float> LArCellEmMiscalib::m_calib

private

Definition at line 72 of file LArCellEmMiscalib.h.

m_calodetdescrmgr

const CaloDetDescrManager* LArCellEmMiscalib::m_calodetdescrmgr = nullptr

private

Definition at line 60 of file LArCellEmMiscalib.h.

m_caloIdMgr

const CaloIdManager* LArCellEmMiscalib::m_caloIdMgr = nullptr

private

Definition at line 59 of file LArCellEmMiscalib.h.

m_caloMgrKey

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

private

Definition at line 76 of file LArCellEmMiscalib.h.

{this,"CaloDetDescrManager", "CaloDetDescrManager"};

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_initOnce

std::once_flag LArCellEmMiscalib::m_initOnce

mutableprivate

Definition at line 74 of file LArCellEmMiscalib.h.

m_larem_id

const LArEM_ID* LArCellEmMiscalib::m_larem_id

private

Definition at line 58 of file LArCellEmMiscalib.h.

m_ncellem

unsigned int LArCellEmMiscalib::m_ncellem

private

Definition at line 70 of file LArCellEmMiscalib.h.

m_rngSvc

ServiceHandle<IAthRNGSvc> LArCellEmMiscalib::m_rngSvc { this, "RndmSvc", "AthRNGSvc", "" }

private

Definition at line 62 of file LArCellEmMiscalib.h.

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

m_seed

int LArCellEmMiscalib::m_seed

private

Definition at line 65 of file LArCellEmMiscalib.h.

m_sigmaPerCell

double LArCellEmMiscalib::m_sigmaPerCell

private

Definition at line 67 of file LArCellEmMiscalib.h.

m_sigmaPerRegion

double LArCellEmMiscalib::m_sigmaPerRegion

private

Definition at line 66 of file LArCellEmMiscalib.h.

m_spread1

std::vector<float> LArCellEmMiscalib::m_spread1

private

Definition at line 71 of file LArCellEmMiscalib.h.

m_undo

bool LArCellEmMiscalib::m_undo

private

Definition at line 68 of file LArCellEmMiscalib.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:

• LArCellEmMiscalib.h
• LArCellEmMiscalib.cxx