Interface for (a) muon selector tool(s) More...

#include <IMuonSelectionTool.h>

Inheritance diagram for CP::IMuonSelectionTool:

Collaboration diagram for CP::IMuonSelectionTool:

Public Types
enum	ResolutionCategory { unclassified = -1 , missingInner = 1 , missingMiddle = 1 << 1 , missingOuter = 1 << 2 , highPt2station = 1 << 3 , highPt = 1 << 4 , spoiledCSC = 1 << 5 , BEoverlap = 1 << 6 , BIS78 = 1 << 7 , missingBEE = 1 << 8 , oneStation = 1 << 9 , CategoryZero = missingInner \| spoiledCSC \| BEoverlap \| BIS78 \| missingBEE , CategoryOne = missingMiddle \| oneStation , CategoryTwo = missingOuter , CategoryThree = highPt2station , CategoryFour = highPt }
	Declare the interface that the class provides. More...

Public Member Functions
virtual const asg::AcceptInfo &	getAcceptInfo () const =0
	Decide whether the muon in question is a "good muon" or not.
virtual asg::AcceptData	accept (const xAOD::Muon &mu) const =0
	Decide whether the muon in question is a "good muon" or not.
virtual void	setPassesIDCuts (xAOD::Muon &mu) const =0
	set the passes ID cuts variable of the muon
virtual void	setQuality (xAOD::Muon &mu) const =0
	set the passes low pT cuts variable of the muon
virtual bool	passedIDCuts (const xAOD::Muon &) const =0
	Returns true if the muon passes the standard MCP ID cuts.
virtual bool	passedMuonCuts (const xAOD::Muon &) const =0
	Returns true if the muon passes a standardized loose preselection.
virtual bool	passedIDCuts (const xAOD::TrackParticle &) const =0
	Returns true if the track particle passes the standard MCP ID cuts.
virtual bool	passedHighPtCuts (const xAOD::Muon &) const =0
	Returns true if the muon passes the standard MCP high pt cuts.
virtual bool	passedLowPtEfficiencyCuts (const xAOD::Muon &) const =0
	Returns true if the muon passes the standard MCP low pt cuts.
virtual bool	passedLowPtEfficiencyCuts (const xAOD::Muon &, xAOD::Muon::Quality thisMu_quality) const =0
virtual bool	passedErrorCutCB (const xAOD::Muon &) const =0
	Returns true if a CB muon passes a pt- and eta-dependent cut on the relative CB q/p error.
virtual bool	isBadMuon (const xAOD::Muon &) const =0
	Returns true if a CB muon fails some loose quaility requirements designed to remove pathological tracks.
virtual xAOD::Muon::Quality	getQuality (const xAOD::Muon &mu) const =0
	Returns the quality of the muon. To set the value on the muon, instead call setQuality(xAOD::Muon&) const.
virtual bool	passedCaloTagQuality (const xAOD::Muon &mu) const =0
	Returns true if the muon passes additional calo-tag quality cuts.
virtual bool	passedCaloScore (const xAOD::Muon &mu) const =0
	Returns true if the muon passes the CaloScore calo-tag working point.
virtual int	getResolutionCategory (const xAOD::Muon &) const =0
	Returns an integer corresponding to categorization of muons with different resolutions.
virtual float	getTightNNScore (const xAOD::Muon &muon) const =0
	Returns the TightNNscore of the muon, an experimental ML-based score for the identification of muons from HF hadron decays.
virtual void	print () const =0
	Print the state of the tool.

Detailed Description

Interface for (a) muon selector tool(s)

This is an example of how to define object selection in a tool.

Author: Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 25 of file IMuonSelectionTool.h.

Member Enumeration Documentation

◆ ResolutionCategory

enum CP::IMuonSelectionTool::ResolutionCategory

Declare the interface that the class provides.

Enum for resolution categories, the "merged" categories Zero to Four group together categories with similar resolution

Enumerator
unclassified
missingInner
missingMiddle
missingOuter
highPt2station
highPt
spoiledCSC
BEoverlap
BIS78
missingBEE
oneStation
CategoryZero
CategoryOne
CategoryTwo
CategoryThree
CategoryFour

Definition at line 31 of file IMuonSelectionTool.h.

                                {
            unclassified = -1,
            missingInner = 1,
            missingMiddle = 1 << 1,
            missingOuter = 1 << 2,
            highPt2station = 1 << 3,
            highPt = 1 << 4,
            spoiledCSC = 1 << 5,
            BEoverlap = 1 << 6,
            BIS78 = 1 << 7,
            missingBEE = 1 << 8,
            oneStation = 1 << 9,
            CategoryZero = missingInner | spoiledCSC | BEoverlap | BIS78 | missingBEE,
            CategoryOne = missingMiddle | oneStation,
            CategoryTwo = missingOuter,
            CategoryThree = highPt2station,
            CategoryFour = highPt
        };

Member Function Documentation

◆ accept()

virtual asg::AcceptData CP::IMuonSelectionTool::accept ( const xAOD::Muon & mu ) const

pure virtual

Decide whether the muon in question is a "good muon" or not.

Implemented in CP::MuonSelectionTool.

◆ getAcceptInfo()

virtual const asg::AcceptInfo & CP::IMuonSelectionTool::getAcceptInfo ( ) const

pure virtual

Decide whether the muon in question is a "good muon" or not.

Implemented in CP::MuonSelectionTool.

