ROOT::Fit::FitConfig

ROOT::Fit::FitConfig Class Reference
[User Fitting classes, User Fitting classes]

#include <FitConfig.h>

List of all members.

Public Member Functions

 FitConfig (unsigned int npar=0)
 FitConfig (const FitConfig &rhs)
 ~FitConfig ()
FitConfig & operator= (const FitConfig &rhs)
const ParameterSettings & ParSettings (unsigned int i) const
ParameterSettings & ParSettings (unsigned int i)
const std::vector< ROOT::Fit::ParameterSettings > & ParamsSettings () const
std::vector< ROOT::Fit::ParameterSettings > & ParamsSettings ()
void CreateParamsSettings (const ROOT::Math::IParamMultiFunction &func)
void SetParamsSettings (unsigned int npar, const double *params, const double *vstep=0)
ROOT::Math::Minimizer * CreateMinimizer ()
ROOT::Math::MinimizerOptions & MinimizerOptions ()
void SetMinimizerOptions (const ROOT::Math::MinimizerOptions &minopt)
void SetMinimizer (const char *type, const char *algo=0)
const std::string & MinimizerType () const
const std::string & MinimizerAlgoType () const
bool NormalizeErrors () const
bool ParabErrors () const
 do analysis for parabolic errors
bool MinosErrors () const
 do minos errros analysis on the parameters
const std::vector< unsigned
int > & 		MinosParams () const
 return vector of parameter indeces for which the Minos Error will be computed
void SetNormErrors (bool on=true)
void SetParabErrors (bool on=true)
 set parabolic erros
void SetMinosErrors (bool on=true)
 set Minos erros
void SetMinosErrors (const std::vector< unsigned int > &paramInd)
 FitConfig (unsigned int npar=0)
 FitConfig (const FitConfig &rhs)
 ~FitConfig ()
FitConfig & operator= (const FitConfig &rhs)
const ParameterSettings & ParSettings (unsigned int i) const
ParameterSettings & ParSettings (unsigned int i)
const std::vector< ROOT::Fit::ParameterSettings > & ParamsSettings () const
std::vector< ROOT::Fit::ParameterSettings > & ParamsSettings ()
void CreateParamsSettings (const ROOT::Math::IParamMultiFunction &func)
void SetParamsSettings (unsigned int npar, const double *params, const double *vstep=0)
ROOT::Math::Minimizer * CreateMinimizer ()
ROOT::Math::MinimizerOptions & MinimizerOptions ()
void SetMinimizerOptions (const ROOT::Math::MinimizerOptions &minopt)
void SetMinimizer (const char *type, const char *algo=0)
const std::string & MinimizerType () const
const std::string & MinimizerAlgoType () const
bool NormalizeErrors () const
bool ParabErrors () const
 do analysis for parabolic errors
bool MinosErrors () const
 do minos errros analysis on the parameters
const std::vector< unsigned
int > & 		MinosParams () const
 return vector of parameter indeces for which the Minos Error will be computed
void SetNormErrors (bool on=true)
void SetParabErrors (bool on=true)
 set parabolic erros
void SetMinosErrors (bool on=true)
 set Minos erros
void SetMinosErrors (const std::vector< unsigned int > &paramInd)

Static Public Member Functions

static void SetDefaultMinimizer (const char *type, const char *algo=0)
static void SetDefaultMinimizer (const char *type, const char *algo=0)

Private Attributes

bool fNormErrors
bool fParabErrors
bool fMinosErrors
std::vector< ROOT::Fit::ParameterSettings > fSettings
std::vector< unsigned int > fMinosParams
ROOT::Math::MinimizerOptions fMinimizerOpts
std::vector< ROOT::Fit::ParameterSettings > fSettings
std::vector< unsigned int > fMinosParams

Detailed Description

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

Definition at line 49 of file FitConfig.h.

Constructor & Destructor Documentation

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

Default constructor

Definition at line 39 of file FitConfig.cxx.

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

Definition at line 54 of file FitConfig.cxx.

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

Destructor

Definition at line 49 of file FitConfig.cxx.

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

Default constructor

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

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

Destructor

Member Function Documentation

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

Definition at line 59 of file FitConfig.cxx.

References fMinimizerOpts, fMinosErrors, fMinosParams, fNormErrors, fParabErrors, and fSettings.

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

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

