ROOT  6.06/09
Reference Guide
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ROOT::Fit::FitConfig Class Reference

Class describing the configuration of the fit, options and parameter settings using the ROOT::Fit::ParameterSettings class.

Definition at line 51 of file FitConfig.h.

Public Member Functions

 FitConfig (unsigned int npar=0)
 Default constructor. More...
 
 FitConfig (const FitConfig &rhs)
 
 ~FitConfig ()
 Destructor. More...
 
FitConfigoperator= (const FitConfig &rhs)
 
const ParameterSettingsParSettings (unsigned int i) const
 get the parameter settings for the i-th parameter (const method) More...
 
ParameterSettingsParSettings (unsigned int i)
 get the parameter settings for the i-th parameter (non-const method) More...
 
const std::vector< ROOT::Fit::ParameterSettings > & ParamsSettings () const
 get the vector of parameter settings (const method) More...
 
std::vector< ROOT::Fit::ParameterSettings > & ParamsSettings ()
 get the vector of parameter settings (non-const method) More...
 
unsigned int NPar () const
 number of parameters settings More...
 
void CreateParamsSettings (const ROOT::Math::IParamMultiFunction &func)
 set the parameter settings from a model function. More...
 
void SetParamsSettings (unsigned int npar, const double *params, const double *vstep=0)
 set the parameter settings from number of parameters and a vector of values and optionally step values. More...
 
void SetParamsSettings (const std::vector< ROOT::Fit::ParameterSettings > &pars)
 
void SetFromFitResult (const FitResult &rhs)
 
ROOT::Math::MinimizerCreateMinimizer ()
 create a new minimizer according to chosen configuration More...
 
ROOT::Math::MinimizerOptionsMinimizerOptions ()
 access to the minimizer control parameter (non const method) More...
 
void SetMinimizerOptions (const ROOT::Math::MinimizerOptions &minopt)
 set all the minimizer options using class MinimizerOptions More...
 
void SetMinimizer (const char *type, const char *algo=0)
 set minimizer type More...
 
const std::string & MinimizerType () const
 return type of minimizer package More...
 
const std::string & MinimizerAlgoType () const
 return type of minimizer algorithms More...
 
bool NormalizeErrors () const
 flag to check if resulting errors are be normalized according to chi2/ndf More...
 
bool ParabErrors () const
 do analysis for parabolic errors More...
 
bool MinosErrors () const
 do minos errros analysis on the parameters More...
 
bool UpdateAfterFit () const
 Update configuration after a fit using the FitResult. More...
 
bool UseWeightCorrection () const
 Apply Weight correction for error matrix computation. More...
 
const std::vector< unsigned int > & MinosParams () const
 return vector of parameter indeces for which the Minos Error will be computed More...
 
void SetNormErrors (bool on=true)
 set the option to normalize the error on the result according to chi2/ndf More...
 
void SetParabErrors (bool on=true)
 set parabolic erros More...
 
void SetMinosErrors (bool on=true)
 set Minos erros computation to be performed after fitting More...
 
void SetWeightCorrection (bool on=true)
 apply the weight correction for error matric computation More...
 
void SetMinosErrors (const std::vector< unsigned int > &paramInd)
 set parameter indeces for running Minos this can be used for running Minos on a subset of parameters - otherwise is run on all of them if MinosErrors() is set More...
 
void SetUpdateAfterFit (bool on=true)
 Update configuration after a fit using the FitResult. More...
 

Static Public Member Functions

static void SetDefaultMinimizer (const char *type, const char *algo=0)
 static function to control default minimizer type and algorithm More...
 

Private Attributes

bool fNormErrors
 
bool fParabErrors
 
bool fMinosErrors
 
bool fUpdateAfterFit
 
bool fWeightCorr
 
std::vector< ROOT::Fit::ParameterSettingsfSettings
 
std::vector< unsigned int > fMinosParams
 
ROOT::Math::MinimizerOptions fMinimizerOpts
 

#include <Fit/FitConfig.h>

+ Collaboration diagram for ROOT::Fit::FitConfig:

Constructor & Destructor Documentation

ROOT::Fit::FitConfig::FitConfig ( unsigned int  npar = 0)

Default constructor.