◆ getQuality()

virtual xAOD::Muon::Quality CP::IMuonSelectionTool::getQuality ( const xAOD::Muon & mu ) const

pure virtual

Returns the quality of the muon. To set the value on the muon, instead call setQuality(xAOD::Muon&) const.

Implemented in CP::MuonSelectionTool.

◆ getResolutionCategory()

virtual int CP::IMuonSelectionTool::getResolutionCategory ( const xAOD::Muon & ) const

pure virtual

Returns an integer corresponding to categorization of muons with different resolutions.

Implemented in CP::MuonSelectionTool.

◆ getTightNNScore()

virtual float CP::IMuonSelectionTool::getTightNNScore ( const xAOD::Muon & muon ) const

pure virtual

Returns the TightNNscore of the muon, an experimental ML-based score for the identification of muons from HF hadron decays.

Implemented in CP::MuonSelectionTool.

◆ isBadMuon()

virtual bool CP::IMuonSelectionTool::isBadMuon ( const xAOD::Muon & ) const

pure virtual

Returns true if a CB muon fails some loose quaility requirements designed to remove pathological tracks.

Implemented in CP::MuonSelectionTool.

◆ passedCaloScore()

virtual bool CP::IMuonSelectionTool::passedCaloScore ( const xAOD::Muon & mu ) const

pure virtual

Returns true if the muon passes the CaloScore calo-tag working point.

Implemented in CP::MuonSelectionTool.

◆ passedCaloTagQuality()

virtual bool CP::IMuonSelectionTool::passedCaloTagQuality ( const xAOD::Muon & mu ) const

pure virtual

Returns true if the muon passes additional calo-tag quality cuts.

Implemented in CP::MuonSelectionTool.

◆ passedErrorCutCB()

virtual bool CP::IMuonSelectionTool::passedErrorCutCB ( const xAOD::Muon & ) const

pure virtual

Returns true if a CB muon passes a pt- and eta-dependent cut on the relative CB q/p error.

Implemented in CP::MuonSelectionTool.

◆ passedHighPtCuts()

virtual bool CP::IMuonSelectionTool::passedHighPtCuts ( const xAOD::Muon & ) const

pure virtual

Returns true if the muon passes the standard MCP high pt cuts.

To set the value on the muon, instead call setPassesHighPtCuts(xAOD::Muon&) const

Implemented in CP::MuonSelectionTool.

◆ passedIDCuts() [1/2]

virtual bool CP::IMuonSelectionTool::passedIDCuts ( const xAOD::Muon & ) const

pure virtual

Returns true if the muon passes the standard MCP ID cuts.

To set the value on the muon, instead call setPassesIDCuts(xAOD::Muon&) const

Implemented in CP::MuonSelectionTool, and CP::MuonSelectionTool.

◆ passedIDCuts() [2/2]

virtual bool CP::IMuonSelectionTool::passedIDCuts ( const xAOD::TrackParticle & ) const

pure virtual

Returns true if the track particle passes the standard MCP ID cuts.

Implemented in CP::MuonSelectionTool, and CP::MuonSelectionTool.

◆ passedLowPtEfficiencyCuts() [1/2]

virtual bool CP::IMuonSelectionTool::passedLowPtEfficiencyCuts ( const xAOD::Muon & ) const

pure virtual

Returns true if the muon passes the standard MCP low pt cuts.

To set the value on the muon, instead call setPassesHighPtCuts(xAOD::Muon&) const

Implemented in CP::MuonSelectionTool.

◆ passedLowPtEfficiencyCuts() [2/2]

virtual bool CP::IMuonSelectionTool::passedLowPtEfficiencyCuts	(	const xAOD::Muon &	,
		xAOD::Muon::Quality	thisMu_quality ) const

pure virtual

Implemented in CP::MuonSelectionTool.

◆ passedMuonCuts()

virtual bool CP::IMuonSelectionTool::passedMuonCuts ( const xAOD::Muon & ) const

pure virtual

Returns true if the muon passes a standardized loose preselection.

Implemented in CP::MuonSelectionTool.

◆ print()

virtual void asg::IAsgTool::print ( ) const

pure virtualinherited

Print the state of the tool.

Implemented in asg::AsgTool, AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

◆ setPassesIDCuts()

virtual void CP::IMuonSelectionTool::setPassesIDCuts ( xAOD::Muon & mu ) const

pure virtual

set the passes ID cuts variable of the muon

Implemented in CP::MuonSelectionTool.

◆ setQuality()

virtual void CP::IMuonSelectionTool::setQuality ( xAOD::Muon & mu ) const

pure virtual

set the passes low pT cuts variable of the muon

set the passes quality variable of the muon

Implemented in CP::MuonSelectionTool.

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

IMuonSelectionTool.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ResolutionCategory

Member Function Documentation

◆ accept()

◆ getAcceptInfo()

◆ getQuality()

◆ getResolutionCategory()

◆ getTightNNScore()

◆ isBadMuon()

◆ passedCaloScore()

◆ passedCaloTagQuality()

◆ passedErrorCutCB()

◆ passedHighPtCuts()

◆ passedIDCuts() [1/2]

◆ passedIDCuts() [2/2]

◆ passedLowPtEfficiencyCuts() [1/2]

◆ passedLowPtEfficiencyCuts() [2/2]

◆ passedMuonCuts()

◆ print()

◆ setPassesIDCuts()

◆ setQuality()