ATLAS Offline Software
MuonRoI_v1.h
Go to the documentation of this file.
1 // Dear emacs, this is -*- c++ -*-
2 
3 /*
4  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
5 */
6 
7 // $Id: MuonRoI_v1.h 631149 2014-11-26 12:26:18Z krasznaa $
8 #ifndef XAODTRIGGER_VERSIONS_MUONROI_V1_H
9 #define XAODTRIGGER_VERSIONS_MUONROI_V1_H
10 
11 // System include(s):
12 extern "C" {
13 # include <stdint.h>
14 }
15 #include <string>
16 
17 // EDM include(s):
19 
20 namespace xAOD {
21 
33  class MuonRoI_v1 : public SG::AuxElement {
34 
35  public:
37  enum RoISource {
40  Forward
41  };
43  enum Hemisphere {
45  Negative
46  };
48  enum Charge {
49  Neg = 0,
50  Pos = 1,
51  Undef = 100
52  };
53 
55  MuonRoI_v1();
56 
58  void initialize( uint32_t roiword, float eta, float phi,
59  const std::string& thrname, float thrvalue );
60 
63 
65  float eta() const;
67  void setEta( float v );
68 
70  float phi() const;
72  void setPhi( float v );
73 
75  uint32_t roiWord() const;
78 
80  float thrValue() const;
82  void setThrValue( float v );
83 
85  const std::string& thrName() const;
87  void setThrName( const std::string& value );
88 
90 
93 
95  int getThrNumber() const;
97  int getRoI() const;
99  int getSectorAddress() const;
101  int getSectorID() const;
103  bool isFirstCandidate() const;
105  bool isMoreCandInRoI() const;
107  bool isMoreCandInSector() const;
113  bool getPhiOverlap() const;
115  bool getEtaOverlap() const;
117  Charge getCharge() const;
119  bool getBW3Coincidence() const;
121  bool getInnerCoincidence() const;
123  bool getGoodMF() const;
125  bool isVetoed() const;
127  bool isRun3() const;
128 
130 
131  }; // class MuonRoI_v1
132 
133 } // namespace xAOD
134 
135 // Declare the inheritance of the class:
136 #include "xAODCore/BaseInfo.h"
138 
139 #endif // XAODTRIGGER_VERSIONS_MUONROI_V1_H
xAOD::MuonRoI_v1::initialize
void initialize(uint32_t roiword, float eta, float phi, const std::string &thrname, float thrvalue)
Initialise the object with all its properties.
Definition: MuonRoI_v1.cxx:33
xAOD::MuonRoI_v1::getSectorAddress
int getSectorAddress() const
Get the full sector address.
xAOD::MuonRoI_v1::getPhiOverlap
bool getPhiOverlap() const
Returns whether there's overlap between barrel sectors.
xAOD::MuonRoI_v1::Endcap
@ Endcap
The muon candidate was detected in the endcap region.
Definition: MuonRoI_v1.h:39
xAOD::MuonRoI_v1::getInnerCoincidence
bool getInnerCoincidence() const
Returns whether or not there was an inner coincidence in the TGC.
xAOD::MuonRoI_v1::getThrNumber
int getThrNumber() const
Get the logic number of the highest threshold this RoI passed.
xAOD::uint32_t
setEventNumber uint32_t
Definition: EventInfo_v1.cxx:127
xAOD::MuonRoI_v1::Neg
@ Neg
Candidate is a mu- from a TGC sector.
Definition: MuonRoI_v1.h:49
SG::AuxElement
Base class for elements of a container that can have aux data.
Definition: AuxElement.h:446
xAOD::MuonRoI_v1::getHemisphere
Hemisphere getHemisphere() const
Returns the hemisphere that detected the muon candidate.
BaseInfo.h
xAOD::MuonRoI_v1::eta
float eta() const
The pseudorapidity ( ) of the muon candidate.
xAOD::MuonRoI_v1::thrValue
float thrValue() const
The highest threshold value (in MeV) passed by the muon candidate.
athena.value
value
Definition: athena.py:122
xAOD::MuonRoI_v1::MuonRoI_v1
MuonRoI_v1()
Default constructor.
Definition: MuonRoI_v1.cxx:19
xAOD
ICaloAffectedTool is abstract interface for tools checking if 4 mom is in calo affected region.
Definition: ICaloAffectedTool.h:24
xAOD::MuonRoI_v1::setPhi
void setPhi(float v)
Set the azimuthal angle of the muon candidate.
xAOD::MuonRoI_v1::setRoIWord
void setRoIWord(uint32_t value)
Set the "raw" RoI word, describing the muon candidate.
SG_BASE
SG_BASE(xAOD::MuonRoI_v1, SG::AuxElement)
xAOD::MuonRoI_v1::thrName
const std::string & thrName() const
The name of the highest threshold value passed by the muon candidate.
xAOD::MuonRoI_v1::isRun3
bool isRun3() const
Returns extra flag at end of RoI word indicating that it's in Run3 format.
xAOD::MuonRoI_v1::isMoreCandInRoI
bool isMoreCandInRoI() const
Returns if there were other muons detected in the same RoI.
xAOD::MuonRoI_v1::isVetoed
bool isVetoed() const
Returns the veto flag for the candidate.
xAOD::MuonRoI_v1::setThrName
void setThrName(const std::string &value)
Set the name of the threshold passed by the muon candidate.
xAOD::MuonRoI_v1
Class describing a LVL1 muon region of interest.
Definition: MuonRoI_v1.h:33
xAOD::MuonRoI_v1::setThrValue
void setThrValue(float v)
Set the threshold value passed by the muon candidate.
xAOD::MuonRoI_v1::Undef
@ Undef
This is an RPC candidate.
Definition: MuonRoI_v1.h:51
xAOD::MuonRoI_v1::getRoI
int getRoI() const
Get the "RoI number" (position inside the sector)
xAOD::MuonRoI_v1::Charge
Charge
Charge sign.
Definition: MuonRoI_v1.h:48
xAOD::MuonRoI_v1::Barrel
@ Barrel
The muon candidate was detected in the barrel region.
Definition: MuonRoI_v1.h:38
xAOD::MuonRoI_v1::Negative
@ Negative
The candidate came from the -z side (side C)
Definition: MuonRoI_v1.h:45
xAOD::MuonRoI_v1::RoISource
RoISource
RoI source enumeration.
Definition: MuonRoI_v1.h:37
xAOD::MuonRoI_v1::isMoreCandInSector
bool isMoreCandInSector() const
Returns if there were other muons detected in the same sector.
python.PyAthena.v
v
Definition: PyAthena.py:157
xAOD::MuonRoI_v1::isFirstCandidate
bool isFirstCandidate() const
Returns if the candidate had the highest pT in the sector.
xAOD::MuonRoI_v1::Hemisphere
Hemisphere
RoI hemisphere enumeration.
Definition: MuonRoI_v1.h:43
xAOD::MuonRoI_v1::Forward
@ Forward
The muon candidate was detected in the forward region.
Definition: MuonRoI_v1.h:40
xAOD::MuonRoI_v1::getBW3Coincidence
bool getBW3Coincidence() const
Returns whether or not there was a 3-station coincidence in the TGC.
xAOD::MuonRoI_v1::getSectorID
int getSectorID() const
Get the sector ID number.
xAOD::MuonRoI_v1::getCharge
Charge getCharge() const
Returns the charge sign of the muon candidate.
xAOD::MuonRoI_v1::getSource
RoISource getSource() const
Returns the system that detected the muon candidate.
xAOD::MuonRoI_v1::setEta
void setEta(float v)
Set the pseudorapidity of the muon candidate.
xAOD::MuonRoI_v1::Pos
@ Pos
Candidate is a mu+ from a TGC sector.
Definition: MuonRoI_v1.h:50
xAOD::MuonRoI_v1::Positive
@ Positive
The candidate came from the +z side (side A)
Definition: MuonRoI_v1.h:44
xAOD::MuonRoI_v1::roiWord
uint32_t roiWord() const
The "raw" RoI word describing the muon candidate.
AuxElement.h
Base class for elements of a container that can have aux data.
xAOD::MuonRoI_v1::getEtaOverlap
bool getEtaOverlap() const
Returns whether there's overlap between the barrel-EC sectors.
xAOD::MuonRoI_v1::getGoodMF
bool getGoodMF() const
Returns whether or not there was a good magnetic field quality in the TGC.
xAOD::MuonRoI_v1::phi
float phi() const
The azimuthal angle ( ) of the muon candidate.