Alexandria 2.31.0
SDC-CH common library for the Euclid project
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
Euclid::MathUtils::ModeInfo Class Reference

Class for storing the information of a PDF mode. More...

#include <PdfModeExtraction.h>

Public Member Functions

 ModeInfo (double highest_sample, double mean, double interpolated, double area)
 
double getHighestSamplePosition () const
 
double getMeanPosition () const
 
double getInterpolatedMaxPosition () const
 
double getModeArea () const
 

Private Attributes

double m_sample
 
double m_mean
 
double m_interp
 
double m_area
 

Detailed Description

Class for storing the information of a PDF mode.

@Class ModeInfo

The Mode info contains the mode area and the mode location. The mode location is stored as the highest point in the PDF sampling, the mean over the mode and a quadratic fitting around the highest point.

Definition at line 46 of file PdfModeExtraction.h.

Constructor & Destructor Documentation

◆ ModeInfo()

Euclid::MathUtils::ModeInfo::ModeInfo ( double  highest_sample,
double  mean,
double  interpolated,
double  area 
)
inline

Definition at line 48 of file PdfModeExtraction.h.

Member Function Documentation

◆ getHighestSamplePosition()

double Euclid::MathUtils::ModeInfo::getHighestSamplePosition ( ) const
inline

Definition at line 51 of file PdfModeExtraction.h.

References m_sample.

◆ getInterpolatedMaxPosition()

double Euclid::MathUtils::ModeInfo::getInterpolatedMaxPosition ( ) const
inline

Definition at line 59 of file PdfModeExtraction.h.

References m_interp.

◆ getMeanPosition()

double Euclid::MathUtils::ModeInfo::getMeanPosition ( ) const
inline

Definition at line 55 of file PdfModeExtraction.h.

References m_mean.

◆ getModeArea()

double Euclid::MathUtils::ModeInfo::getModeArea ( ) const
inline

Definition at line 63 of file PdfModeExtraction.h.

References m_area.

Member Data Documentation

◆ m_area

double Euclid::MathUtils::ModeInfo::m_area
private

Definition at line 71 of file PdfModeExtraction.h.

Referenced by getModeArea().

◆ m_interp

double Euclid::MathUtils::ModeInfo::m_interp
private

Definition at line 70 of file PdfModeExtraction.h.

Referenced by getInterpolatedMaxPosition().

◆ m_mean

double Euclid::MathUtils::ModeInfo::m_mean
private

Definition at line 69 of file PdfModeExtraction.h.

Referenced by getMeanPosition().

◆ m_sample

double Euclid::MathUtils::ModeInfo::m_sample
private

Definition at line 68 of file PdfModeExtraction.h.

Referenced by getHighestSamplePosition().


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