Muon::MuPatCandidateBase Class Reference

track candidate entry object. More...

#include <MuPatCandidateBase.h>

Inheritance diagram for Muon::MuPatCandidateBase:

Collaboration diagram for Muon::MuPatCandidateBase:

Public Types
using	MeasVec = std::vector< const Trk::MeasurementBase * >

Public Member Functions
	MuPatCandidateBase ()=default
	constructor. More...
	MuPatCandidateBase (const MeasVec &etaHits, const MeasVec &phiHits, const MeasVec &fakePhiHits, const MeasVec &allHits)
	constructor. More...
virtual	~MuPatCandidateBase ()=default
	destructor. More...
const MeasVec &	etaHits () const
	return all eta hits on the entry More...
const MeasVec &	phiHits () const
	return all phi hits on the entry More...
const MeasVec &	fakePhiHits () const
	return all fake phi hits on the entry More...
const MeasVec &	hits () const
	return all hits on the entry. More...
bool	hasSmallChamber () const
	returns whether entry contains a small chamber More...
bool	hasLargeChamber () const
	returns whether entry contains a small chamber More...
bool	hasSLOverlap () const
	returns whether there is at least one small/large overlap in the same station layer More...
virtual const Trk::TrackParameters &	entryPars () const =0
	return track parameters representing the entry More...
bool	hasEndcap () const
	returns whether the entry contains endcap hits More...
void	hasEndcap (bool hasEC)
	set whether entry has endcap hits More...
bool	hasMomentum () const
	returns whether entry has a momentum measurement More...
const std::set< MuonStationIndex::StIndex > &	stations () const
	returns set with contained stationIndices More...
const std::set< MuonStationIndex::ChIndex > &	chambers () const
	returns set with contained chamberIndices More...
bool	containsChamber (MuonStationIndex::ChIndex chIndex) const
	returns whether the ChamberIndex is already contained in candidate More...
bool	containsStation (MuonStationIndex::StIndex chIndex) const
	returns whether the StationIndex is already contained in candidate More...
const MuPatHitList &	hitList () const
	returns a reference to the hit list More...
const std::set< Identifier > &	chamberIds () const
	returns set with contained chamber ids More...
bool	shareChambers (const MuPatCandidateBase &entry) const
	checks whether the two entries contain the same chamber More...
void	addToTrash (std::unique_ptr< const Trk::MeasurementBase > meas)
	adds the measurement to the garbage container. More...
void	addToTrash (const std::vector< std::shared_ptr< const Trk::MeasurementBase >> &measurements)
const std::vector< std::shared_ptr< const Trk::MeasurementBase > > &	garbage () const

Public Attributes
unsigned int	nmdtHitsMl1 {0}
	public hit counters More...
unsigned int	nmdtHitsMl2 {0}
unsigned int	ncscHitsEta {0}
unsigned int	ncscHitsPhi {0}
unsigned int	nrpcHitsEta {0}
unsigned int	nrpcHitsPhi {0}
unsigned int	ntgcHitsEta {0}
unsigned int	ntgcHitsPhi {0}

Protected Member Functions
void	hasSLOverlap (bool hasSL)
	set whether entry has at least one small/large overlap in the same station layer More...
void	hasSmallChamber (bool hasSmall)
	set whether entry has small chamber More...
void	hasLargeChamber (bool hasLarge)
	set whether entry has large chamber More...
void	setEtaHits (const MeasVec &hits)
	set eta hits on the entry More...
void	setPhiHits (const MeasVec &hits)
	set phi hits on the entry More...
void	setFakePhiHits (const MeasVec &hits)
	set fake phi hits on the entry More...
void	setAllHits (const MeasVec &hits)
	set all hits on the entry More...
MuPatHitList &	hitList ()
	returns a reference to the hit list More...
std::set< Identifier > &	chamberIds ()
	returns set with contained chamber ids More...
void	clearChambers ()
	clear the list of contained chambers. More...
void	addChamber (MuonStationIndex::ChIndex chIndex)
	add the chamber to the list of contained chambers. More...
