ATLAS Offline Software
Public Types | Public Member Functions | List of all members
CP::IMuonSelectionTool Class Referenceabstract

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::AcceptInfogetAcceptInfo () const =0
 Decide whether the muon in question is a "good muon" or not. More...
 
virtual asg::AcceptData accept (const xAOD::Muon &mu) const =0
 Decide whether the muon in question is a "good muon" or not. More...
 
virtual void setPassesIDCuts (xAOD::Muon &mu) const =0
 set the passes ID cuts variable of the muon More...
 
virtual void setQuality (xAOD::Muon &mu) const =0
 set the passes low pT cuts variable of the muon More...
 
virtual bool passedIDCuts (const xAOD::Muon &) const =0
 Returns true if the muon passes the standard MCP ID cuts. More...
 
virtual bool passedMuonCuts (const xAOD::Muon &) const =0
 Returns true if the muon passes a standardized loose preselection. More...
 
virtual bool passedIDCuts (const xAOD::TrackParticle &) const =0
 Returns true if the track particle passes the standard MCP ID cuts. More...
 
virtual bool passedHighPtCuts (const xAOD::Muon &) const =0
 Returns true if the muon passes the standard MCP high pt cuts. More...
 
virtual bool passedLowPtEfficiencyCuts (const xAOD::Muon &) const =0
 Returns true if the muon passes the standard MCP low pt cuts. More...
 
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. More...
 
virtual bool isBadMuon (const xAOD::Muon &) const =0
 Returns true if a CB muon fails some loose quaility requirements designed to remove pathological tracks. More...
 
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. More...
 
virtual bool passedCaloTagQuality (const xAOD::Muon &mu) const =0
 Returns true if the muon passes additional calo-tag quality cuts. More...
 
virtual bool passedCaloScore (const xAOD::Muon &mu) const =0
 Returns true if the muon passes the CaloScore calo-tag working point. More...
 
virtual int getResolutionCategory (const xAOD::Muon &) const =0
 Returns an integer corresponding to categorization of muons with different resolutions. More...
 
virtual void print () const =0
 Print the state of the tool. More...
 

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

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.

31  {
32  unclassified = -1,
33  missingInner = 1,
34  missingMiddle = 1 << 1,
35  missingOuter = 1 << 2,
36  highPt2station = 1 << 3,
37  highPt = 1 << 4,
38  spoiledCSC = 1 << 5,
39  BEoverlap = 1 << 6,
40  BIS78 = 1 << 7,
41  missingBEE = 1 << 8,
42  oneStation = 1 << 9,
48  };

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.

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

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

◆ 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

◆ 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:
CP::IMuonSelectionTool::CategoryOne
@ CategoryOne
Definition: IMuonSelectionTool.h:44
CP::IMuonSelectionTool::unclassified
@ unclassified
Definition: IMuonSelectionTool.h:32
CP::IMuonSelectionTool::BEoverlap
@ BEoverlap
Definition: IMuonSelectionTool.h:39
CP::IMuonSelectionTool::highPt
@ highPt
Definition: IMuonSelectionTool.h:37
CP::IMuonSelectionTool::CategoryZero
@ CategoryZero
Definition: IMuonSelectionTool.h:43
CP::IMuonSelectionTool::CategoryThree
@ CategoryThree
Definition: IMuonSelectionTool.h:46
CP::IMuonSelectionTool::CategoryTwo
@ CategoryTwo
Definition: IMuonSelectionTool.h:45
CP::IMuonSelectionTool::missingMiddle
@ missingMiddle
Definition: IMuonSelectionTool.h:34
CP::IMuonSelectionTool::BIS78
@ BIS78
Definition: IMuonSelectionTool.h:40
CP::IMuonSelectionTool::missingBEE
@ missingBEE
Definition: IMuonSelectionTool.h:41
CP::IMuonSelectionTool::spoiledCSC
@ spoiledCSC
Definition: IMuonSelectionTool.h:38
CP::IMuonSelectionTool::oneStation
@ oneStation
Definition: IMuonSelectionTool.h:42
CP::IMuonSelectionTool::CategoryFour
@ CategoryFour
Definition: IMuonSelectionTool.h:47
CP::IMuonSelectionTool::highPt2station
@ highPt2station
Definition: IMuonSelectionTool.h:36
CP::IMuonSelectionTool::missingOuter
@ missingOuter
Definition: IMuonSelectionTool.h:35
CP::IMuonSelectionTool::missingInner
@ missingInner
Definition: IMuonSelectionTool.h:33