Muon Tagger in the ATLAS calorimeter. More...

#include <CaloMuonTag.h>

Inheritance diagram for CaloMuonTag:

Collaboration diagram for CaloMuonTag:

Public Member Functions
	CaloMuonTag (const std::string &type, const std::string &name, const IInterface *pInterface)
virtual	~CaloMuonTag ()
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
int	caloMuonTag (const std::vector< DepositInCalo > &deposits, double eta, double pt) const override
	Returns the Tag.
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
double	interpolate (const std::string &cutName, double pt) const
int	getPtBinLow (double pt) const
int	getCutBin (const std::string &cutName) const
StatusCode	getHist (TFile *file, const std::string &histName, std::unique_ptr< TH2 > &hist)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::unique_ptr< TH2 >	m_hist {nullptr}
std::string	m_tagMode
std::vector< std::string >	m_vecCutNames
std::vector< int >	m_vecPtBins
int	m_numCuts {0}
int	m_numPtBins {0}
std::atomic_int	m_numTagged {0}
std::atomic_int	m_numRejected {0}
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

Muon Tagger in the ATLAS calorimeter.

This tagger is used in the CaloTrkMuId framework. After some basic preselection CaloTrkMuIdAlg feeds a track to the TrackDepositInCaloTool. TrackDepositInCaloTool gathers the deposits that are found near that track. This tool can tag a muon track from its deposits.

Applies energy deposition veto cuts in all samplings and noise cuts in the last three layers of the hadronic calorimeter (Tile and HEC). The following scale factors are applied to correct for the pathlength traversed in the calorimeter cells.

\(E_{\rm th} = \frac{E^{\mathrm{barrel}}_{0}}{\sin^2 \theta}\) for \(|\eta|<1.7\) \(E_{\rm th} = \frac{E^{\rm end-cap}_{0}}{\ (1 - \sin \theta )^2}\) for \(|\eta|>1.7\)

There are three tags, determined by the acceptance:

0 not a muon,

1 muon in Last Calo Layer,

2 muon in Last-1 Calo Layer,

3 muon in Last-2 Calo Layer,

Author: Gustavo.Ordonez.Sanz Gusta.nosp@m.vo.O.nosp@m.rdone.nosp@m.z.Sa.nosp@m.nz@ce.nosp@m.rn.c.nosp@m.h Marcel Raas marce.nosp@m.lra@.nosp@m.cern..nosp@m.ch (contact person)

Definition at line 18 of file CaloMuonTag.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

◆ CaloMuonTag()

CaloMuonTag::CaloMuonTag	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	pInterface )

Definition at line 14 of file CaloMuonTag.cxx.

                                                                                                   :
    AthAlgTool(type, name, pInterface) {
    declareInterface<ICaloMuonTag>(this);
    declareProperty("TagMode", m_tagMode = "Tight");
}

◆ ~CaloMuonTag()

CaloMuonTag::~CaloMuonTag ( )

virtualdefault

Member Function Documentation

◆ caloMuonTag()

int CaloMuonTag::caloMuonTag	(	const std::vector< DepositInCalo > &	deposits,
		double	eta,
		double	pt ) const

overridevirtual

Returns the Tag.

Implements ICaloMuonTag.

