MuonR4::FastReco::GlobalPatternFinder::PatternState Struct Reference

Pattern state object storing pattern information during construction. More...

Collaboration diagram for MuonR4::FastReco::GlobalPatternFinder::PatternState:

Public Types
using	HitStationPair = std::pair<std::reference_wrapper<const HitPayload>, StIndex>

Public Member Functions
	PatternState (const HitPayload &seed, const StIndex seedStation, const int sectorCoord, const double seedTheta)
	Constructor taking the seed information.
	PatternState ()=delete
void	addHit (const HitPayload &hit, const StIndex stationHit, const double residual)
	Add a hit to the pattern and update the internal state.
void	overWriteHit (const HitPayload &oldHit, const HitPayload &newHit, const StIndex station, const double newResidual)
	Overwrite a hit in the pattern and update the internal state.
HitStationPair	getNthLastHit (const std::size_t n) const
	Get the nth last inserted hit and the associated station.
bool	isInPattern (const HitPayload &hit, const StIndex station) const
	Check wheter a hit is present in the pattern.
void	finalizePattern ()
	Finalize the pattern and update its state.
bool	operator== (const PatternState &other) const
	Equal operator, it checks the hit-per-station map.
void	print (std::ostream &ostr) const
	Print the pattern candidate and stream operator.

Public Attributes
std::unordered_map< StIndex, std::vector< HitPayload > >	hitsPerStation {}
	Map collection of hits per station.
std::vector< StIndex >	stations {}
	Pattern hit stations to save the filling order.
BucketPerContainer	bucketsPerContainer {}
	Map of spacepoint buckets per spacepoint container associated to the pattern.
int	sectorCoord {-1}
	expanded sector coordinate & average theta & average phi of the pattern
double	theta {0.}
double	phi {0.}
unsigned	nPrecisionHits {0}
	Counts of precision measurements / non-precision in bending direction / phi measurements.
unsigned	nBendingTriggerHits {0}
unsigned	nPhiHits {0}
double	totalResidual {0.}
	Total residual and last contribution to the residual (needed when replacing a hit)
double	lastResidual {0.}
bool	isOverlap {false}
	Flag to indicate if the pattern is overlapping with another one, used during overlap removal.
unsigned	nInsertedHits {0}
	Number of inserted hits during one of the two search stages (from seed outward and from seed inward)
unsigned	nMissedLayerHits {0}
	Number of missed candidate hits in different measurement layers during pattern building.
Acts::CloneablePtr< PatternHitVisualInfo >	visualInfo {nullptr}
	Pointer to Visual Information for pattern visualization.

Friends
std::ostream &	operator<< (std::ostream &ostr, const PatternState &candidate)

Detailed Description

Pattern state object storing pattern information during construction.

Definition at line 124 of file GlobalPatternFinder.h.

Member Typedef Documentation

HitStationPair

using MuonR4::FastReco::GlobalPatternFinder::PatternState::HitStationPair = std::pair<std::reference_wrapper<const HitPayload>, StIndex>

Definition at line 151 of file GlobalPatternFinder.h.

Constructor & Destructor Documentation

PatternState() [1/2]

MuonR4::FastReco::GlobalPatternFinder::PatternState::PatternState	(	const HitPayload &	seed,
		const StIndex	seedStation,
		const int	sectorCoord,
		const double	seedTheta )

Constructor taking the seed information.

Parameters

seed	seed hit
seedStation	station of the seed hit
sectorCoord	expanded sector coordinate
seedTheta	global theta of the seed

Definition at line 630 of file GlobalPatternFinder.cxx.

        : sectorCoord{sectorCoord}, theta{seedTheta} {
    addHit(seed, seedStation, 0.0);
}

PatternState() [2/2]

MuonR4::FastReco::GlobalPatternFinder::PatternState::PatternState ( )

delete

Member Function Documentation

addHit()

void MuonR4::FastReco::GlobalPatternFinder::PatternState::addHit	(	const HitPayload &	hit,
		const StIndex	stationHit,
		const double	residual )

Add a hit to the pattern and update the internal state.

Parameters

hit	hit to be added
stationHit	station of the hit
residual	residual of the hit

Increment the number of inserted hits

Reset the number of missed layer hits

Update the hit counts in bending direction

Update the phi hit count and the average phi value

Update the residual

Definition at line 637 of file GlobalPatternFinder.cxx.

                                                                         {
    hitsPerStation[stationHit].push_back(hit);
    if (stations.empty() || stations.back() != stationHit) {
        stations.push_back(stationHit);
    }
    nInsertedHits++;
    nMissedLayerHits = 0;
    if (isPrecisionHit(*hit.hit)) nPrecisionHits++;
    else if (hit.hit->measuresEta()) nBendingTriggerHits++;
    if (hit.hit->measuresPhi()) {
        updateMean(phi, nPhiHits, hit.phi);
        nPhiHits++;
    }
    totalResidual += residual;
    lastResidual = residual;
}

finalizePattern()

void MuonR4::FastReco::GlobalPatternFinder::PatternState::finalizePattern

(

)

Finalize the pattern and update its state.

Update the bucket map

Update eta