Definition at line 41 of file FitConfig.cxx.

ROOT::Fit::FitConfig::FitConfig ( const FitConfig rhs)

Definition at line 58 of file FitConfig.cxx.

ROOT::Fit::FitConfig::~FitConfig ( )

Destructor.

Definition at line 53 of file FitConfig.cxx.

Member Function Documentation

ROOT::Math::Minimizer * ROOT::Fit::FitConfig::CreateMinimizer ( )

create a new minimizer according to chosen configuration

Definition at line 203 of file FitConfig.cxx.

Referenced by ROOT::Fit::Fitter::DoInitMinimizer().

void ROOT::Fit::FitConfig::CreateParamsSettings ( const ROOT::Math::IParamMultiFunction func)

set the parameter settings from a model function.

Create always new parameter setting list from a given model function

Definition at line 174 of file FitConfig.cxx.

Referenced by ROOT::Fit::Fitter::SetFunction().

const std::string& ROOT::Fit::FitConfig::MinimizerAlgoType ( ) const
inline

return type of minimizer algorithms

Definition at line 165 of file FitConfig.h.

Referenced by ROOT::Fit::FitResult::FillResult(), and ROOT::Fit::FitResult::FitResult().

ROOT::Math::MinimizerOptions& ROOT::Fit::FitConfig::MinimizerOptions ( )
inline
const std::string& ROOT::Fit::FitConfig::MinimizerType ( ) const
inline
bool ROOT::Fit::FitConfig::MinosErrors ( ) const
inline

do minos errros analysis on the parameters

Definition at line 177 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::DoBinnedLikelihoodFit(), ROOT::Fit::Fitter::DoUnbinnedLikelihoodFit(), and ROOT::Fit::FitResult::FillResult().

const std::vector<unsigned int>& ROOT::Fit::FitConfig::MinosParams ( ) const
inline

return vector of parameter indeces for which the Minos Error will be computed

Definition at line 187 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::CalculateMinosErrors(), and ROOT::Fit::FitResult::FillResult().

bool ROOT::Fit::FitConfig::NormalizeErrors ( ) const
inline

flag to check if resulting errors are be normalized according to chi2/ndf

Definition at line 171 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::DoMinimization(), and HFit::Fit().

unsigned int ROOT::Fit::FitConfig::NPar ( ) const
inline

number of parameters settings

Definition at line 100 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::DoUpdateFitConfig(), and ROOT::Fit::FitResult::FitResult().

FitConfig & ROOT::Fit::FitConfig::operator= ( const FitConfig rhs)

Definition at line 63 of file FitConfig.cxx.

bool ROOT::Fit::FitConfig::ParabErrors ( ) const
inline

do analysis for parabolic errors

Definition at line 174 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::DoInitMinimizer().

const std::vector<ROOT::Fit::ParameterSettings>& ROOT::Fit::FitConfig::ParamsSettings ( ) const
inline
std::vector<ROOT::Fit::ParameterSettings>& ROOT::Fit::FitConfig::ParamsSettings ( )
inline

get the vector of parameter settings (non-const method)

Definition at line 95 of file FitConfig.h.

const ParameterSettings& ROOT::Fit::FitConfig::ParSettings ( unsigned int  i) const
inline
ParameterSettings& ROOT::Fit::FitConfig::ParSettings ( unsigned int  i)
inline

get the parameter settings for the i-th parameter (non-const method)

Definition at line 85 of file FitConfig.h.

void ROOT::Fit::FitConfig::SetDefaultMinimizer ( const char *  type,
const char *  algo = 0 
)
static

static function to control default minimizer type and algorithm

Definition at line 260 of file FitConfig.cxx.

void ROOT::Fit::FitConfig::SetFromFitResult ( const FitResult rhs)

Definition at line 81 of file FitConfig.cxx.

void ROOT::Fit::FitConfig::SetMinimizer ( const char *  type,
const char *  algo = 0 
)
inline
void ROOT::Fit::FitConfig::SetMinimizerOptions ( const ROOT::Math::MinimizerOptions minopt)

set all the minimizer options using class MinimizerOptions

Definition at line 265 of file FitConfig.cxx.

Referenced by HFit::Fit(), and ROOT::Fit::UnBinFit().