Definition at line 85 of file CaloMuonTag.cxx.

                                                                                                {
    std::vector<DepositInCalo>::const_iterator it = deposits.begin();
    int numVetoesTriggered = 0;
    int tag = 4;
    for (; it != deposits.end(); ++it) {
        CaloCell_ID::CaloSample sample = it->subCaloId();
        double dep = it->energyDeposited();
        double eLoss = it->muonEnergyLoss();
        double diff = dep - eLoss;
 
        if (sample == CaloCell_ID::EMB1) {
            if (dep > interpolate("emb1Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::EMB2) {
            if (dep > interpolate("emb2Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::EMB3) {
            if (dep > interpolate("emb3Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::EME1) {
            if (dep > interpolate("eme1Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::EME2) {
            if (dep > interpolate("eme2Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::EME3) {
            if (dep > interpolate("eme3Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::TileBar0) {
            if (tag > 3) tag = 3;
            if (dep < interpolate("tileBar0Sig", pt)) { numVetoesTriggered++; }
            if (dep > interpolate("tileBar0Veto", pt)) { numVetoesTriggered++; }
            if (diff < interpolate("tileBar0DiffLow", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::TileBar1) {
            if (tag > 2) tag = 2;
            if (dep < interpolate("tileBar1Sig", pt)) { numVetoesTriggered++; }
            if (dep > interpolate("tileBar1Veto", pt)) { numVetoesTriggered++; }
            if (diff < interpolate("tileBar1DiffLow", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::TileBar2) {
            if (tag > 1) tag = 1;
            if (dep < interpolate("tileBar2Sig", pt)) { numVetoesTriggered++; }
            if (dep > interpolate("tileBar2Veto", pt)) { numVetoesTriggered++; }
            if (diff < interpolate("tileBar2DiffLow", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::TileExt0) {
            if (tag > 3) tag = 3;
            if (dep < interpolate("tileExt0Sig", pt)) { numVetoesTriggered++; }
            if (diff < interpolate("tileExt0DiffLow", pt)) { numVetoesTriggered++; }
            if (dep > interpolate("tileExt0Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::TileExt1) {
            if (tag > 2) tag = 2;
            if (dep < interpolate("tileExt1Sig", pt)) { numVetoesTriggered++; }
            if (diff < interpolate("tileExt1DiffLow", pt)) { numVetoesTriggered++; }
            if (dep > interpolate("tileExt1Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::TileExt2) {
            if (tag > 1) tag = 1;
            if (dep < interpolate("tileExt2Sig", pt)) { numVetoesTriggered++; }
            if (diff < interpolate("tileExt2DiffLow", pt)) { numVetoesTriggered++; }
            if (dep > interpolate("tileExt2Veto", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::HEC0) {
            if (dep > interpolate("hec0Veto", pt)) { numVetoesTriggered++; }
            if (dep < interpolate("hec0Sig", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::HEC1) {
            if (tag > 3) tag = 3;
            if (dep > interpolate("hec1Veto", pt)) { numVetoesTriggered++; }
            if (dep < interpolate("hec1Sig", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::HEC2) {
            if (tag > 2) tag = 2;
            if (dep > interpolate("hec2Veto", pt)) { numVetoesTriggered++; }
            if (dep < interpolate("hec2Sig", pt)) { numVetoesTriggered++; }
        }
        if (sample == CaloCell_ID::HEC3) {
            if (tag > 1) tag = 1;
            if (dep > interpolate("hec3Veto", pt)) { numVetoesTriggered++; }
            if (dep < interpolate("hec3Sig", pt)) { numVetoesTriggered++; }
        }
 
        if (numVetoesTriggered >= 1) {
            m_numRejected++;
            return 0;
        }
    }
    if (tag < 3)
        m_numTagged++;
    else if (tag == 4)
        return 0;
    return tag;
}

◆ 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

◆ 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 CaloMuonTag::finalize ( )

overridevirtual

Definition at line 75 of file CaloMuonTag.cxx.

                                 {
    ATH_MSG_INFO("Number of tracks tagged   : " << m_numTagged);
    ATH_MSG_INFO("Number of tracks rejected : " << m_numRejected);
    ATH_MSG_DEBUG("finalize() successful in " << name());
    return StatusCode::SUCCESS;
}

◆ getCutBin()

int CaloMuonTag::getCutBin ( const std::string & cutName ) const

private

Definition at line 217 of file CaloMuonTag.cxx.

                                                         {
    for (int i = 0; i <= m_numCuts; i++) {
        if (cutName == m_vecCutNames[i]) return i;
    }
    return 0;
}

◆ getHist()

StatusCode CaloMuonTag::getHist	(	TFile *	file,
		const std::string &	histName,
		std::unique_ptr< TH2 > &	hist )

private

Definition at line 55 of file CaloMuonTag.cxx.

                                                                                                       {
    if (!file) {
        ATH_MSG_ERROR("NULL TFile");
        return StatusCode::FAILURE;
    }
    TH2* hist = nullptr;
    file->GetObject(histName.c_str(), hist);
    if (!hist) {
        ATH_MSG_ERROR("Cannot retrieve histogram: " << histName);
        return StatusCode::FAILURE;
    }
    hist->SetDirectory(nullptr);
    unique_hist.reset(hist);
    ATH_MSG_INFO("Successfully retrieved histogram: " << histName);
    return StatusCode::SUCCESS;
}

◆ getPtBinLow()

int CaloMuonTag::getPtBinLow ( double pt ) const

private

Definition at line 209 of file CaloMuonTag.cxx.

                                            {
    // Return the bin of lower pt
    for (int i = 0; i <= m_numPtBins; i++) {
        if (pt < m_vecPtBins[i]) return (i - 1);
    }
    return m_numPtBins;
}

◆ initialize()

StatusCode CaloMuonTag::initialize ( )

overridevirtual

Definition at line 28 of file CaloMuonTag.cxx.

                                   {
    // Retrieve histogram
    std::string rootFilePath = PathResolverFindCalibFile("CaloTrkMuIdTools/cutBased_release21/CaloTag.CutConfig.root");
 
    std::unique_ptr<TFile> rootFile{TFile::Open(rootFilePath.c_str(), "READ")};
    ATH_CHECK(getHist(rootFile.get(), m_tagMode, m_hist));
    // Read cut names from histogram
    m_numCuts = m_hist->GetYaxis()->GetNbins();
    if (m_numCuts == 0) {
        ATH_MSG_FATAL("Histogram number of cuts invalid");
        return StatusCode::FAILURE;
    }
    for (int i = 0; i <= m_numCuts; i++) { m_vecCutNames.push_back(m_hist->GetYaxis()->GetBinLabel(i)); }
    // Read pt bins from histogram
    m_numPtBins = m_hist->GetXaxis()->GetNbins();
    if (m_numPtBins == 0) {
        ATH_MSG_FATAL("Histogram number of pt bins invalid");
        return StatusCode::FAILURE;
    }
    for (int i = 0; i <= m_numPtBins; i++) { m_vecPtBins.push_back(atoi(m_hist->GetXaxis()->GetBinLabel(i))); }
    ATH_MSG_DEBUG("initialize() successful in " << name());
    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 & ICaloMuonTag::interfaceID ( )

inlinestaticinherited

Definition at line 23 of file ICaloMuonTag.h.

23{return IID_ICaloMuonTag;}

IID_ICaloMuonTag

static const InterfaceID IID_ICaloMuonTag("ICaloMuonTag", 1, 0)

◆ interpolate()

double CaloMuonTag::interpolate	(	const std::string &	cutName,
		double	pt ) const

private

Definition at line 184 of file CaloMuonTag.cxx.

                                                                         {
    double ptLow = 0, ptUp = 0, cutLow = 0, cutUp = 0, cutReturn = 0;
    // MeV-->GeV
    pt = pt / 1000;
    int ptBin = getPtBinLow(pt);
    int cutBin = getCutBin(cutName);
    if (ptBin < 0 || ptBin > m_numPtBins || cutBin == 0 || cutBin > m_numCuts) ATH_MSG_WARNING("Bin out of bound");
 
    // Get lowest pt bin
    if (ptBin < 1) cutReturn = m_hist->GetBinContent(1, cutBin);
    // Get highest pt bin
    else if (ptBin == m_numPtBins)
        cutReturn = m_hist->GetBinContent(m_numPtBins, cutBin);
    // Interpolate between bins
    else {
        ptUp = m_vecPtBins[ptBin + 1];
        ptLow = m_vecPtBins[ptBin];
        cutUp = m_hist->GetBinContent(ptBin + 1, cutBin);
        cutLow = m_hist->GetBinContent(ptBin, cutBin);
        cutReturn = cutLow + (cutUp - cutLow) * (pt - ptLow) / (ptUp - ptLow);
    }
 
    return cutReturn;
}

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

◆ 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_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_hist

std::unique_ptr<TH2> CaloMuonTag::m_hist {nullptr}

private

Definition at line 59 of file CaloMuonTag.h.

59{nullptr};

◆ m_numCuts

int CaloMuonTag::m_numCuts {0}

private

Definition at line 65 of file CaloMuonTag.h.

65{0};

◆ m_numPtBins

int CaloMuonTag::m_numPtBins {0}

private

Definition at line 66 of file CaloMuonTag.h.

66{0};

◆ m_numRejected

std::atomic_int CaloMuonTag::m_numRejected {0}

mutableprivate

Definition at line 69 of file CaloMuonTag.h.

69{0};

◆ m_numTagged

std::atomic_int CaloMuonTag::m_numTagged {0}

mutableprivate

Definition at line 68 of file CaloMuonTag.h.

68{0};

◆ m_tagMode

std::string CaloMuonTag::m_tagMode

private

Definition at line 60 of file CaloMuonTag.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vecCutNames

std::vector<std::string> CaloMuonTag::m_vecCutNames

private

Definition at line 63 of file CaloMuonTag.h.

◆ m_vecPtBins

std::vector<int> CaloMuonTag::m_vecPtBins

private

Definition at line 64 of file CaloMuonTag.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

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloMuonTag()

◆ ~CaloMuonTag()

Member Function Documentation

◆ caloMuonTag()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getCutBin()

◆ getHist()

◆ getPtBinLow()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ interpolate()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_hist

◆ m_numCuts

◆ m_numPtBins

◆ m_numRejected

◆ m_numTagged

◆ m_tagMode

◆ m_varHandleArraysDeclared

◆ m_vecCutNames

◆ m_vecPtBins

◆ m_vhka