void	setChambers (const std::set< MuonStationIndex::ChIndex > &chambers)
	Set the list of chambers and update list of stations. More...

Protected Attributes
std::set< MuonStationIndex::ChIndex >	m_chambers
std::set< MuonStationIndex::StIndex >	m_stations
bool	m_hasMomentum {false}

Private Attributes
MeasVec	m_etaHits
MeasVec	m_phiHits
MeasVec	m_fakePhiHits
MeasVec	m_allHits
MuPatHitList	m_hitList
std::set< Identifier >	m_chamberIds
bool	m_hasEndcap {false}
bool	m_hasSmallChamber {false}
bool	m_hasLargeChamber {false}
bool	m_hasSLOverlap {false}
std::vector< std::shared_ptr< const Trk::MeasurementBase > >	m_garbage {}

Friends
class	MuPatCandidateTool

Detailed Description

track candidate entry object.

The purpose of the class is to provide a common interface for tracks and segments. It give access to:

• the eta hits
• the phi hits
• the fake phi hits (PseudoMeasurements)
• the all hits
• the MuPatHitList (order listed used to sort the hits)
• a set with hamber Identifier on the track
• a set of chamber layers on the track
• a set of station layers on the track
• a flag whether the track/segment has a measured momentum
• number of mdt hits in the first multi layer
• number of mdt hits in the second multi layer
• number of csc eta hits
• number of csc phi hits
• number of rpc eta hits
• number of rpc phi hits
• number of tgc eta hits
• number of tgc phi hits
• a flag whether the candidate has endcap hits
• a flag whether the candidate has small chambers
• a flag whether the candidate has large chambers
• a flag whether the candidate has a small/large overlap

Definition at line 46 of file MuPatCandidateBase.h.

Member Typedef Documentation

MeasVec

using Muon::MuPatCandidateBase::MeasVec = std::vector<const Trk::MeasurementBase*>

Definition at line 50 of file MuPatCandidateBase.h.

Constructor & Destructor Documentation

MuPatCandidateBase() [1/2]

Muon::MuPatCandidateBase::MuPatCandidateBase ( )

default

constructor.

MuPatCandidateBase() [2/2]

Muon::MuPatCandidateBase::MuPatCandidateBase	(	const MeasVec &	etaHits,
		const MeasVec &	phiHits,
		const MeasVec &	fakePhiHits,
		const MeasVec &	allHits
	)

constructor.

The constructor takes ownership of the entryPars but not of the hits.

Definition at line 10 of file MuPatCandidateBase.cxx.

                                                                   :
        m_etaHits(etaHits), m_phiHits(phiHits), m_fakePhiHits(fakePhiHits), m_allHits(allHits) {}

~MuPatCandidateBase()

virtual Muon::MuPatCandidateBase::~MuPatCandidateBase ( )

virtualdefault

destructor.

Member Function Documentation

addChamber()

void Muon::MuPatCandidateBase::addChamber ( MuonStationIndex::ChIndex  chIndex )

protected

add the chamber to the list of contained chambers.

Will also add the corresponding station.

Definition at line 38 of file MuPatCandidateBase.cxx.

                                                                       {
        m_chambers.insert(chIndex);
        m_stations.insert(MuonStationIndex::toStationIndex(chIndex));
    }

addToTrash() [1/2]

void Muon::MuPatCandidateBase::addToTrash

(

const std::vector< std::shared_ptr< const Trk::MeasurementBase >> &

measurements

)

Definition at line 92 of file MuPatCandidateBase.cxx.

                                                                                                              {
        if (m_garbage.capacity() < measurements.size() + m_garbage.size()){
            m_garbage.reserve(measurements.size() + m_garbage.size());
        }
        m_garbage.insert(m_garbage.end(), measurements.begin(), measurements.end());
    }

addToTrash() [2/2]

void Muon::MuPatCandidateBase::addToTrash

(

std::unique_ptr< const Trk::MeasurementBase >

meas

)

adds the measurement to the garbage container.

Definition at line 91 of file MuPatCandidateBase.cxx.

{m_garbage.push_back(std::move(meas));}

chamberIds() [1/2]

