root/Fit/DataOptions.h

0001 // @(#)root/mathcore:$Id$
0002 // Author: L. Moneta Wed Aug 30 11:04:59 2006
0003
0004 /**********************************************************************
0005  *                                                                    *
0006  * Copyright (c) 2006  LCG ROOT Math Team, CERN/PH-SFT                *
0007  *                                                                    *
0008  *                                                                    *
0009  **********************************************************************/
0010
0011 // Header file for class DataOptions
0012
0013 #ifndef ROOT_Fit_DataOptions
0014 #define ROOT_Fit_DataOptions
0015
0016
0017 namespace ROOT {
0018
0019    namespace Fit {
0020
0021
0022 //___________________________________________________________________________________
0023 /**
0024    DataOptions : simple structure holding the options on how the data are filled
0025
0026    @ingroup FitData
0027 */
0028 struct DataOptions {
0029
0030
0031    /**
0032       Default constructor: use the default options
0033    */
0034    DataOptions () :
0035       fIntegral(false),
0036       fBinVolume(false),
0037       fNormBinVolume(false),
0038       fUseEmpty(false),
0039       fUseRange(false),
0040       fErrors1(false),
0041       fExpErrors(false),
0042       fCoordErrors(true),
0043       fAsymErrors(true)
0044    {}
0045
0046
0047    bool fIntegral;      ///< use integral of bin content instead of bin center (default is false)
0048    bool fBinVolume;     ///< normalize data by the bin volume (it is used in the Poisson likelihood fits)
0049    bool fNormBinVolume; ///< normalize data by a normalized the bin volume (bin volume divided by a reference value)
0050    bool fUseEmpty;      ///< use empty bins (default is false) with a fixed error of 1
0051    bool fUseRange;      ///< use the function range when creating the fit data (default is false)
0052    bool fErrors1;       ///< use all errors equal to 1, i.e. fit without errors (default is false)
0053    bool fExpErrors;     ///< use expected errors from the function and not from the data
0054    bool fCoordErrors;   ///< use errors on the x coordinates when available (default is true)
0055    bool fAsymErrors;    ///< use asymmetric errors in the value when available, selecting them according to the on sign of residual (default is true)
0056
0057
0058 };
0059
0060    } // end namespace Fit
0061
0062 } // end namespace ROOT
0063
0064
0065 #endif /* ROOT_Fit_DataOptions */