Acts::CandidatesForMiddleSp< external_space_point_t > Class Template Reference

The CandidatesForMiddleSp collects the triplet candidates given a fixed middle spacepoint. More...

#include <Acts/Seeding/CandidatesForMiddleSp.hpp>

Inheritance diagram for Acts::CandidatesForMiddleSp< external_space_point_t >:

Public Types
using	value_type = TripletCandidate<external_space_point_t>
	Type alias for triplet candidate type stored in this container.

Public Member Functions
void	clear ()
	Clear the internal storage.
std::size_t	nHighQualityCandidates () const
	Retrieve the number of High quality candidates.
std::size_t	nLowQualityCandidates () const
	Retrieve the number of Low quality candidates.
bool	push (external_space_point_t &spB, external_space_point_t &spM, external_space_point_t &spT, float weight, float zOrigin, bool isQuality)
	Adding a new triplet candidate to the collection, should it satisfy the selection criteria.
void	setMaxElements (std::size_t nLow, std::size_t nHigh)
	Setting maximum number of candidates to keep.
std::vector< value_type >	storage ()
	Retrieve the triplet candidates, the resulting vector is already sorted, elements with higher quality first.

Static Public Member Functions
static bool	ascendingByQuality (const value_type &i1, const value_type &i2)
	A function for sorting the triplet candidates from lower to higher quality.
static bool	descendingByQuality (const value_type &i1, const value_type &i2)
	A function for sorting the triplet candidates from higher to lower quality.

Detailed Description

template<SatisfyCandidateConcept external_space_point_t>
class Acts::CandidatesForMiddleSp< external_space_point_t >

The CandidatesForMiddleSp collects the triplet candidates given a fixed middle spacepoint.

It internally stores the triplet candidates keeping only those with the higher quality.

Template Parameters

external_space_point_t

The external spacepoint type.

Member Typedef Documentation

value_type

template<SatisfyCandidateConcept external_space_point_t>

using Acts::CandidatesForMiddleSp< external_space_point_t >::value_type = TripletCandidate<external_space_point_t>

Type alias for triplet candidate type stored in this container.

Member Function Documentation

ascendingByQuality()

template<SatisfyCandidateConcept external_space_point_t>

bool Acts::CandidatesForMiddleSp< external_space_point_t >::ascendingByQuality ( const value_type & i1, const value_type & i2 )

static

A function for sorting the triplet candidates from lower to higher quality.

Parameters

i1	First triplet candidate
i2	Second triplet candidate

Returns

The comparison result

clear()

template<SatisfyCandidateConcept external_space_point_t>

void Acts::CandidatesForMiddleSp< external_space_point_t >::clear

(

)

Clear the internal storage.

descendingByQuality()

template<SatisfyCandidateConcept external_space_point_t>

bool Acts::CandidatesForMiddleSp< external_space_point_t >::descendingByQuality ( const value_type & i1, const value_type & i2 )

static

A function for sorting the triplet candidates from higher to lower quality.

Parameters

i1	First triplet candidate
i2	Second triplet candidate

Returns

The comparison result

nHighQualityCandidates()

template<SatisfyCandidateConcept external_space_point_t>

std::size_t Acts::CandidatesForMiddleSp< external_space_point_t >::nHighQualityCandidates

(

)

const

Retrieve the number of High quality candidates.

Returns

The number of High quality candidates

nLowQualityCandidates()

template<SatisfyCandidateConcept external_space_point_t>

std::size_t Acts::CandidatesForMiddleSp< external_space_point_t >::nLowQualityCandidates

(

)

const

Retrieve the number of Low quality candidates.

Returns

The number of Low quality candidates

push()

template<SatisfyCandidateConcept external_space_point_t>

bool Acts::CandidatesForMiddleSp< external_space_point_t >::push	(	external_space_point_t &	spB,
		external_space_point_t &	spM,
		external_space_point_t &	spT,
		float	weight,
		float	zOrigin,
		bool	isQuality )

Adding a new triplet candidate to the collection, should it satisfy the selection criteria.

Parameters

spB	Bottom space point
spM	Medium space point
spT	Top space point
weight	The quality of the triplet candidate
zOrigin	The z-coordinate of the origin
isQuality	Whether the triplet candidate is high or low quality

Returns

whether the triplet candidate has been added or not to the collection

setMaxElements()

template<SatisfyCandidateConcept external_space_point_t>

void Acts::CandidatesForMiddleSp< external_space_point_t >::setMaxElements	(	std::size_t	nLow,
		std::size_t	nHigh )

Setting maximum number of candidates to keep.

Parameters

nLow	Maximum number of candidates in the low-quality collection
nHigh	Maximum number of candidates in the high-quality collection

storage()

template<SatisfyCandidateConcept external_space_point_t>

std::vector< value_type > Acts::CandidatesForMiddleSp< external_space_point_t >::storage

(

)

Retrieve the triplet candidates, the resulting vector is already sorted, elements with higher quality first.

Returns

Vector of triplet candidates