l1t::RegionalMuonCand Class Reference

#include <RegionalMuonCand.h>

Inheritance diagram for l1t::RegionalMuonCand:

Public Types
enum	bmtfAddress {   kWheelSide =0, kWheelNum =1, kStat1 =2, kStat2 =3,   kStat3 =4, kStat4 =5, kSegSelStat1 =6, kSegSelStat2 =7,   kSegSelStat3 =8, kSegSelStat4 =9, kNumBmtfSubAddr =10 }
enum	emtfAddress {   kME1Seg =0, kME1Ch =1, kME2Seg =2, kME2Ch =3,   kME3Seg =4, kME3Ch =5, kME4Seg =6, kME4Ch =7,   kTrkNum =8, kBX =9, kNumEmtfSubAddr =10 }

Public Member Functions
const uint64_t	dataword () const
	Get 64 bit data word. More...
const uint32_t	dataword32Lsb () const
	Get 32 LSBs of data word. More...
const uint32_t	dataword32Msb () const
	Get 32 MSBs of data word. More...
const int	hwEta () const
	Get compressed eta (returned int * 0.010875 = eta) More...
const int	hwHF () const
	Get HF (halo / fine eta) bit (EMTF: halo -> 1; BMTF: fine eta -> 1) More...
const int	hwPhi () const
	Get compressed local phi (returned int * 2*pi/576 = local phi in rad) More...
const int	hwPt () const
	Get compressed pT (returned int * 0.5 = pT (GeV)) More...
const int	hwQual () const
	Get quality code. More...
const int	hwSign () const
	Get charge sign bit (charge = (-1)^(sign)) More...
const int	hwSignValid () const
	Get charge sign valid bit (0 - not valid (high pT muon); 1 - valid) More...
const int	link () const
	Get link on which the MicroGMT receives the candidate. More...
const int	processor () const
	Get processor ID on which the candidate was found (0..5 for OMTF/EMTF; 0..11 for BMTF) More...
	RegionalMuonCand (uint64_t dataword)
	RegionalMuonCand ()
	RegionalMuonCand (int pt, int phi, int eta, int sign, int signvalid, int quality, int processor, tftype trackFinder)
void	setDataword (uint32_t msbs, uint32_t lsbs)
void	setDataword (uint64_t bits)
void	setHwEta (int bits)
	Set compressed eta as transmitted by hardware LSB = 0.010875 (9 bits) More...
void	setHwHF (bool bit)
	Set HF (halo / fine eta) bit (EMTF: halo -> 1; BMTF: fine eta -> 1) More...
void	setHwPhi (int bits)
	Set compressed relative phi as transmitted by hardware LSB = 2*pi/576 (8 bits) More...
void	setHwPt (int bits)
	Set compressed pT as transmitted by hardware LSB = 0.5 (9 bits) More...
void	setHwQual (int bits)
	Set compressed quality code as transmitted by hardware (4 bits) More...
void	setHwSign (int bits)
	Set charge sign bit (charge = (-1)^(sign)) More...
void	setHwSignValid (int bits)
	Set whether charge measurement is valid (0 for high pT muons) More...
void	setLink (int link)
void	setTFIdentifiers (int processor, tftype trackFinder)
	Set the processor ID, track-finder type. From these two, the link is set. More...
void	setTrackAddress (const std::map< int, int > &address)
	Set the whole track address. More...
void	setTrackSubAddress (bmtfAddress subAddress, int value)
	Set a part of the muon candidates track address; specialised for BMTF. More...
void	setTrackSubAddress (emtfAddress subAddress, int value)
	Set a part of the muon candidates track address; specialised for EMTF. More...
const std::map< int, int > &	trackAddress () const
	Get the track address (identifies track primitives used for reconstruction) More...
const tftype	trackFinderType () const
	Get track-finder which found the muon (bmtf, emtf_pos/emtf_neg or omtf_pos/omtf_neg) More...
int	trackSubAddress (bmtfAddress subAddress) const
	Get part of track address (identifies track primitives used for reconstruction) More...
int	trackSubAddress (emtfAddress subAddress) const
	Get part of track address (identifies track primitives used for reconstruction) More...
virtual	~RegionalMuonCand ()

Private Attributes
uint64_t	m_dataword
	This is the 64 bit word as transmitted in HW. More...
int	m_hwEta
bool	m_hwHF
int	m_hwPhi
int	m_hwPt
int	m_hwQuality
int	m_hwSign
int	m_hwSignValid
int	m_link
int	m_processor
std::map< int, int >	m_trackAddress
tftype	m_trackFinder

Detailed Description