void ROOT::Fit::FitConfig::SetMinosErrors ( bool  on = true)
inline

set Minos erros computation to be performed after fitting

Definition at line 198 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::CalculateMinosErrors(), ROOT::Fit::Fitter::DoBinnedLikelihoodFit(), ROOT::Fit::Fitter::DoUnbinnedLikelihoodFit(), HFit::Fit(), and ROOT::Fit::UnBinFit().

void ROOT::Fit::FitConfig::SetMinosErrors ( const std::vector< unsigned int > &  paramInd)
inline

set parameter indeces for running Minos this can be used for running Minos on a subset of parameters - otherwise is run on all of them if MinosErrors() is set

Definition at line 206 of file FitConfig.h.

void ROOT::Fit::FitConfig::SetNormErrors ( bool  on = true)
inline

set the option to normalize the error on the result according to chi2/ndf

Definition at line 192 of file FitConfig.h.

Referenced by HFit::Fit(), SetFromFitResult(), and testHisto1DFit().

void ROOT::Fit::FitConfig::SetParabErrors ( bool  on = true)
inline

set parabolic erros

Definition at line 195 of file FitConfig.h.

Referenced by HFit::Fit(), and ROOT::Fit::UnBinFit().

void ROOT::Fit::FitConfig::SetParamsSettings ( unsigned int  npar,
const double params,
const double vstep = 0 
)

set the parameter settings from number of parameters and a vector of values and optionally step values.

If there are not existing or number of parameters does not match existing one, create a new parameter setting list.

Definition at line 136 of file FitConfig.cxx.

Referenced by ROOT::Fit::Fitter::SetFCN().

void ROOT::Fit::FitConfig::SetParamsSettings ( const std::vector< ROOT::Fit::ParameterSettings > &  pars)
inline

Definition at line 116 of file FitConfig.h.

void ROOT::Fit::FitConfig::SetUpdateAfterFit ( bool  on = true)
inline

Update configuration after a fit using the FitResult.

Definition at line 212 of file FitConfig.h.

void ROOT::Fit::FitConfig::SetWeightCorrection ( bool  on = true)
inline

apply the weight correction for error matric computation

Definition at line 201 of file FitConfig.h.

Referenced by HFit::Fit(), and ROOT::Fit::UnBinFit().

bool ROOT::Fit::FitConfig::UpdateAfterFit ( ) const
inline

Update configuration after a fit using the FitResult.

Definition at line 180 of file FitConfig.h.

Referenced by ROOT::Fit::Fitter::CalculateHessErrors(), and ROOT::Fit::Fitter::DoMinimization().

bool ROOT::Fit::FitConfig::UseWeightCorrection ( ) const
inline

Member Data Documentation

ROOT::Math::MinimizerOptions ROOT::Fit::FitConfig::fMinimizerOpts
private
bool ROOT::Fit::FitConfig::fMinosErrors
private

Definition at line 230 of file FitConfig.h.

Referenced by MinosErrors(), operator=(), SetFromFitResult(), and SetMinosErrors().

std::vector<unsigned int> ROOT::Fit::FitConfig::fMinosParams
private

Definition at line 235 of file FitConfig.h.

Referenced by MinosParams(), operator=(), SetFromFitResult(), and SetMinosErrors().

bool ROOT::Fit::FitConfig::fNormErrors
private

Definition at line 228 of file FitConfig.h.

Referenced by NormalizeErrors(), operator=(), and SetNormErrors().

bool ROOT::Fit::FitConfig::fParabErrors
private

Definition at line 229 of file FitConfig.h.

Referenced by CreateMinimizer(), operator=(), ParabErrors(), and SetParabErrors().

std::vector<ROOT::Fit::ParameterSettings> ROOT::Fit::FitConfig::fSettings
private
bool ROOT::Fit::FitConfig::fUpdateAfterFit
private

Definition at line 231 of file FitConfig.h.

Referenced by operator=(), SetUpdateAfterFit(), and UpdateAfterFit().

bool ROOT::Fit::FitConfig::fWeightCorr
private

Definition at line 232 of file FitConfig.h.

Referenced by operator=(), SetWeightCorrection(), and UseWeightCorrection().


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