xAOD::MuonRoI_v1 Class Reference

#include <MuonRoI_v1.h>

Inheritance diagram for xAOD::MuonRoI_v1:
SG::AuxElement SG::IAuxElement

List of all members.

Public Types

enum  RoISource { Barrel, Endcap, Forward }
 

RoI source enumeration.

More...
enum  Hemisphere { Positive, Negative }
 

RoI hemisphere enumeration.

More...
enum  Charge { Neg = 0, Pos = 1, Undef = 100 }
 

Charge sign.

More...

Public Member Functions

 MuonRoI_v1 ()
 Default constructor.
void initialize (uint32_t roiword, float eta, float phi, const std::string &thrname, float thrvalue)
 Initialise the object with all its properties.
Independent properties stored for the muon candidate



float eta () const
 The pseudorapidity ($\eta$) of the muon candidate.
void setEta (float v)
 Set the pseudorapidity of the muon candidate.
float phi () const
 The azimuthal angle ($\phi$) of the muon candidate.
void setPhi (float v)
 Set the azimuthal angle of the muon candidate.
uint32_t roiWord () const
 The "raw" RoI word describing the muon candidate.
void setRoIWord (uint32_t value)
 Set the "raw" RoI word, describing the muon candidate.
float thrValue () const
 The highest threshold value (in MeV) passed by the muon candidate.
void setThrValue (float v)
 Set the threshold value passed by the muon candidate.
const std::string & thrName () const
 The name of the highest threshold value passed by the muon candidate.
void setThrName (const std::string &value)
 Set the name of the threshold passed by the muon candidate.
Properties extracted from the 32-bit muon RoI word



int getThrNumber () const
 Get the logic number of the highest threshold this RoI passed.
int getRoI () const
 Get the "RoI number" (position inside the sector).
int getSectorAddress () const
 Get the full sector address.
bool isFirstCandidate () const
 Returns if the candidate had the highest pT in the sector.
bool isMoreCandInRoI () const
 Returns if there were other muons detected in the same RoI.
bool isMoreCandInSector () const
 Returns if there were other muons detected in the same sector.
RoISource getSource () const
 Returns the system that detected the muon candidate.
Hemisphere getHemisphere () const
 Returns the hemisphere that detected the muon candidate.
Charge getCharge () const
 Returns the charge sign of the muon candidate.
bool isVetoed () const
 Returns the veto flag for the candidate.

Detailed Description

Class describing a LVL1 muon region of interest

This class describes all the properties of a muon region of interest (RoI) in the xAOD format.

Author:
Lukas Heinrich <Lukas.Heinrich@cern.ch>
Attila Krasznahorkay <Attila.Krasznahorkay@cern.ch>
Revision
631149
Date
2014-11-26 13:26:18 +0100 (Wed, 26 Nov 2014)

Member Enumeration Documentation

Charge sign.

Enumerator:
Neg 

Candidate is a mu- from a TGC sector.

Pos 

Candidate is a mu+ from a TGC sector.

Undef 

This is an RPC candidate.

RoI hemisphere enumeration.

Enumerator:
Positive 

The candidate came from the +z side (side A).

Negative 

The candidate came from the -z side (side C).

RoI source enumeration.

Enumerator:
Barrel 

The muon candidate was detected in the barrel region.

Endcap 

The muon candidate was detected in the endcap region.

Forward 

The muon candidate was detected in the forward region.


Member Function Documentation

MuonRoI_v1::Charge xAOD::MuonRoI_v1::getCharge (  )  const

Returns the charge sign of the muon candidate.

Endcap and forward sectors can tell you what was the charge of the muon candidate. Barrel candidates can't do this.

See also:
MuonRoI_v1::RoISource
MuonRoI_v1::getSource()
MuonRoI_v1::Hemisphere xAOD::MuonRoI_v1::getHemisphere (  )  const

Returns the hemisphere that detected the muon candidate.

The function decodes the sector hemisphere encoded in the 8-bit sector address into an easy to understand enumeration.

See also:
MuonRoI_v1::getSectorAddress()
MuonRoI_v1::Hemisphere
int xAOD::MuonRoI_v1::getRoI (  )  const

Get the "RoI number" (position inside the sector).

A muon's spacial location is identified from the sector number and the hemisphere that detected it. Each sector is additionally divided into multiple areas, called RoIs that tell you which part of the sector the muon candidate was detected in.

Returns:
Integer number smaller than 147
int xAOD::MuonRoI_v1::getSectorAddress (  )  const

Get the full sector address.

The sector address is an 8-bit identifier of the sector. For its detailed description, see page 38 of https://edms.cern.ch/file/248757/1/mirod.pdf

The least significant bit shown which hemisphere the sector is in (0: positive side, 1: negative side), the upper (1 or 2) bits show what kind of sector it is, the rest of the address is the number of the sector.

Returns:
An 8-bit identifier
MuonRoI_v1::RoISource xAOD::MuonRoI_v1::getSource (  )  const

Returns the system that detected the muon candidate.

The function decodes the sector type encoded in the 8-bit sector address into an easy to understand enumeration.

See also:
MuonRoI_v1::getSectorAddress()
MuonRoI_v1::RoISource
void xAOD::MuonRoI_v1::initialize ( uint32_t  roiword,
float  eta,
float  phi,
const std::string &  thrname,
float  thrvalue 
)

Initialise the object with all its properties.

It's just a convenience function, forwarding the call to all the individual property setter functions.

Parameters:
roiword The 32-bit RoI word coming from the MuCTPI
eta The pseudorapidity of the candidate
phi The aximuthal angle of the candidate
thrname The name of the highest threshold passed by the candidate
thrvalue The value (in MeV) of the threshold passed
bool xAOD::MuonRoI_v1::isFirstCandidate (  )  const

Returns if the candidate had the highest pT in the sector.

Each muon trigger sector can only send information about a maximum of two LVL1 muon candidate to the central trigger. If this flag is true, this candidate had the highest pT threshold assigned to it in its sector. If it's false, it was the second candidate in its sector.

bool xAOD::MuonRoI_v1::isMoreCandInRoI (  )  const

Returns if there were other muons detected in the same RoI.

One RoI (one part of the trigger sector) can only send information about one LVL1 muon candidate to the central trigger. This flag is true if the particular RoI that detected this muon candidate also detected another candidate with lower pT.

bool xAOD::MuonRoI_v1::isMoreCandInSector (  )  const

Returns if there were other muons detected in the same sector.

This flag is set to true if the sector that this muon candidate came from, detected more than 2 LVL1 muon candidates.

See also:
MuonRoI_v1::isFirstCandidate()
bool xAOD::MuonRoI_v1::isVetoed (  )  const

Returns the veto flag for the candidate.

When the overlap handling is activated in the MuCTPI, candidates can be ignored in the multiplicity sum sent to the CTP. This flag tells you whether this particular candidate was ignored in the multiplicity sum.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 1 Dec 2017 for RootCore Packages by  doxygen 1.6.1