Definition at line 78 of file FitConfig.h.

References fSettings.

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

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

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

Definition at line 83 of file FitConfig.h.

References fSettings.

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

get the vector of parameter settings (const method)

Definition at line 88 of file FitConfig.h.

References fSettings.

Referenced by ROOT::Fit::Fitter::DoLeastSquareFit(), ROOT::Fit::Fitter::DoLikelihoodFit(), ROOT::Fit::Fitter::DoMinimization(), and ROOT::Fit::Fitter::FitFCN().

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

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

Definition at line 93 of file FitConfig.h.

References fSettings.

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 113 of file FitConfig.cxx.

References ROOT::Math::fabs(), fSettings, func(), i, and val.

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

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 75 of file FitConfig.cxx.

References ROOT::Math::fabs(), fSettings, i, ROOT::Math::Util::ToString(), and val.

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

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

create a new minimizer according to chosen configuration

Definition at line 142 of file FitConfig.cxx.

References ROOT::Math::Factory::CreateMinimizer(), ROOT::Math::MinimizerOptions::DefaultMinimizerType(), ROOT::Math::MinimizerOptions::ErrorDef(), fMinimizerOpts, fParabErrors, fSettings, MATH_ERROR_MSG, MATH_WARN_MSG, ROOT::Math::MinimizerOptions::MaxFunctionCalls(), ROOT::Math::MinimizerOptions::MaxIterations(), min, ROOT::Math::MinimizerOptions::MinimizerAlgorithm(), ROOT::Math::MinimizerOptions::MinimizerType(), ROOT::Math::MinimizerOptions::Precision(), ROOT::Math::MinimizerOptions::PrintLevel(), ROOT::Math::MinimizerOptions::SetMaxFunctionCalls(), SetMinimizer(), ROOT::Math::MinimizerOptions::SetMinimizerType(), ROOT::Math::MinimizerOptions::Strategy(), and ROOT::Math::MinimizerOptions::Tolerance().

Referenced by ROOT::Fit::Fitter::DoLeastSquareFit(), ROOT::Fit::Fitter::DoLikelihoodFit(), and ROOT::Fit::Fitter::FitFCN().

ROOT::Math::MinimizerOptions& ROOT::Fit::FitConfig::MinimizerOptions (  )  [inline]

access to the minimizer control parameter (non const method)

Definition at line 118 of file FitConfig.h.

References fMinimizerOpts.

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

void ROOT::Fit::FitConfig::SetMinimizerOptions ( const ROOT::Math::MinimizerOptions &  minopt  ) 

set all the minimizer options using class MinimizerOptions

Definition at line 204 of file FitConfig.cxx.

References fMinimizerOpts.

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

void ROOT::Fit::FitConfig::SetMinimizer ( const char *  type,
const char *  algo = 0 
) [inline]

set minimizer type

Definition at line 132 of file FitConfig.h.

References fMinimizerOpts, ROOT::Math::MinimizerOptions::SetMinimizerAlgorithm(), and ROOT::Math::MinimizerOptions::SetMinimizerType().

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

const std::string& ROOT::Fit::FitConfig::MinimizerType (  )  const [inline]

return type of minimizer package

Definition at line 140 of file FitConfig.h.

References fMinimizerOpts, and ROOT::Math::MinimizerOptions::MinimizerType().

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

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

return type of minimizer algorithms

Definition at line 145 of file FitConfig.h.

References fMinimizerOpts, and ROOT::Math::MinimizerOptions::MinimizerAlgorithm().

Referenced by ROOT::Fit::FitResult::FitResult().

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

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

Definition at line 151 of file FitConfig.h.

References fNormErrors.

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

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

do analysis for parabolic errors

Definition at line 154 of file FitConfig.h.

References fParabErrors.

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

bool ROOT::Fit::FitConfig::MinosErrors (  )  const [inline]

do minos errros analysis on the parameters

Definition at line 157 of file FitConfig.h.

References fMinosErrors.

Referenced by ROOT::Fit::FitResult::FitResult().

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 160 of file FitConfig.h.

References fMinosParams.

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

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 165 of file FitConfig.h.

References fNormErrors.

Referenced by HFit::Fit().

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

set parabolic erros

Definition at line 168 of file FitConfig.h.

References fParabErrors.

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

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

set Minos erros

Definition at line 171 of file FitConfig.h.

References fMinosErrors.