std::set< Identifier > & Muon::MuPatCandidateBase::chamberIds ( )

protected

returns set with contained chamber ids

Definition at line 36 of file MuPatCandidateBase.cxx.

{ return m_chamberIds; }

chamberIds() [2/2]

const std::set< Identifier > & Muon::MuPatCandidateBase::chamberIds

(

)

const

returns set with contained chamber ids

Definition at line 33 of file MuPatCandidateBase.cxx.

{ return m_chamberIds; }

chambers()

const std::set< MuonStationIndex::ChIndex > & Muon::MuPatCandidateBase::chambers

(

)

const

returns set with contained chamberIndices

Definition at line 31 of file MuPatCandidateBase.cxx.

{ return m_chambers; }

clearChambers()

void Muon::MuPatCandidateBase::clearChambers ( )

protected

clear the list of contained chambers.

Will also clear the list of contained stations and list of chamber Ids.

Definition at line 83 of file MuPatCandidateBase.cxx.

                                           {
        m_chambers.clear();
        m_stations.clear();
        m_chamberIds.clear();
    }

containsChamber()

bool Muon::MuPatCandidateBase::containsChamber

(

MuonStationIndex::ChIndex

chIndex

)

const

returns whether the ChamberIndex is already contained in candidate

Definition at line 75 of file MuPatCandidateBase.cxx.

                                                                                  {
        return m_chambers.find(chIndex) != m_chambers.end();
    }

containsStation()

bool Muon::MuPatCandidateBase::containsStation

(

MuonStationIndex::StIndex

chIndex

)

const

returns whether the StationIndex is already contained in candidate

Definition at line 79 of file MuPatCandidateBase.cxx.

                                                                                  {
        return m_stations.find(stIndex) != m_stations.end();
    }

entryPars()

virtual const Trk::TrackParameters& Muon::MuPatCandidateBase::entryPars ( ) const

pure virtual

return track parameters representing the entry

Implemented in Muon::MuPatTrack, and Muon::MuPatSegment.

etaHits()

const MeasVec& Muon::MuPatCandidateBase::etaHits

(

)

const

return all eta hits on the entry

fakePhiHits()

const MuPatCandidateBase::MeasVec & Muon::MuPatCandidateBase::fakePhiHits

(

)

const

return all fake phi hits on the entry

Definition at line 59 of file MuPatCandidateBase.cxx.

{ return m_fakePhiHits; }

garbage()

const std::vector< std::shared_ptr< const Trk::MeasurementBase > > & Muon::MuPatCandidateBase::garbage

(

)

const

Definition at line 98 of file MuPatCandidateBase.cxx.

{return m_garbage;}

hasEndcap() [1/2]

bool Muon::MuPatCandidateBase::hasEndcap

(

)

const

returns whether the entry contains endcap hits

Definition at line 71 of file MuPatCandidateBase.cxx.

{ return m_hasEndcap; }

hasEndcap() [2/2]

void Muon::MuPatCandidateBase::hasEndcap

(

bool

hasEC

)

set whether entry has endcap hits

Definition at line 73 of file MuPatCandidateBase.cxx.

{ m_hasEndcap = hasEC; }

hasLargeChamber() [1/2]

bool Muon::MuPatCandidateBase::hasLargeChamber

(

)

const

returns whether entry contains a small chamber

Definition at line 45 of file MuPatCandidateBase.cxx.

{ return m_hasLargeChamber; }

hasLargeChamber() [2/2]

void Muon::MuPatCandidateBase::hasLargeChamber ( bool  hasLarge )

protected

set whether entry has large chamber

Definition at line 51 of file MuPatCandidateBase.cxx.

{ m_hasLargeChamber = hasLarge; }

hasMomentum()

bool Muon::MuPatCandidateBase::hasMomentum

(

)

const

returns whether entry has a momentum measurement

Definition at line 89 of file MuPatCandidateBase.cxx.

{ return m_hasMomentum; }

hasSLOverlap() [1/2]

bool Muon::MuPatCandidateBase::hasSLOverlap

(

)

const

returns whether there is at least one small/large overlap in the same station layer