Definition at line 8 of file RegionalMuonCand.h.

Member Enumeration Documentation

enum l1t::RegionalMuonCand::bmtfAddress

Enum to identify the individual parts of the BMTF track address Update kNumBmtfSubAddr if you add additional enums

Enumerator
kWheelSide
kWheelNum
kStat1
kStat2
kStat3
kStat4
kSegSelStat1
kSegSelStat2
kSegSelStat3
kSegSelStat4
kNumBmtfSubAddr

Definition at line 12 of file RegionalMuonCand.h.

                     {
        kWheelSide=0, kWheelNum=1, kStat1=2, kStat2=3, kStat3=4, kStat4=5, kSegSelStat1=6, kSegSelStat2=7, kSegSelStat3=8, kSegSelStat4=9, kNumBmtfSubAddr=10
    };

enum l1t::RegionalMuonCand::emtfAddress

Enum to identify the individual parts of the EMTF track address Update kNumEmtfSubAddr if you add additional enums

Enumerator
kME1Seg
kME1Ch
kME2Seg
kME2Ch
kME3Seg
kME3Ch
kME4Seg
kME4Ch
kTrkNum
kBX
kNumEmtfSubAddr

Definition at line 17 of file RegionalMuonCand.h.

                     {
    kME1Seg=0, kME1Ch=1, kME2Seg=2, kME2Ch=3, kME3Seg=4, kME3Ch=5, kME4Seg=6, kME4Ch=7, kTrkNum=8, kBX=9, kNumEmtfSubAddr=10
    };

Constructor & Destructor Documentation

l1t::RegionalMuonCand::RegionalMuonCand ( uint64_t  dataword )

explicit

l1t::RegionalMuonCand::RegionalMuonCand ( )

inline

Definition at line 24 of file RegionalMuonCand.h.

References l1t::bmtf, and setTFIdentifiers().

                       :
      m_hwPt(0), m_hwPhi(0), m_hwEta(0), m_hwHF(false), m_hwSign(0), m_hwSignValid(0), m_hwQuality(0), m_dataword(0)
      {
        setTFIdentifiers(0, bmtf);
      };

l1t::RegionalMuonCand::RegionalMuonCand ( int  pt, int  phi, int  eta, int  sign, int  signvalid, int  quality, int  processor, tftype  trackFinder  )

inline

Definition at line 30 of file RegionalMuonCand.h.

References setTFIdentifiers().

                                                                                                                        :
      m_hwPt(pt), m_hwPhi(phi), m_hwEta(eta), m_hwHF(false), m_hwSign(sign), m_hwSignValid(signvalid), m_hwQuality(quality),
      m_dataword(0)
      {
        setTFIdentifiers(processor, trackFinder);
      };

virtual l1t::RegionalMuonCand::~RegionalMuonCand ( )

inlinevirtual

Definition at line 37 of file RegionalMuonCand.h.

{};

Member Function Documentation

const uint64_t l1t::RegionalMuonCand::dataword ( ) const

inline

Get 64 bit data word.

Definition at line 96 of file RegionalMuonCand.h.

References m_dataword.

{ return m_dataword; };

const uint32_t l1t::RegionalMuonCand::dataword32Lsb ( ) const

inline

Get 32 LSBs of data word.

Definition at line 100 of file RegionalMuonCand.h.

References m_dataword.

{ return (uint32_t)(m_dataword & 0xFFFFFFFF); };

const uint32_t l1t::RegionalMuonCand::dataword32Msb ( ) const

inline

Get 32 MSBs of data word.

Definition at line 98 of file RegionalMuonCand.h.

References m_dataword.

{ return (uint32_t)((m_dataword >> 32) & 0xFFFFFFFF); };

const int l1t::RegionalMuonCand::hwEta ( ) const

inline

Get compressed eta (returned int * 0.010875 = eta)

Definition at line 80 of file RegionalMuonCand.h.

References m_hwEta.

Referenced by L1MuBMTrack::eta(), l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwEta(), L1MuBMTrack::print(), L1TMuonEndCapTrackProducer::produce(), L1MuBMTrackFinder::run(), l1t::stage2::RegionalMuonGMTUnpacker::unpack(), l1t::stage2::BMTFUnpackerOutput::unpack(), and XMLConfigWriter::writeCandMuon().

{ return m_hwEta; };

const int l1t::RegionalMuonCand::hwHF ( ) const

inline

Get HF (halo / fine eta) bit (EMTF: halo -> 1; BMTF: fine eta -> 1)

Definition at line 94 of file RegionalMuonCand.h.

References m_hwHF.