Referenced by ROOT::Fit::Fitter::CalculateMinosErrors(), 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 176 of file FitConfig.h.

References fMinosErrors, and fMinosParams.

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 199 of file FitConfig.cxx.

References ROOT::Math::MinimizerOptions::SetDefaultMinimizer().

Referenced by G__G__MathFit_154_0_23(), and G__setup_memfuncROOTcLcLFitcLcLFitConfig().

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

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

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

Definition at line 78 of file FitConfig.h.

References fSettings.

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

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

Definition at line 83 of file FitConfig.h.

References fSettings.

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

get the vector of parameter settings (const method)

Definition at line 88 of file FitConfig.h.

References fSettings.

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

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

Definition at line 93 of file FitConfig.h.

References fSettings.

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

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.

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

create a new minimizer according to chosen configuration

ROOT::Math::MinimizerOptions& ROOT::Fit::FitConfig::MinimizerOptions (  )  [inline]

access to the minimizer control parameter (non const method)

Definition at line 118 of file FitConfig.h.

References fMinimizerOpts.

void ROOT::Fit::FitConfig::SetMinimizerOptions ( const ROOT::Math::MinimizerOptions &  minopt  ) 

set all the minimizer options using class MinimizerOptions

void ROOT::Fit::FitConfig::SetMinimizer ( const char *  type,
const char *  algo = 0 
) [inline]

set minimizer type

Definition at line 132 of file FitConfig.h.

References fMinimizerOpts, ROOT::Math::MinimizerOptions::SetMinimizerAlgorithm(), and ROOT::Math::MinimizerOptions::SetMinimizerType().

const std::string& ROOT::Fit::FitConfig::MinimizerType (  )  const [inline]

return type of minimizer package

Definition at line 140 of file FitConfig.h.

References fMinimizerOpts, and ROOT::Math::MinimizerOptions::MinimizerType().

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

return type of minimizer algorithms

Definition at line 145 of file FitConfig.h.

References fMinimizerOpts, and ROOT::Math::MinimizerOptions::MinimizerAlgorithm().

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

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

Definition at line 151 of file FitConfig.h.

References fNormErrors.

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

do analysis for parabolic errors

Definition at line 154 of file FitConfig.h.

References fParabErrors.

bool ROOT::Fit::FitConfig::MinosErrors (  )  const [inline]

do minos errros analysis on the parameters

Definition at line 157 of file FitConfig.h.

References fMinosErrors.

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 160 of file FitConfig.h.

References fMinosParams.

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 165 of file FitConfig.h.

References fNormErrors.

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

set parabolic erros

Definition at line 168 of file FitConfig.h.

References fParabErrors.

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

set Minos erros

Definition at line 171 of file FitConfig.h.

References fMinosErrors.

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 176 of file FitConfig.h.

References fMinosErrors, and fMinosParams.

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

static function to control default minimizer type and algorithm

Member Data Documentation

bool ROOT::Fit::FitConfig::fNormErrors [private]

Definition at line 194 of file FitConfig.h.

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

bool ROOT::Fit::FitConfig::fParabErrors [private]

Definition at line 195 of file FitConfig.h.

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

bool ROOT::Fit::FitConfig::fMinosErrors [private]

Definition at line 196 of file FitConfig.h.

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

std::vector<ROOT::Fit::ParameterSettings> ROOT::Fit::FitConfig::fSettings [private]

Definition at line 199 of file FitConfig.h.

Referenced by CreateMinimizer(), CreateParamsSettings(), operator=(), ParamsSettings(), ParSettings(), and SetParamsSettings().

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

Definition at line 200 of file FitConfig.h.

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

ROOT::Math::MinimizerOptions ROOT::Fit::FitConfig::fMinimizerOpts [private]

Definition at line 202 of file FitConfig.h.

Referenced by CreateMinimizer(), MinimizerAlgoType(), MinimizerOptions(), MinimizerType(), operator=(), SetMinimizer(), and SetMinimizerOptions().

std::vector<ROOT::Fit::ParameterSettings> ROOT::Fit::FitConfig::fSettings [private]

Definition at line 199 of file FitConfig.h.

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

Definition at line 200 of file FitConfig.h.

The documentation for this class was generated from the following files:
Generated on Tue Jul 5 16:59:08 2011 for ROOT_528-00b_version by  doxygen 1.5.1