Definition at line 701 of file GlobalPatternFinder.cxx.

                                                      {
    theta = 0.;
    unsigned nHits {0};
    for (const auto& [_, hits] : hitsPerStation) {
        for (const auto& hit : hits) {
            auto& bucketVec {bucketsPerContainer[hit.container]};
            if (std::ranges::find(bucketVec, hit.bucket) == bucketVec.end()){
                bucketVec.push_back(hit.bucket);
            }
            theta += atan2(hit.R, hit.Z);
            nHits++;
        }
    }
    theta /= nHits;
}

getNthLastHit()

GlobalPatternFinder::PatternState::HitStationPair MuonR4::FastReco::GlobalPatternFinder::PatternState::getNthLastHit

(

const std::size_t

n

)

const

Get the nth last inserted hit and the associated station.

Parameters

n	the index of the hit to retrieve

Returns

: the pair of the n-th last inserted hit and station

Definition at line 741 of file GlobalPatternFinder.cxx.

                                                                      {
    if (n > nInsertedHits) {
        // If we have not yet inserted n hits, we return the seed hit
        return std::make_pair(std::cref(hitsPerStation.at(stations.front()).front()), 
                              stations.front());
    }
    std::size_t remaining {n};
    for (auto stIt = stations.rbegin(); stIt != stations.rend(); ++stIt) {
        const auto& hits {hitsPerStation.at(*stIt)};
        const size_t nHits  {hits.size()};
        if (remaining <= nHits) {
            return std::make_pair(std::cref(hits.at(nHits - remaining)), 
                                  *stIt);
        }
        remaining -= nHits;
    }
    // Fall-back return, should not happen if the input n is consistent with nInsertedHits
    return std::make_pair(std::cref(hitsPerStation.at(stations.front()).front()), 
                          stations.front());
}

isInPattern()

bool MuonR4::FastReco::GlobalPatternFinder::PatternState::isInPattern	(	const HitPayload &	hit,
		const StIndex	station ) const

Check wheter a hit is present in the pattern.

Parameters

hit	hit to be checked
station	station of the hit to be checked

Returns

: boolean indicating if the hit is in the pattern

Definition at line 761 of file GlobalPatternFinder.cxx.

                                                                                    {
    const auto seedStationIt {hitsPerStation.find(station)};
    return seedStationIt != hitsPerStation.end() && 
           std::ranges::find(seedStationIt->second, hit) != seedStationIt->second.end();                                               
}

operator==()

bool MuonR4::FastReco::GlobalPatternFinder::PatternState::operator==

(

const PatternState &

other

)

const

Equal operator, it checks the hit-per-station map.

It'svery expensive and in principle should be avoided

Definition at line 767 of file GlobalPatternFinder.cxx.

                                                                                {
    return hitsPerStation == other.hitsPerStation;
}

overWriteHit()

void MuonR4::FastReco::GlobalPatternFinder::PatternState::overWriteHit	(	const HitPayload &	oldHit,
		const HitPayload &	newHit,
		const StIndex	station,
		const double	newResidual )

Overwrite a hit in the pattern and update the internal state.

Parameters

oldHit	hit to be replaced
newHit	new hit to replace with
station	station of the new hit
newResidual	residual of the new hit

Update the phi hit count and average phi of the pattern

Definition at line 661 of file GlobalPatternFinder.cxx.

                                                                                  {
    // We expect to overwrite hits of the same type (precision/trigger), since we only branch when we have
    // compatible hits in the same layer, except for sTGC hits, where we have pad and strips in the same layer
    if ((isPrecisionHit(*oldHit.hit) != isPrecisionHit(*newHit.hit) || 
        oldHit.hit->measuresEta() != newHit.hit->measuresEta()) && newHit.hit->type() != xAOD::UncalibMeasType::sTgcStripType) {
        std::stringstream ss {"Trying to overwrite a hit with incompatible type\n"};
        ss << "Old hit: " << *oldHit.hit << ", isPrecision: " << isPrecisionHit(*oldHit.hit) << ", measuresEta: " << oldHit.hit->measuresEta() << "\n";
        ss << "New hit: " << *newHit.hit << ", isPrecision: " << isPrecisionHit(*newHit.hit) << ", measuresEta: " << newHit.hit->measuresEta();
        throw std::runtime_error(ss.str());
        return;
    }
    auto it = hitsPerStation.find(station);
    if (it == hitsPerStation.end()) {
        throw std::runtime_error("Trying to remove a hit from a station that is not in the pattern cache");
        return;
    }
    auto& hitsInThisStation = it->second;
    auto toRemove = std::ranges::find(hitsInThisStation, oldHit);
    if (toRemove == hitsInThisStation.end()) {
        throw std::runtime_error("Trying to remove a hit that is not in the pattern cache station hits");
        return;
    }
    *toRemove = newHit;

    if (oldHit.hit->measuresPhi()) {
        updateMean(phi, nPhiHits, oldHit.phi, false);
        nPhiHits--;
    }
    if (newHit.hit->measuresPhi()) {
        updateMean(phi, nPhiHits, newHit.phi, true);
        nPhiHits++;
    }
    // Update the residual
    totalResidual += newResidual - lastResidual;
    lastResidual = newResidual;
}