Definition at line 47 of file MuPatCandidateBase.cxx.

{ return m_hasSLOverlap; }

hasSLOverlap() [2/2]

void Muon::MuPatCandidateBase::hasSLOverlap ( bool  hasSL )

protected

set whether entry has at least one small/large overlap in the same station layer

Definition at line 53 of file MuPatCandidateBase.cxx.

{ m_hasSLOverlap = hasSL; }

hasSmallChamber() [1/2]

bool Muon::MuPatCandidateBase::hasSmallChamber

(

)

const

returns whether entry contains a small chamber

Definition at line 43 of file MuPatCandidateBase.cxx.

{ return m_hasSmallChamber; }

hasSmallChamber() [2/2]

void Muon::MuPatCandidateBase::hasSmallChamber ( bool  hasSmall )

protected

set whether entry has small chamber

Definition at line 49 of file MuPatCandidateBase.cxx.

{ m_hasSmallChamber = hasSmall; }

hitList() [1/2]

MuPatHitList& Muon::MuPatCandidateBase::hitList ( )

inlineprotected

returns a reference to the hit list

Definition at line 145 of file MuPatCandidateBase.h.

{ return m_hitList; }

hitList() [2/2]

const MuPatHitList& Muon::MuPatCandidateBase::hitList ( ) const

inline

returns a reference to the hit list

Definition at line 108 of file MuPatCandidateBase.h.

{ return m_hitList; }

hits()

const MuPatCandidateBase::MeasVec & Muon::MuPatCandidateBase::hits

(

)

const

return all hits on the entry.

(Does not including the fake phi hits)

Definition at line 61 of file MuPatCandidateBase.cxx.

{ return m_allHits; }

phiHits()

const MuPatCandidateBase::MeasVec & Muon::MuPatCandidateBase::phiHits

(

)

const

return all phi hits on the entry

Definition at line 57 of file MuPatCandidateBase.cxx.

{ return m_phiHits; }

setAllHits()

void Muon::MuPatCandidateBase::setAllHits ( const MeasVec &  hits )

protected

set all hits on the entry

Definition at line 69 of file MuPatCandidateBase.cxx.

{ m_allHits = hits; }

setChambers()

void Muon::MuPatCandidateBase::setChambers ( const std::set< MuonStationIndex::ChIndex > &  chambers )

protected

Set the list of chambers and update list of stations.

Definition at line 14 of file MuPatCandidateBase.cxx.

                                                                                        {
        m_chambers = chambers;
        m_stations.clear();
        for (const MuonStationIndex::ChIndex it : chambers) m_stations.insert(MuonStationIndex::toStationIndex(it));
    }

setEtaHits()

void Muon::MuPatCandidateBase::setEtaHits ( const MeasVec &  hits )

protected

set eta hits on the entry

Definition at line 63 of file MuPatCandidateBase.cxx.

{ m_etaHits = hits; }

setFakePhiHits()

void Muon::MuPatCandidateBase::setFakePhiHits ( const MeasVec &  hits )

protected

set fake phi hits on the entry

Definition at line 67 of file MuPatCandidateBase.cxx.

{ m_fakePhiHits = hits; }

setPhiHits()

void Muon::MuPatCandidateBase::setPhiHits ( const MeasVec &  hits )

protected

set phi hits on the entry

Definition at line 65 of file MuPatCandidateBase.cxx.

{ m_phiHits = hits; }

shareChambers()

bool Muon::MuPatCandidateBase::shareChambers

(

const MuPatCandidateBase &

entry

)

const

checks whether the two entries contain the same chamber

Definition at line 20 of file MuPatCandidateBase.cxx.

                                                                                {
        std::vector<Identifier> intersection;
        std::set_intersection(entry.chamberIds().begin(), entry.chamberIds().end(), chamberIds().begin(), chamberIds().end(),
                              std::back_inserter(intersection));
 
        unsigned int intersectionSize = intersection.size();
        return intersectionSize != 0;
    }

stations()

const std::set< MuonStationIndex::StIndex > & Muon::MuPatCandidateBase::stations

(

)

const

returns set with contained stationIndices