Referenced by L1MuBMTrack::fineEtaBit(), l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwHF(), and L1MuBMTrackFinder::run().

{ return m_hwHF; };

const int l1t::RegionalMuonCand::hwPhi ( ) const

inline

Get compressed local phi (returned int * 2*pi/576 = local phi in rad)

Definition at line 78 of file RegionalMuonCand.h.

References m_hwPhi.

Referenced by l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwLocalPhi(), L1MuBMTrack::phi(), L1MuBMTrack::print(), L1TMuonEndCapTrackProducer::produce(), L1MuBMTrackFinder::run(), l1t::stage2::RegionalMuonGMTUnpacker::unpack(), l1t::stage2::BMTFUnpackerOutput::unpack(), and XMLConfigWriter::writeCandMuon().

{ return m_hwPhi; };

const int l1t::RegionalMuonCand::hwPt ( ) const

inline

Get compressed pT (returned int * 0.5 = pT (GeV))

Definition at line 76 of file RegionalMuonCand.h.

References m_hwPt.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwPt(), L1MuBMTrack::print(), L1TMuonEndCapTrackProducer::produce(), L1MuBMTrack::pt(), l1t::stage2::RegionalMuonGMTUnpacker::unpack(), l1t::stage2::BMTFUnpackerOutput::unpack(), and XMLConfigWriter::writeCandMuon().

{ return m_hwPt; };

const int l1t::RegionalMuonCand::hwQual ( ) const

inline

Get quality code.

Definition at line 86 of file RegionalMuonCand.h.

References m_hwQuality.

Referenced by l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwQual(), L1MuBMTrack::print(), L1TMuonEndCapTrackProducer::produce(), L1MuBMTrack::quality(), L1MuBMTrackFinder::run(), l1t::stage2::RegionalMuonGMTUnpacker::unpack(), l1t::stage2::BMTFUnpackerOutput::unpack(), and XMLConfigWriter::writeCandMuon().

{ return m_hwQuality; };

const int l1t::RegionalMuonCand::hwSign ( ) const

inline

Get charge sign bit (charge = (-1)^(sign))

Definition at line 82 of file RegionalMuonCand.h.

References m_hwSign.

Referenced by L1MuBMTrack::charge(), l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwSign(), L1MuBMTrack::print(), L1MuBMTrackFinder::run(), l1t::stage2::RegionalMuonGMTUnpacker::unpack(), and XMLConfigWriter::writeCandMuon().

{ return m_hwSign; };

const int l1t::RegionalMuonCand::hwSignValid ( ) const

inline

Get charge sign valid bit (0 - not valid (high pT muon); 1 - valid)

Definition at line 84 of file RegionalMuonCand.h.

References m_hwSignValid.

Referenced by l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::hwSignValid(), L1MuBMTrackFinder::run(), l1t::stage2::RegionalMuonGMTUnpacker::unpack(), and XMLConfigWriter::writeCandMuon().

{ return m_hwSignValid; };

const int l1t::RegionalMuonCand::link ( ) const

inline

Get link on which the MicroGMT receives the candidate.

Definition at line 88 of file RegionalMuonCand.h.

References m_link.

Referenced by l1t::GMTInternalMuon::link(), setLink(), and XMLConfigWriter::writeCandMuon().

{ return m_link; };

const int l1t::RegionalMuonCand::processor ( ) const

inline

Get processor ID on which the candidate was found (0..5 for OMTF/EMTF; 0..11 for BMTF)

Definition at line 90 of file RegionalMuonCand.h.

References m_processor.

Referenced by L1TMicroGMTInputProducer::cmpProc(), L1TMicroGMTInputProducerFromGen::compareMuons(), l1t::GMTInternalMuon::processor(), setTFIdentifiers(), and XMLConfigWriter::writeCandMuon().

{ return m_processor; };

void l1t::RegionalMuonCand::setDataword ( uint32_t  msbs, uint32_t  lsbs  )

inline

Definition at line 58 of file RegionalMuonCand.h.

References m_dataword.

Referenced by l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand().

{ m_dataword = (((uint64_t)msbs) << 32) + lsbs; };

void l1t::RegionalMuonCand::setDataword ( uint64_t  bits )

inline

Definition at line 60 of file RegionalMuonCand.h.

References bits, and m_dataword.

{ m_dataword = bits; };

void l1t::RegionalMuonCand::setHwEta ( int  bits )

inline

Set compressed eta as transmitted by hardware LSB = 0.010875 (9 bits)

Definition at line 44 of file RegionalMuonCand.h.