print()

void MuonR4::FastReco::GlobalPatternFinder::PatternState::print

(

std::ostream &

ostr

)

const

Print the pattern candidate and stream operator.

Definition at line 773 of file GlobalPatternFinder.cxx.

                                                                  {
    ostr<<"Pattern state, Expanded Sector: "<<sectorCoord<<", Theta: "<<theta << ", Phi: "<<phi;
    ostr<<", nPrecisionHits: "<<nPrecisionHits<<", nEtaNonPrecisionHits: "<<nBendingTriggerHits<<", nPhiHits: "<<nPhiHits<<", total residual: "<<totalResidual;
    ostr<<", Hit per station: \n";
    for (const auto& [station,hits] : hitsPerStation) {
        ostr<<"  Station "<<Muon::MuonStationIndex::stName(station)<<" has "<<hits.size()<<" hits\n";
        for (const auto& hit : hits) {
            ostr<<"    "<<*hit.hit<<", R: "<<hit.R<<", Phi:"<<hit.phi<<"\n";
        }
    }
}

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & ostr, const PatternState & candidate )

friend

Definition at line 194 of file GlobalPatternFinder.h.

                                                                                               {
                    candidate.print(ostr);
                    return ostr;
                }

Member Data Documentation

bucketsPerContainer

BucketPerContainer MuonR4::FastReco::GlobalPatternFinder::PatternState::bucketsPerContainer {}

Map of spacepoint buckets per spacepoint container associated to the pattern.

Definition at line 172 of file GlobalPatternFinder.h.

{};

hitsPerStation

std::unordered_map<StIndex, std::vector<HitPayload> > MuonR4::FastReco::GlobalPatternFinder::PatternState::hitsPerStation {}

Map collection of hits per station.

A pattern is determined by the hits belonging to it.

Definition at line 167 of file GlobalPatternFinder.h.

{};

isOverlap

bool MuonR4::FastReco::GlobalPatternFinder::PatternState::isOverlap {false}

Flag to indicate if the pattern is overlapping with another one, used during overlap removal.

Definition at line 185 of file GlobalPatternFinder.h.

{false};

lastResidual

double MuonR4::FastReco::GlobalPatternFinder::PatternState::lastResidual {0.}

Definition at line 183 of file GlobalPatternFinder.h.

{0.};

nBendingTriggerHits

unsigned MuonR4::FastReco::GlobalPatternFinder::PatternState::nBendingTriggerHits {0}

Definition at line 179 of file GlobalPatternFinder.h.

{0};

nInsertedHits

unsigned MuonR4::FastReco::GlobalPatternFinder::PatternState::nInsertedHits {0}

Number of inserted hits during one of the two search stages (from seed outward and from seed inward)

Definition at line 187 of file GlobalPatternFinder.h.

{0};

nMissedLayerHits

unsigned MuonR4::FastReco::GlobalPatternFinder::PatternState::nMissedLayerHits {0}

Number of missed candidate hits in different measurement layers during pattern building.

Definition at line 189 of file GlobalPatternFinder.h.

{0};        

nPhiHits

unsigned MuonR4::FastReco::GlobalPatternFinder::PatternState::nPhiHits {0}

Definition at line 180 of file GlobalPatternFinder.h.

{0};

nPrecisionHits

unsigned MuonR4::FastReco::GlobalPatternFinder::PatternState::nPrecisionHits {0}

Counts of precision measurements / non-precision in bending direction / phi measurements.

Definition at line 178 of file GlobalPatternFinder.h.

{0};

phi

double MuonR4::FastReco::GlobalPatternFinder::PatternState::phi {0.}

Definition at line 176 of file GlobalPatternFinder.h.

{0.};

sectorCoord

int MuonR4::FastReco::GlobalPatternFinder::PatternState::sectorCoord {-1}

expanded sector coordinate & average theta & average phi of the pattern

Definition at line 174 of file GlobalPatternFinder.h.

{-1};

stations

std::vector<StIndex> MuonR4::FastReco::GlobalPatternFinder::PatternState::stations {}

Pattern hit stations to save the filling order.

Stations can be repeated when we invert the search direction (e.g. from seed ourward -> BM BO, then from seed inward BM BI)

Definition at line 170 of file GlobalPatternFinder.h.

{};

theta

double MuonR4::FastReco::GlobalPatternFinder::PatternState::theta {0.}

Definition at line 175 of file GlobalPatternFinder.h.

{0.};

totalResidual

double MuonR4::FastReco::GlobalPatternFinder::PatternState::totalResidual {0.}

Total residual and last contribution to the residual (needed when replacing a hit)

Definition at line 182 of file GlobalPatternFinder.h.

{0.};

visualInfo

Acts::CloneablePtr<PatternHitVisualInfo> MuonR4::FastReco::GlobalPatternFinder::PatternState::visualInfo {nullptr}

Pointer to Visual Information for pattern visualization.

Definition at line 191 of file GlobalPatternFinder.h.

{nullptr};

---

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

• GlobalPatternFinder.h
• GlobalPatternFinder.cxx