Definition at line 29 of file MuPatCandidateBase.cxx.

{ return m_stations; }

Friends And Related Function Documentation

MuPatCandidateTool

friend class MuPatCandidateTool

friend

Definition at line 47 of file MuPatCandidateBase.h.

Member Data Documentation

m_allHits

MeasVec Muon::MuPatCandidateBase::m_allHits

private

Definition at line 163 of file MuPatCandidateBase.h.

m_chamberIds

std::set<Identifier> Muon::MuPatCandidateBase::m_chamberIds

private

Definition at line 167 of file MuPatCandidateBase.h.

m_chambers

std::set<MuonStationIndex::ChIndex> Muon::MuPatCandidateBase::m_chambers

protected

Definition at line 170 of file MuPatCandidateBase.h.

m_etaHits

MeasVec Muon::MuPatCandidateBase::m_etaHits

private

Definition at line 160 of file MuPatCandidateBase.h.

m_fakePhiHits

MeasVec Muon::MuPatCandidateBase::m_fakePhiHits

private

Definition at line 162 of file MuPatCandidateBase.h.

m_garbage

std::vector<std::shared_ptr<const Trk::MeasurementBase> > Muon::MuPatCandidateBase::m_garbage {}

private

Definition at line 191 of file MuPatCandidateBase.h.

m_hasEndcap

bool Muon::MuPatCandidateBase::m_hasEndcap {false}

private

Definition at line 186 of file MuPatCandidateBase.h.

m_hasLargeChamber

bool Muon::MuPatCandidateBase::m_hasLargeChamber {false}

private

Definition at line 188 of file MuPatCandidateBase.h.

m_hasMomentum

bool Muon::MuPatCandidateBase::m_hasMomentum {false}

protected

Definition at line 172 of file MuPatCandidateBase.h.

m_hasSLOverlap

bool Muon::MuPatCandidateBase::m_hasSLOverlap {false}

private

Definition at line 189 of file MuPatCandidateBase.h.

m_hasSmallChamber

bool Muon::MuPatCandidateBase::m_hasSmallChamber {false}

private

Definition at line 187 of file MuPatCandidateBase.h.

m_hitList

MuPatHitList Muon::MuPatCandidateBase::m_hitList

private

Definition at line 165 of file MuPatCandidateBase.h.

m_phiHits

MeasVec Muon::MuPatCandidateBase::m_phiHits

private

Definition at line 161 of file MuPatCandidateBase.h.

m_stations

std::set<MuonStationIndex::StIndex> Muon::MuPatCandidateBase::m_stations

protected

Definition at line 171 of file MuPatCandidateBase.h.

ncscHitsEta

unsigned int Muon::MuPatCandidateBase::ncscHitsEta {0}

Definition at line 178 of file MuPatCandidateBase.h.

ncscHitsPhi

unsigned int Muon::MuPatCandidateBase::ncscHitsPhi {0}

Definition at line 179 of file MuPatCandidateBase.h.

nmdtHitsMl1

unsigned int Muon::MuPatCandidateBase::nmdtHitsMl1 {0}

public hit counters

Definition at line 176 of file MuPatCandidateBase.h.

nmdtHitsMl2

unsigned int Muon::MuPatCandidateBase::nmdtHitsMl2 {0}

Definition at line 177 of file MuPatCandidateBase.h.

nrpcHitsEta

unsigned int Muon::MuPatCandidateBase::nrpcHitsEta {0}

Definition at line 180 of file MuPatCandidateBase.h.

nrpcHitsPhi

unsigned int Muon::MuPatCandidateBase::nrpcHitsPhi {0}

Definition at line 181 of file MuPatCandidateBase.h.

ntgcHitsEta

unsigned int Muon::MuPatCandidateBase::ntgcHitsEta {0}

Definition at line 182 of file MuPatCandidateBase.h.

ntgcHitsPhi

unsigned int Muon::MuPatCandidateBase::ntgcHitsPhi {0}

Definition at line 183 of file MuPatCandidateBase.h.

---

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

• MuPatCandidateBase.h
• MuPatCandidateBase.cxx