References bits, and m_hwEta.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), MakeRegionalCand(), L1TBMTFConverter::produce(), L1MuBMTrackFinder::run(), L1MuBMTrack::setEta(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

{ m_hwEta = bits; };

void l1t::RegionalMuonCand::setHwHF ( bool  bit )

inline

Set HF (halo / fine eta) bit (EMTF: halo -> 1; BMTF: fine eta -> 1)

Definition at line 52 of file RegionalMuonCand.h.

References m_hwHF.

Referenced by l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), L1MuBMTrackFinder::run(), L1MuBMTrack::setEta(), and L1MuBMTrack::setFineEtaBit().

{ m_hwHF = bit; };

void l1t::RegionalMuonCand::setHwPhi ( int  bits )

inline

Set compressed relative phi as transmitted by hardware LSB = 2*pi/576 (8 bits)

Definition at line 42 of file RegionalMuonCand.h.

References bits, and m_hwPhi.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), MakeRegionalCand(), L1MuBMTrackFinder::run(), L1MuBMTrack::setPhi(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

{ m_hwPhi = bits; };

void l1t::RegionalMuonCand::setHwPt ( int  bits )

inline

Set compressed pT as transmitted by hardware LSB = 0.5 (9 bits)

Definition at line 40 of file RegionalMuonCand.h.

References bits, and m_hwPt.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), MakeRegionalCand(), L1MuBMTrackFinder::run(), L1MuBMTrack::setPt(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

{ m_hwPt = bits; };

void l1t::RegionalMuonCand::setHwQual ( int  bits )

inline

Set compressed quality code as transmitted by hardware (4 bits)

Definition at line 50 of file RegionalMuonCand.h.

References bits, and m_hwQuality.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), MakeRegionalCand(), L1TMuonQualityAdjuster::produce(), L1MuBMTrackFinder::run(), L1MuBMTrack::setQuality(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

{ m_hwQuality = bits; };

void l1t::RegionalMuonCand::setHwSign ( int  bits )

inline

Set charge sign bit (charge = (-1)^(sign))

Definition at line 46 of file RegionalMuonCand.h.

References bits, and m_hwSign.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), MakeRegionalCand(), L1MuBMTrackFinder::run(), L1MuBMTrack::setCharge(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

{ m_hwSign = bits; };

void l1t::RegionalMuonCand::setHwSignValid ( int  bits )

inline

Set whether charge measurement is valid (0 for high pT muons)

Definition at line 48 of file RegionalMuonCand.h.

References bits, and m_hwSignValid.

Referenced by OMTFSorter::candidates(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), L1MuBMTrack::L1MuBMTrack(), MakeRegionalCand(), L1MuBMTrackFinder::run(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

{ m_hwSignValid = bits; };

void l1t::RegionalMuonCand::setLink ( int  link )

inline

Definition at line 56 of file RegionalMuonCand.h.

References link(), and m_link.

Referenced by l1t::stage2::BMTFUnpackerOutput::unpack().

{m_link = link; };

void l1t::RegionalMuonCand::setTFIdentifiers	(	int	processor,
		tftype	trackFinder
	)

Set the processor ID, track-finder type. From these two, the link is set.

Definition at line 6 of file RegionalMuonCand.cc.

References l1t::bmtf, l1t::emtf_neg, l1t::emtf_pos, m_link, m_processor, m_trackFinder, l1t::omtf_neg, l1t::omtf_pos, and processor().

Referenced by OMTFSorter::candidates(), L1MuBMTrack::enable(), l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), MakeRegionalCand(), RegionalMuonCand(), L1MuBMTrackFinder::run(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

                                                                    {
  m_trackFinder = trackFinder;
  m_processor = processor;

  switch (m_trackFinder) {
    case tftype::emtf_pos:
      m_link = m_processor + 36;  // range 36...41
      break;
    case tftype::omtf_pos:
      m_link = m_processor + 42;  // range 42...47
      break;
    case tftype::bmtf:
      m_link = m_processor + 48;  // range 48...59
      break;
    case tftype::omtf_neg:
      m_link = m_processor + 60;  // range 60...65
      break;
    case tftype::emtf_neg:
      m_link = m_processor + 66;  // range 66...71
  }
}

void l1t::RegionalMuonCand::setTrackAddress ( const std::map< int, int > &  address )

inline

Set the whole track address.

Definition at line 70 of file RegionalMuonCand.h.

References m_trackAddress.

Referenced by OMTFSorter::candidates(), and l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand().

                                                          {
        m_trackAddress = address;
    }

void l1t::RegionalMuonCand::setTrackSubAddress ( bmtfAddress  subAddress, int  value  )

inline

Set a part of the muon candidates track address; specialised for BMTF.

Definition at line 62 of file RegionalMuonCand.h.

References m_trackAddress, and relativeConstraints::value.

Referenced by l1t::RegionalMuonRawDigiTranslator::fillRegionalMuonCand(), L1MuBMTrackFinder::run(), and l1t::stage2::emtf::SPBlockUnpacker::unpack().

                                                               {
        m_trackAddress[subAddress] = value;
    }

void l1t::RegionalMuonCand::setTrackSubAddress ( emtfAddress  subAddress, int  value  )

inline

Set a part of the muon candidates track address; specialised for EMTF.

Definition at line 66 of file RegionalMuonCand.h.

References m_trackAddress, and relativeConstraints::value.

                                                               {
        m_trackAddress[subAddress] = value;
    }

const std::map<int, int>& l1t::RegionalMuonCand::trackAddress ( ) const

inline

Get the track address (identifies track primitives used for reconstruction)

Definition at line 102 of file RegionalMuonCand.h.

References m_trackAddress.

Referenced by l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), and XMLConfigWriter::writeCandMuon().

                                                 {
        return m_trackAddress;
    }

const tftype l1t::RegionalMuonCand::trackFinderType ( ) const

inline

Get track-finder which found the muon (bmtf, emtf_pos/emtf_neg or omtf_pos/omtf_neg)

Definition at line 92 of file RegionalMuonCand.h.

References m_trackFinder.

Referenced by l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords(), l1t::GMTInternalMuon::trackFinderType(), and XMLConfigWriter::writeCandMuon().

{ return m_trackFinder; };

int l1t::RegionalMuonCand::trackSubAddress ( bmtfAddress  subAddress ) const

inline

Get part of track address (identifies track primitives used for reconstruction)

Definition at line 106 of file RegionalMuonCand.h.

References m_trackAddress.

Referenced by l1t::RegionalMuonRawDigiTranslator::generatePackedDataWords().

                                                      {
        return m_trackAddress.at(subAddress);
    }

int l1t::RegionalMuonCand::trackSubAddress ( emtfAddress  subAddress ) const

inline

Get part of track address (identifies track primitives used for reconstruction)

Definition at line 110 of file RegionalMuonCand.h.

References m_trackAddress.

                                                      {
        return m_trackAddress.at(subAddress);
    }

Member Data Documentation

uint64_t l1t::RegionalMuonCand::m_dataword

private

This is the 64 bit word as transmitted in HW.

Definition at line 129 of file RegionalMuonCand.h.

Referenced by dataword(), dataword32Lsb(), dataword32Msb(), and setDataword().

int l1t::RegionalMuonCand::m_hwEta

private

Definition at line 118 of file RegionalMuonCand.h.

Referenced by hwEta(), and setHwEta().

bool l1t::RegionalMuonCand::m_hwHF

private

Definition at line 119 of file RegionalMuonCand.h.

Referenced by hwHF(), and setHwHF().

int l1t::RegionalMuonCand::m_hwPhi

private

Definition at line 117 of file RegionalMuonCand.h.

Referenced by hwPhi(), and setHwPhi().

int l1t::RegionalMuonCand::m_hwPt

private

Definition at line 116 of file RegionalMuonCand.h.

Referenced by hwPt(), and setHwPt().

int l1t::RegionalMuonCand::m_hwQuality

private

Definition at line 122 of file RegionalMuonCand.h.

Referenced by hwQual(), and setHwQual().

int l1t::RegionalMuonCand::m_hwSign

private

Definition at line 120 of file RegionalMuonCand.h.

Referenced by hwSign(), and setHwSign().

int l1t::RegionalMuonCand::m_hwSignValid

private

Definition at line 121 of file RegionalMuonCand.h.

Referenced by hwSignValid(), and setHwSignValid().

int l1t::RegionalMuonCand::m_link

private

Definition at line 123 of file RegionalMuonCand.h.

Referenced by link(), setLink(), and setTFIdentifiers().

int l1t::RegionalMuonCand::m_processor

private

Definition at line 124 of file RegionalMuonCand.h.

Referenced by processor(), and setTFIdentifiers().

std::map<int, int> l1t::RegionalMuonCand::m_trackAddress

private

Definition at line 126 of file RegionalMuonCand.h.

Referenced by setTrackAddress(), setTrackSubAddress(), trackAddress(), and trackSubAddress().

tftype l1t::RegionalMuonCand::m_trackFinder

private

Definition at line 125 of file RegionalMuonCand.h.

Referenced by setTFIdentifiers(), and trackFinderType().