hpstr
The Heavy Photon Search Toolkit for Reconstruction (hpstr) provides an interface to physics data from the HPS experiment saved in the LCIO format and converts it into an ROOT based format.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
FitFunction Class Referenceabstract

description More...

#include <FitFunction.h>

Inheritance diagram for FitFunction:
ChebyshevFitFunction LegendreFitFunction

Public Types

enum  SignalFitModel { NONE = 0 , GAUSSIAN = 1 , CRYSTAL_BALL = 2 }
 description More...
 
enum  ModelOrder { FIRST = 0 , THIRD = 1 , FIFTH = 2 , SEVENTH = 3 }
 description More...
 
enum  BkgModel { CHEBYSHEV = 0 , EXP_CHEBYSHEV = 1 , LEGENDRE = 2 , EXP_LEGENDRE = 3 }
 description More...
 

Public Member Functions

 FitFunction (double m_mass_hypothesis, double m_window_size, double m_bin_size, ModelOrder m_model_order, SignalFitModel m_sig_model=FitFunction::SignalFitModel::NONE, bool m_exp_background=true)
 Constructor.
 
double operator() (double *x, double *par)
 Calculates the value of the function at the specified x and with the specified parameters.
 

Protected Member Functions

virtual double calculateBackground (double *x, double *par)=0
 Calculates the value of the background function at the specified x and with the specified parameters.
 
double calculateSignal (double *x, double *par)
 Calculates the value of the signal function at the specified x and with the specified parameters.
 
double getCorrectedX (double x)
 Gets a value of x corrected for window size and the mass hypothesis.
 

Protected Attributes

double mass_hypothesis = 0
 
double window_size = 0
 
double bin_size = 0
 
int order = 0
 
SignalFitModel sig_model
 
ModelOrder model_order
 
bool exp_background = true
 

Private Attributes

int sigParm = 0
 

Detailed Description

description

more details

Definition at line 12 of file FitFunction.h.

Member Enumeration Documentation

◆ BkgModel

enum BkgModel

description

Enumerator
CHEBYSHEV 
EXP_CHEBYSHEV 
LEGENDRE 
EXP_LEGENDRE 

Definition at line 39 of file FitFunction.h.

◆ ModelOrder

enum ModelOrder

description

Enumerator
FIRST 
THIRD 
FIFTH 
SEVENTH 

Definition at line 28 of file FitFunction.h.

◆ SignalFitModel

description

Enumerator
NONE 
GAUSSIAN 
CRYSTAL_BALL 

Definition at line 18 of file FitFunction.h.

Constructor & Destructor Documentation

◆ FitFunction()

FitFunction ( double  m_mass_hypothesis,
double  m_window_size,
double  m_bin_size,
ModelOrder  m_model_order,
SignalFitModel  m_sig_model = FitFunction::SignalFitModel::NONE,
bool  m_exp_background = true 
)
inline

Constructor.

Parameters
m_mass_hypothesis
m_window_size
m_bin_size
m_model_order
m_sig_model
m_exp_background

Definition at line 56 of file FitFunction.h.

Member Function Documentation

◆ calculateBackground()

virtual double calculateBackground ( double *  x,
double *  par 
)
protectedpure virtual

Calculates the value of the background function at the specified x and with the specified parameters.

Parameters
x
par
Returns
double

Implemented in ChebyshevFitFunction, and LegendreFitFunction.

◆ calculateSignal()

double calculateSignal ( double *  x,
double *  par 
)
inlineprotected

Calculates the value of the signal function at the specified x and with the specified parameters.

Parameters
x
par
Returns
double

Definition at line 140 of file FitFunction.h.

◆ getCorrectedX()

double getCorrectedX ( double  x)
inlineprotected

Gets a value of x corrected for window size and the mass hypothesis.

Parameters
x
Returns
double

Definition at line 161 of file FitFunction.h.

◆ operator()()

double operator() ( double *  x,
double *  par 
)
inline

Calculates the value of the function at the specified x and with the specified parameters.

Parameters
x
par
Returns
double

Definition at line 92 of file FitFunction.h.

Member Data Documentation

◆ bin_size

double bin_size = 0
protected

Size of each bin in the histogram.

Definition at line 108 of file FitFunction.h.

◆ exp_background

bool exp_background = true
protected

Type of background fit to use.

Definition at line 120 of file FitFunction.h.

◆ mass_hypothesis

double mass_hypothesis = 0
protected

Mass hypothesis

Definition at line 102 of file FitFunction.h.

◆ model_order

ModelOrder model_order
protected

Order of the model to be used.

Definition at line 117 of file FitFunction.h.

◆ order

int order = 0
protected

The model order as an integer.

Definition at line 111 of file FitFunction.h.

◆ sig_model

SignalFitModel sig_model
protected

Signal fit function to be used.

Definition at line 114 of file FitFunction.h.

◆ sigParm

int sigParm = 0
private

Specifies where the signal parameters begin.

Definition at line 167 of file FitFunction.h.

◆ window_size

double window_size = 0
protected

Size of the search window.

Definition at line 105 of file FitFunction.h.


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