ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::FsmwMode1dFinder Class Reference

Calculates the mode of a unidimenensional distribution using the Fraction of Sample Mode with Weights algorithm For reference, see: On a Fast, Robust Estimator of the Mode: Comparisons to Other Robust Estimators with Applications, David R. More...

#include <Acts/Vertexing/FsmwMode1dFinder.hpp>

Public Member Functions

 FsmwMode1dFinder ()=default
 Default constructor.
 FsmwMode1dFinder (double firstFraction, double fraction)
 Overload constructor.
Result< double > getMode (std::vector< std::pair< double, double > > inputVector) const
 Function to calculate mode with FSMW algorithm.

Detailed Description

Calculates the mode of a unidimenensional distribution using the Fraction of Sample Mode with Weights algorithm For reference, see: On a Fast, Robust Estimator of the Mode: Comparisons to Other Robust Estimators with Applications, David R.

Bickel, Rudolf Fruehwirth, arXiv:math/0505419 It's like an iterative "Half Sample Mode", but the fraction you take at each step can be configured by the user. Configuration possibilities: (1) fraction (default is 50 %) (2) firstFraction (default is 50 %)

Constructor & Destructor Documentation

◆ FsmwMode1dFinder() [1/2]

Acts::FsmwMode1dFinder::FsmwMode1dFinder ( )
default

Default constructor.

◆ FsmwMode1dFinder() [2/2]

Acts::FsmwMode1dFinder::FsmwMode1dFinder ( double firstFraction,
double fraction )

Overload constructor.

Parameters
firstFractionfirst fraction in FSMW algorithm
fractionall other fractions in FSMW algorithm

Member Function Documentation

◆ getMode()

Result< double > Acts::FsmwMode1dFinder::getMode ( std::vector< std::pair< double, double > > inputVector) const

Function to calculate mode with FSMW algorithm.

Parameters
inputVectorInput collection to calculate mode from
Returns
mode value