ROOT  6.06/09
Reference Guide
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Friends | List of all members
TMVA::MethodBase Class Referenceabstract

Definition at line 91 of file MethodBase.h.

Public Types

enum  EWeightFileType { kROOT =0, kTEXT }
 
- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 

Public Member Functions

 MethodBase (const TString &jobName, Types::EMVA methodType, const TString &methodTitle, DataSetInfo &dsi, const TString &theOption="", TDirectory *theBaseDir=0)
 standard constructur More...
 
 MethodBase (Types::EMVA methodType, DataSetInfo &dsi, const TString &weightFile, TDirectory *theBaseDir=0)
 constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles More...
 
virtual ~MethodBase ()
 destructor More...
 
void SetupMethod ()
 setup of methods More...
 
void ProcessSetup ()
 process all options the "CheckForUnusedOptions" is done in an independent call, since it may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase) More...
 
virtual void CheckSetup ()
 check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase) More...
 
void AddOutput (Types::ETreeType type, Types::EAnalysisType analysisType)
 
void TrainMethod ()
 
virtual std::map< TString, Double_tOptimizeTuningParameters (TString fomType="ROCIntegral", TString fitType="FitGA")
 call the Optimzier with the set of paremeters and ranges that are meant to be tuned. More...
 
virtual void SetTuneParameters (std::map< TString, Double_t > tuneParameters)
 set the tuning parameters accoding to the argument This is just a dummy . More...
 
virtual void Train ()=0
 
void SetTrainTime (Double_t trainTime)
 
Double_t GetTrainTime () const
 
void SetTestTime (Double_t testTime)
 
Double_t GetTestTime () const
 
virtual void TestClassification ()
 initialization More...
 
virtual Double_t GetKSTrainingVsTest (Char_t SorB, TString opt="X")
 
virtual void TestMulticlass ()
 test multiclass classification More...
 
virtual void TestRegression (Double_t &bias, Double_t &biasT, Double_t &dev, Double_t &devT, Double_t &rms, Double_t &rmsT, Double_t &mInf, Double_t &mInfT, Double_t &corr, Types::ETreeType type)
 calculate <sum-of-deviation-squared> of regression output versus "true" value from test sample More...
 
virtual void Init ()=0
 
virtual void DeclareOptions ()=0
 
virtual void ProcessOptions ()=0
 
virtual void DeclareCompatibilityOptions ()
 options that are used ONLY for the READER to ensure backward compatibility they are hence without any effect (the reader is only reading the training options that HAD been used at the training of the .xml weightfile at hand More...
 
virtual void Reset ()
 
virtual Double_t GetMvaValue (Double_t *errLower=0, Double_t *errUpper=0)=0
 
Double_t GetMvaValue (const TMVA::Event *const ev, Double_t *err=0, Double_t *errUpper=0)
 
const std::vector< Float_t > & GetRegressionValues (const TMVA::Event *const ev)
 
virtual const std::vector< Float_t > & GetRegressionValues ()
 
virtual const std::vector< Float_t > & GetMulticlassValues ()
 
virtual Double_t GetProba (const Event *ev)
 
virtual Double_t GetProba (Double_t mvaVal, Double_t ap_sig)
 compute likelihood ratio More...
 
virtual Double_t GetRarity (Double_t mvaVal, Types::ESBType reftype=Types::kBackground) const
 compute rarity: R(x) = Integrate_[-oo..x] { PDF(x') dx' } where PDF(x) is the PDF of the classifier's signal or background distribution More...
 
virtual const RankingCreateRanking ()=0
 
virtual void MakeClass (const TString &classFileName=TString("")) const
 create reader class for method (classification only at present) More...
 
void PrintHelpMessage () const
 prints out method-specific help method More...
 
void WriteStateToFile () const
 write options and weights to file note that each one text file for the main configuration information and one ROOT file for ROOT objects are created More...
 
void ReadStateFromFile ()
 Function to write options and weights to file. More...
 
void ReadStateFromStream (std::istream &tf)
 read the header from the weight files of the different MVA methods More...
 
void ReadStateFromStream (TFile &rf)
 write reference MVA distributions (and other information) to a ROOT type weight file More...
 
void ReadStateFromXMLString (const char *xmlstr)
 for reading from memory More...
 
virtual void WriteEvaluationHistosToFile (Types::ETreeType treetype)
 writes all MVA evaluation histograms to file More...
 
virtual void WriteMonitoringHistosToFile () const
 write special monitoring histograms to file dummy implementation here --------------— More...
 
virtual Double_t GetEfficiency (const TString &, Types::ETreeType, Double_t &err)
 fill background efficiency (resp. More...
 
virtual Double_t GetTrainingEfficiency (const TString &)
 
virtual std::vector< Float_tGetMulticlassEfficiency (std::vector< std::vector< Float_t > > &purity)
 
virtual std::vector< Float_tGetMulticlassTrainingEfficiency (std::vector< std::vector< Float_t > > &purity)
 
virtual Double_t GetSignificance () const
 compute significance of mean difference significance = |<S> - |/Sqrt(RMS_S2 + RMS_B2) More...
 
virtual Double_t GetROCIntegral (TH1D *histS, TH1D *histB) const
 calculate the area (integral) under the ROC curve as a overall quality measure of the classification More...
 
virtual Double_t GetROCIntegral (PDF *pdfS=0, PDF *pdfB=0) const
 calculate the area (integral) under the ROC curve as a overall quality measure of the classification More...
 
virtual Double_t GetMaximumSignificance (Double_t SignalEvents, Double_t BackgroundEvents, Double_t &optimal_significance_value) const
 plot significance, S/Sqrt(S^2 + B^2), curve for given number of signal and background events; returns cut for maximum significance also returned via reference is the maximum significance More...
 
virtual Double_t GetSeparation (TH1 *, TH1 *) const
 compute "separation" defined as <s2> = (1/2) Int_-oo..+oo { (S(x) - B(x))^2/(S(x) + B(x)) dx } More...
 
virtual Double_t GetSeparation (PDF *pdfS=0, PDF *pdfB=0) const
 compute "separation" defined as <s2> = (1/2) Int_-oo..+oo { (S(x) - B(x))^2/(S(x) + B(x)) dx } More...
 
virtual void GetRegressionDeviation (UInt_t tgtNum, Types::ETreeType type, Double_t &stddev, Double_t &stddev90Percent) const
 
const TStringGetJobName () const
 
const TStringGetMethodName () const
 
TString GetMethodTypeName () const
 
Types::EMVA GetMethodType () const
 
const char * GetName () const
 Returns name of object. More...
 
const TStringGetTestvarName () const
 
const TString GetProbaName () const
 
TString GetWeightFileName () const
 retrieve weight file name More...
 
void SetTestvarName (const TString &v="")
 
UInt_t GetNvar () const
 
UInt_t GetNVariables () const
 
UInt_t GetNTargets () const
 
const TStringGetInputVar (Int_t i) const
 
const TStringGetInputLabel (Int_t i) const
 
const TStringGetInputTitle (Int_t i) const
 
Double_t GetMean (Int_t ivar) const
 
Double_t GetRMS (Int_t ivar) const
 
Double_t GetXmin (Int_t ivar) const
 
Double_t GetXmax (Int_t ivar) const
 
Double_t GetSignalReferenceCut () const
 
Double_t GetSignalReferenceCutOrientation () const
 
void SetSignalReferenceCut (Double_t cut)
 
void SetSignalReferenceCutOrientation (Double_t cutOrientation)
 
TDirectoryBaseDir () const
 returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored More...
 
TDirectoryMethodBaseDir () const
 returns the ROOT directory where all instances of the corresponding MVA method are stored More...
 
void SetMethodDir (TDirectory *methodDir)
 
void SetBaseDir (TDirectory *methodDir)
 
void SetMethodBaseDir (TDirectory *methodDir)
 
UInt_t GetTrainingTMVAVersionCode () const
 
UInt_t GetTrainingROOTVersionCode () const
 
TString GetTrainingTMVAVersionString () const
 calculates the TMVA version string from the training version code on the fly More...
 
TString GetTrainingROOTVersionString () const
 calculates the ROOT version string from the training version code on the fly More...
 
TransformationHandlerGetTransformationHandler (Bool_t takeReroutedIfAvailable=true)
 
const TransformationHandlerGetTransformationHandler (Bool_t takeReroutedIfAvailable=true) const
 
void RerouteTransformationHandler (TransformationHandler *fTargetTransformation)
 
DataSetData () const
 
DataSetInfoDataInfo () const
 
UInt_t GetNEvents () const
 temporary event when testing on a different DataSet than the own one More...
 
const EventGetEvent () const
 
const EventGetEvent (const TMVA::Event *ev) const
 
const EventGetEvent (Long64_t ievt) const
 
const EventGetEvent (Long64_t ievt, Types::ETreeType type) const
 
const EventGetTrainingEvent (Long64_t ievt) const
 
const EventGetTestingEvent (Long64_t ievt) const
 
const std::vector< TMVA::Event * > & GetEventCollection (Types::ETreeType type)
 returns the event collection (i.e. More...
 
virtual Bool_t IsSignalLike ()
 uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event would be selected as signal or background More...
 
virtual Bool_t IsSignalLike (Double_t mvaVal)
 uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event with this mva output value would tbe selected as signal or background More...
 
Bool_t HasMVAPdfs () const
 
virtual void SetAnalysisType (Types::EAnalysisType type)
 
Types::EAnalysisType GetAnalysisType () const
 
Bool_t DoRegression () const
 
Bool_t DoMulticlass () const
 
void DisableWriting (Bool_t setter)
 
- Public Member Functions inherited from TMVA::IMethod
 IMethod ()
 
virtual ~IMethod ()
 
virtual Bool_t HasAnalysisType (Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets)=0
 
- Public Member Functions inherited from TMVA::Configurable
 Configurable (const TString &theOption="")
 
virtual ~Configurable ()
 default destructur More...
 
virtual void ParseOptions ()
 options parser More...
 
void PrintOptions () const
 prints out the options set in the options string and the defaults More...
 
const char * GetConfigName () const
 
const char * GetConfigDescription () const
 
void SetConfigName (const char *n)
 
void SetConfigDescription (const char *d)
 
template<class T >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
template<class T >
void AddPreDefVal (const T &)
 
template<class T >
void AddPreDefVal (const TString &optname, const T &)
 
void CheckForUnusedOptions () const
 checks for unused options in option string More...
 
const TStringGetOptions () const
 
void SetOptions (const TString &s)
 
void WriteOptionsToStream (std::ostream &o, const TString &prefix) const
 write options to output stream (e.g. in writing the MVA weight files More...
 
void ReadOptionsFromStream (std::istream &istr)
 read option back from the weight file More...
 
void AddOptionsXMLTo (void *parent) const
 write options to XML file More...
 
void ReadOptionsFromXML (void *node)
 
void SetMsgType (EMsgType t)
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc)
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Public Attributes

const EventfTmpEvent
 
Bool_t fSetupCompleted
 

Protected Member Functions

void NoErrorCalc (Double_t *const err, Double_t *const errUpper)
 
virtual void AddWeightsXMLTo (void *parent) const =0
 
virtual void ReadWeightsFromXML (void *wghtnode)=0
 
virtual void ReadWeightsFromStream (std::istream &)=0
 
virtual void ReadWeightsFromStream (TFile &)
 
void SetWeightFileName (TString)
 set the weight file name (depreciated) More...
 
const TStringGetWeightFileDir () const
 
void SetWeightFileDir (TString fileDir)
 set directory of weight file More...
 
Bool_t IsNormalised () const
 
void SetNormalised (Bool_t norm)
 
Bool_t Verbose () const
 
Bool_t Help () const
 
const TStringGetInternalVarName (Int_t ivar) const
 
const TStringGetOriginalVarName (Int_t ivar) const
 
Bool_t HasTrainingTree () const
 
virtual void MakeClassSpecific (std::ostream &, const TString &="") const
 
virtual void MakeClassSpecificHeader (std::ostream &, const TString &="") const
 
void Statistics (Types::ETreeType treeType, const TString &theVarName, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &)
 calculates rms,mean, xmin, xmax of the event variable this can be either done for the variables as they are or for normalised variables (in the range of 0-1) if "norm" is set to kTRUE More...
 
Bool_t TxtWeightsOnly () const
 
Bool_t IsConstructedFromWeightFile () const
 
Bool_t IgnoreEventsWithNegWeightsInTraining () const
 
- Protected Member Functions inherited from TMVA::IMethod
virtual void GetHelpMessage () const =0
 
- Protected Member Functions inherited from TMVA::Configurable
Bool_t LooseOptionCheckingEnabled () const
 
void EnableLooseOptions (Bool_t b=kTRUE)
 
void WriteOptionsReferenceToFile ()
 write complete options to output stream More...
 
void ResetSetFlag ()
 resets the IsSet falg for all declare options to be called before options are read from stream More...
 
const TStringGetReferenceFile () const
 
MsgLoggerLog () const
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Static Protected Member Functions

static MethodBaseGetThisBase ()
 return a pointer the base class of this method More...
 

Protected Attributes

RankingfRanking
 
std::vector< TString > * fInputVars
 
Int_t fNbins
 
Int_t fNbinsMVAoutput
 
Int_t fNbinsH
 
Types::EAnalysisType fAnalysisType
 
std::vector< Float_t > * fRegressionReturnVal
 
std::vector< Float_t > * fMulticlassReturnVal
 
UInt_t fSignalClass
 
UInt_t fBackgroundClass
 

Private Types

enum  ECutOrientation { kNegative = -1, kPositive = +1 }
 

Private Member Functions

void WriteStateToXML (void *parent) const
 general method used in writing the header of the weight files where the used variables, variable transformation type etc. More...
 
void ReadStateFromXML (void *parent)
 
void WriteStateToStream (std::ostream &tf) const
 general method used in writing the header of the weight files where the used variables, variable transformation type etc. More...
 
void WriteVarsToStream (std::ostream &tf, const TString &prefix="") const
 write the list of variables (name, min, max) for a given data transformation method to the stream More...
 
void AddVarsXMLTo (void *parent) const
 write variable info to XML More...
 
void AddSpectatorsXMLTo (void *parent) const
 write spectator info to XML More...
 
void AddTargetsXMLTo (void *parent) const
 write target info to XML More...
 
void AddClassesXMLTo (void *parent) const
 write class info to XML More...
 
void ReadVariablesFromXML (void *varnode)
 read variable info from XML More...
 
void ReadSpectatorsFromXML (void *specnode)
 read spectator info from XML More...
 
void ReadTargetsFromXML (void *tarnode)
 read target info from XML More...
 
void ReadClassesFromXML (void *clsnode)
 read number of classes from XML More...
 
void ReadVarsFromStream (std::istream &istr)
 Read the variables (name, min, max) for a given data transformation method from the stream. More...
 
void InitBase ()
 default initialization called by all constructors More...
 
void DeclareBaseOptions ()
 define the options (their key words) that can be set in the option string here the options valid for ALL MVA methods are declared. More...
 
void ProcessBaseOptions ()
 the option string is decoded, for availabel options see "DeclareOptions" More...
 
ECutOrientation GetCutOrientation () const
 
void ResetThisBase ()
 reset required for RootFinder More...
 
void CreateMVAPdfs ()
 Create PDFs of the MVA output variables. More...
 
Double_t GetEffForRoot (Double_t)
 returns efficiency as function of cut More...
 
Bool_t GetLine (std::istream &fin, char *buf)
 reads one line from the input stream checks for certain keywords and interprets the line if keywords are found More...
 
virtual void AddClassifierOutput (Types::ETreeType type)
 prepare tree branch with the method's discriminating variable More...
 
virtual void AddClassifierOutputProb (Types::ETreeType type)
 prepare tree branch with the method's discriminating variable More...
 
virtual void AddRegressionOutput (Types::ETreeType type)
 prepare tree branch with the method's discriminating variable More...
 
virtual void AddMulticlassOutput (Types::ETreeType type)
 prepare tree branch with the method's discriminating variable More...
 
void AddInfoItem (void *gi, const TString &name, const TString &value) const
 xml writing More...
 

Static Private Member Functions

static Double_t IGetEffForRoot (Double_t)
 interface for RootFinder More...
 
static void CreateVariableTransforms (const TString &trafoDefinition, TMVA::DataSetInfo &dataInfo, TMVA::TransformationHandler &transformationHandler, TMVA::MsgLogger &log)
 create variable transformations More...
 
static MethodBase *& GetThisBaseThreadLocal ()
 

Private Attributes

Bool_t fDisableWriting
 
DataSetInfofDataSetInfo
 set to true in order to suppress writing to XML More...
 
Double_t fSignalReferenceCut
 the data set information (sometimes needed) More...
 
Double_t fSignalReferenceCutOrientation
 
Types::ESBType fVariableTransformType
 
TString fJobName
 
TString fMethodName
 
Types::EMVA fMethodType
 
TString fTestvar
 
UInt_t fTMVATrainingVersion
 
UInt_t fROOTTrainingVersion
 
Bool_t fConstructedFromWeightFile
 
TDirectoryfBaseDir
 
TDirectoryfMethodBaseDir
 
TString fParentDir
 
TString fFileDir
 
TString fWeightFile
 
TH1fEffS
 
PDFfDefaultPDF
 
PDFfMVAPdfS
 
PDFfMVAPdfB
 
PDFfSplS
 
PDFfSplB
 
TSplinefSpleffBvsS
 
PDFfSplTrainS
 
PDFfSplTrainB
 
TSplinefSplTrainEffBvsS
 
Double_t fMeanS
 
Double_t fMeanB
 
Double_t fRmsS
 
Double_t fRmsB
 
Double_t fXmin
 
Double_t fXmax
 
TString fVarTransformString
 
TransformationHandlerfTransformationPointer
 
TransformationHandler fTransformation
 
Bool_t fVerbose
 
TString fVerbosityLevelString
 
EMsgType fVerbosityLevel
 
Bool_t fHelp
 
Bool_t fHasMVAPdfs
 
Bool_t fIgnoreNegWeightsInTraining
 
Double_t fTrainTime
 
Double_t fTestTime
 
ECutOrientation fCutOrientation
 
TSpline1fSplRefS
 
TSpline1fSplRefB
 
TSpline1fSplTrainRefS
 
TSpline1fSplTrainRefB
 
std::vector< const std::vector< TMVA::Event * > * > fEventCollections
 
Bool_t fNormalise
 
Bool_t fUseDecorr
 
TString fVariableTransformTypeString
 
Bool_t fTxtWeightsOnly
 
Int_t fNbinsMVAPdf
 
Int_t fNsmoothMVAPdf
 

Friends

class Factory
 
class MethodCategory
 
class MethodCompositeBase
 
class MethodCuts
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TMVA/MethodBase.h>

+ Inheritance diagram for TMVA::MethodBase:
+ Collaboration diagram for TMVA::MethodBase:

Member Enumeration Documentation

Enumerator
kNegative 
kPositive 

Definition at line 467 of file MethodBase.h.

Enumerator
kROOT 
kTEXT 

Definition at line 97 of file MethodBase.h.

Constructor & Destructor Documentation

TMVA::MethodBase::MethodBase ( const TString jobName,
Types::EMVA  methodType,
const TString methodTitle,
DataSetInfo dsi,
const TString theOption = "",
TDirectory theBaseDir = 0 
)

standard constructur

Definition at line 132 of file MethodBase.cxx.

TMVA::MethodBase::MethodBase ( Types::EMVA  methodType,
DataSetInfo dsi,
const TString weightFile,
TDirectory theBaseDir = 0 
)

constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles

Definition at line 198 of file MethodBase.cxx.

TMVA::MethodBase::~MethodBase ( void  )
virtual

destructor

Definition at line 254 of file MethodBase.cxx.

Member Function Documentation

void TMVA::MethodBase::AddClassesXMLTo ( void parent) const
private

write class info to XML

Definition at line 1703 of file MethodBase.cxx.

void TMVA::MethodBase::AddClassifierOutput ( Types::ETreeType  type)
privatevirtual

prepare tree branch with the method's discriminating variable

Definition at line 852 of file MethodBase.cxx.

void TMVA::MethodBase::AddClassifierOutputProb ( Types::ETreeType  type)
privatevirtual

prepare tree branch with the method's discriminating variable

Definition at line 890 of file MethodBase.cxx.

void TMVA::MethodBase::AddInfoItem ( void gi,
const TString name,
const TString value 
) const
private

xml writing

Definition at line 1208 of file MethodBase.cxx.

void TMVA::MethodBase::AddMulticlassOutput ( Types::ETreeType  type)
privatevirtual

prepare tree branch with the method's discriminating variable

Definition at line 779 of file MethodBase.cxx.

void TMVA::MethodBase::AddOutput ( Types::ETreeType  type,
Types::EAnalysisType  analysisType 
)

Definition at line 1217 of file MethodBase.cxx.

Referenced by TMVA::Factory::TestAllMethods().

void TMVA::MethodBase::AddRegressionOutput ( Types::ETreeType  type)
privatevirtual

prepare tree branch with the method's discriminating variable

Definition at line 740 of file MethodBase.cxx.

void TMVA::MethodBase::AddSpectatorsXMLTo ( void parent) const
private

write spectator info to XML

Definition at line 1680 of file MethodBase.cxx.

void TMVA::MethodBase::AddTargetsXMLTo ( void parent) const
private

write target info to XML

Definition at line 1723 of file MethodBase.cxx.

void TMVA::MethodBase::AddVarsXMLTo ( void parent) const
private

write variable info to XML

Definition at line 1664 of file MethodBase.cxx.

virtual void TMVA::MethodBase::AddWeightsXMLTo ( void parent) const
protectedpure virtual
TDirectory * TMVA::MethodBase::BaseDir ( ) const

returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored

Definition at line 1882 of file MethodBase.cxx.

Referenced by TMVA::MethodRuleFit::GetMethodBaseDir(), TMVA::MethodBoost::WriteEvaluationHistosToFile(), TMVA::MethodBoost::WriteMonitoringHistosToFile(), and TMVA::OptimizeConfigParameters::~OptimizeConfigParameters().

void TMVA::MethodBase::CheckSetup ( )
virtual

check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase)

Reimplemented in TMVA::MethodCuts, TMVA::MethodFDA, and TMVA::MethodBoost.

Definition at line 320 of file MethodBase.cxx.

Referenced by TMVA::MethodCategory::AddMethod(), TMVA::Factory::BookMethod(), TMVA::Reader::BookMVA(), and TMVA::MethodCompositeBase::ReadWeightsFromXML().

void TMVA::MethodBase::CreateMVAPdfs ( )
private

Create PDFs of the MVA output variables.

Definition at line 2061 of file MethodBase.cxx.

virtual const Ranking* TMVA::MethodBase::CreateRanking ( )
pure virtual
void TMVA::MethodBase::CreateVariableTransforms ( const TString trafoDefinition,
TMVA::DataSetInfo dataInfo,
TMVA::TransformationHandler transformationHandler,
TMVA::MsgLogger log 
)
staticprivate

create variable transformations

Definition at line 481 of file MethodBase.cxx.

Referenced by ProcessBaseOptions(), and TMVA::Factory::WriteDataInformation().

DataSet* TMVA::MethodBase::Data ( ) const
inline
DataSetInfo& TMVA::MethodBase::DataInfo ( ) const
inline
void TMVA::MethodBase::DeclareBaseOptions ( )
private

define the options (their key words) that can be set in the option string here the options valid for ALL MVA methods are declared.

know options: VariableTransform=None,Decorrelated,PCA to use transformed variables instead of the original ones VariableTransformType=Signal,Background which decorrelation matrix to use in the method. Only the Likelihood Method can make proper use of independent transformations of signal and background fNbinsMVAPdf = 50 Number of bins used to create a PDF of MVA fNsmoothMVAPdf = 2 Number of times a histogram is smoothed before creating the PDF fHasMVAPdfs create PDFs for the MVA outputs V for Verbose output (!V) for non verbos H for Help message

Definition at line 396 of file MethodBase.cxx.

void TMVA::MethodBase::DeclareCompatibilityOptions ( )
virtual
virtual void TMVA::MethodBase::DeclareOptions ( )
pure virtual
void TMVA::MethodBase::DisableWriting ( Bool_t  setter)
inline

Definition at line 396 of file MethodBase.h.

Referenced by TMVA::MethodCategory::AddMethod().

Bool_t TMVA::MethodBase::DoMulticlass ( ) const
inline

Definition at line 393 of file MethodBase.h.

Referenced by TMVA::Factory::EvaluateAllMethods().

Bool_t TMVA::MethodBase::DoRegression ( ) const
inline

Definition at line 392 of file MethodBase.h.

Referenced by TMVA::Factory::EvaluateAllMethods().

Types::EAnalysisType TMVA::MethodBase::GetAnalysisType ( ) const
inline

Definition at line 391 of file MethodBase.h.

Referenced by TMVA::Factory::TestAllMethods().

ECutOrientation TMVA::MethodBase::GetCutOrientation ( ) const
inlineprivate

Definition at line 468 of file MethodBase.h.

Double_t TMVA::MethodBase::GetEffForRoot ( Double_t  theCut)
private

returns efficiency as function of cut

Definition at line 3137 of file MethodBase.cxx.

Referenced by IGetEffForRoot().

Double_t TMVA::MethodBase::GetEfficiency ( const TString theString,
Types::ETreeType  type,
Double_t effSerr 
)
virtual

fill background efficiency (resp.

rejection) versus signal efficiency plots returns signal efficiency at background efficiency indicated in theString

Reimplemented in TMVA::MethodCuts.

Definition at line 2174 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

const TMVA::Event * TMVA::MethodBase::GetEvent ( ) const
inline
const TMVA::Event * TMVA::MethodBase::GetEvent ( const TMVA::Event ev) const
inline

Definition at line 662 of file MethodBase.h.

const TMVA::Event * TMVA::MethodBase::GetEvent ( Long64_t  ievt) const
inline

Definition at line 675 of file MethodBase.h.

const TMVA::Event * TMVA::MethodBase::GetEvent ( Long64_t  ievt,
Types::ETreeType  type 
) const
inline

Definition at line 681 of file MethodBase.h.

const std::vector< TMVA::Event * > & TMVA::MethodBase::GetEventCollection ( Types::ETreeType  type)

returns the event collection (i.e.

the dataset) TRANSFORMED using the classifiers specific Variable Transformation (e.g. Decorr or Decorr:Gauss:Decorr)

Definition at line 3164 of file MethodBase.cxx.

const TString& TMVA::MethodBase::GetInputLabel ( Int_t  i) const
inline

Definition at line 315 of file MethodBase.h.

const TString& TMVA::MethodBase::GetInputTitle ( Int_t  i) const
inline

Definition at line 316 of file MethodBase.h.

const TString& TMVA::MethodBase::GetInputVar ( Int_t  i) const
inline

Definition at line 314 of file MethodBase.h.

const TString& TMVA::MethodBase::GetInternalVarName ( Int_t  ivar) const
inlineprotected

Definition at line 425 of file MethodBase.h.

const TString& TMVA::MethodBase::GetJobName ( ) const
inline

Definition at line 295 of file MethodBase.h.

Referenced by TMVA::MethodCompositeBase::AddWeightsXMLTo().

Double_t TMVA::MethodBase::GetKSTrainingVsTest ( Char_t  SorB,
TString  opt = "X" 
)
virtual

Definition at line 3224 of file MethodBase.cxx.

Bool_t TMVA::MethodBase::GetLine ( std::istream &  fin,
char *  buf 
)
private

reads one line from the input stream checks for certain keywords and interprets the line if keywords are found

Definition at line 2018 of file MethodBase.cxx.

Double_t TMVA::MethodBase::GetMaximumSignificance ( Double_t  SignalEvents,
Double_t  BackgroundEvents,
Double_t optimal_significance_value 
) const
virtual

plot significance, S/Sqrt(S^2 + B^2), curve for given number of signal and background events; returns cut for maximum significance also returned via reference is the maximum significance

Definition at line 2713 of file MethodBase.cxx.

Double_t TMVA::MethodBase::GetMean ( Int_t  ivar) const
inline

Definition at line 319 of file MethodBase.h.

const TString& TMVA::MethodBase::GetMethodName ( ) const
inline
Types::EMVA TMVA::MethodBase::GetMethodType ( ) const
inline
TString TMVA::MethodBase::GetMethodTypeName ( ) const
inline
std::vector< Float_t > TMVA::MethodBase::GetMulticlassEfficiency ( std::vector< std::vector< Float_t > > &  purity)
virtual

Definition at line 2577 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

std::vector< Float_t > TMVA::MethodBase::GetMulticlassTrainingEfficiency ( std::vector< std::vector< Float_t > > &  purity)
virtual

Definition at line 2589 of file MethodBase.cxx.

virtual const std::vector<Float_t>& TMVA::MethodBase::GetMulticlassValues ( )
inlinevirtual
virtual Double_t TMVA::MethodBase::GetMvaValue ( Double_t errLower = 0,
Double_t errUpper = 0 
)
pure virtual
Double_t TMVA::MethodBase::GetMvaValue ( const TMVA::Event *const  ev,
Double_t err = 0,
Double_t errUpper = 0 
)

Definition at line 827 of file MethodBase.cxx.

const char* TMVA::MethodBase::GetName ( ) const
inlinevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TMVA::Configurable.

Definition at line 299 of file MethodBase.h.

Referenced by TMVA::MethodCategory::AddMethod(), and TMVA::Factory::OptimizeAllMethods().

UInt_t TMVA::MethodBase::GetNEvents ( void  ) const
inline

temporary event when testing on a different DataSet than the own one

Definition at line 371 of file MethodBase.h.

UInt_t TMVA::MethodBase::GetNTargets ( ) const
inline

Definition at line 311 of file MethodBase.h.

UInt_t TMVA::MethodBase::GetNvar ( ) const
inline

Definition at line 309 of file MethodBase.h.

Referenced by TMVA::MethodCFMlpANN::DataInterface().

UInt_t TMVA::MethodBase::GetNVariables ( ) const
inline

Definition at line 310 of file MethodBase.h.

const TString& TMVA::MethodBase::GetOriginalVarName ( Int_t  ivar) const
inlineprotected

Definition at line 426 of file MethodBase.h.

Double_t TMVA::MethodBase::GetProba ( const Event ev)
virtual

Definition at line 2121 of file MethodBase.cxx.

Referenced by TMVA::Reader::GetProba().

Double_t TMVA::MethodBase::GetProba ( Double_t  mvaVal,
Double_t  ap_sig 
)
virtual

compute likelihood ratio

Definition at line 2138 of file MethodBase.cxx.

const TString TMVA::MethodBase::GetProbaName ( ) const
inline

Definition at line 301 of file MethodBase.h.

Double_t TMVA::MethodBase::GetRarity ( Double_t  mvaVal,
Types::ESBType  reftype = Types::kBackground 
) const
virtual

compute rarity: R(x) = Integrate_[-oo..x] { PDF(x') dx' } where PDF(x) is the PDF of the classifier's signal or background distribution

Reimplemented in TMVA::MethodCuts.

Definition at line 2157 of file MethodBase.cxx.

Referenced by TMVA::Reader::GetRarity().

void TMVA::MethodBase::GetRegressionDeviation ( UInt_t  tgtNum,
Types::ETreeType  type,
Double_t stddev,
Double_t stddev90Percent 
) const
virtual

Definition at line 720 of file MethodBase.cxx.

const std::vector<Float_t>& TMVA::MethodBase::GetRegressionValues ( const TMVA::Event *const  ev)
inline
virtual const std::vector<Float_t>& TMVA::MethodBase::GetRegressionValues ( )
inlinevirtual
Double_t TMVA::MethodBase::GetRMS ( Int_t  ivar) const
inline

Definition at line 320 of file MethodBase.h.

Double_t TMVA::MethodBase::GetROCIntegral ( TH1D histS,
TH1D histB 
) const
virtual

calculate the area (integral) under the ROC curve as a overall quality measure of the classification

Definition at line 2651 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods(), and TMVA::MethodBoost::GetBoostROCIntegral().

Double_t TMVA::MethodBase::GetROCIntegral ( PDF pdfS = 0,
PDF pdfB = 0 
) const
virtual

calculate the area (integral) under the ROC curve as a overall quality measure of the classification

Definition at line 2683 of file MethodBase.cxx.

Double_t TMVA::MethodBase::GetSeparation ( TH1 histoS,
TH1 histoB 
) const
virtual

compute "separation" defined as <s2> = (1/2) Int_-oo..+oo { (S(x) - B(x))^2/(S(x) + B(x)) dx }

Reimplemented in TMVA::MethodCuts.

Definition at line 2620 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

Double_t TMVA::MethodBase::GetSeparation ( PDF pdfS = 0,
PDF pdfB = 0 
) const
virtual

compute "separation" defined as <s2> = (1/2) Int_-oo..+oo { (S(x) - B(x))^2/(S(x) + B(x)) dx }

Reimplemented in TMVA::MethodCuts.

Definition at line 2629 of file MethodBase.cxx.

Double_t TMVA::MethodBase::GetSignalReferenceCut ( ) const
inline
Double_t TMVA::MethodBase::GetSignalReferenceCutOrientation ( ) const
inline

Definition at line 326 of file MethodBase.h.

Referenced by TMVA::MethodCompositeBase::AddWeightsXMLTo().

Double_t TMVA::MethodBase::GetSignificance ( void  ) const
virtual

compute significance of mean difference significance = |<S> - |/Sqrt(RMS_S2 + RMS_B2)

Reimplemented in TMVA::MethodCuts.

Definition at line 2609 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

const TMVA::Event * TMVA::MethodBase::GetTestingEvent ( Long64_t  ievt) const
inline

Definition at line 693 of file MethodBase.h.

Double_t TMVA::MethodBase::GetTestTime ( ) const
inline

Definition at line 143 of file MethodBase.h.

const TString& TMVA::MethodBase::GetTestvarName ( ) const
inline
TMVA::MethodBase * TMVA::MethodBase::GetThisBase ( )
staticprotected

return a pointer the base class of this method

Definition at line 3210 of file MethodBase.cxx.

Referenced by IGetEffForRoot().

static MethodBase*& TMVA::MethodBase::GetThisBaseThreadLocal ( )
inlinestaticprivate

Definition at line 633 of file MethodBase.h.

Double_t TMVA::MethodBase::GetTrainingEfficiency ( const TString theString)
virtual

Reimplemented in TMVA::MethodCuts.

Definition at line 2402 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

const TMVA::Event * TMVA::MethodBase::GetTrainingEvent ( Long64_t  ievt) const
inline

Definition at line 687 of file MethodBase.h.

UInt_t TMVA::MethodBase::GetTrainingROOTVersionCode ( ) const
inline

Definition at line 344 of file MethodBase.h.

TString TMVA::MethodBase::GetTrainingROOTVersionString ( ) const

calculates the ROOT version string from the training version code on the fly

Definition at line 3198 of file MethodBase.cxx.

UInt_t TMVA::MethodBase::GetTrainingTMVAVersionCode ( ) const
inline

Definition at line 343 of file MethodBase.h.

TString TMVA::MethodBase::GetTrainingTMVAVersionString ( ) const

calculates the TMVA version string from the training version code on the fly

Definition at line 3186 of file MethodBase.cxx.

Double_t TMVA::MethodBase::GetTrainTime ( ) const
inline

Definition at line 139 of file MethodBase.h.

TransformationHandler& TMVA::MethodBase::GetTransformationHandler ( Bool_t  takeReroutedIfAvailable = true)
inline

Definition at line 348 of file MethodBase.h.

Referenced by GetEvent(), GetMean(), GetRMS(), GetXmax(), and GetXmin().

const TransformationHandler& TMVA::MethodBase::GetTransformationHandler ( Bool_t  takeReroutedIfAvailable = true) const
inline

Definition at line 352 of file MethodBase.h.

const TString& TMVA::MethodBase::GetWeightFileDir ( ) const
inlineprotected
TString TMVA::MethodBase::GetWeightFileName ( ) const

retrieve weight file name

Definition at line 1961 of file MethodBase.cxx.

Referenced by TMVA::Factory::TrainAllMethods().

Double_t TMVA::MethodBase::GetXmax ( Int_t  ivar) const
inline

Definition at line 322 of file MethodBase.h.

Double_t TMVA::MethodBase::GetXmin ( Int_t  ivar) const
inline

Definition at line 321 of file MethodBase.h.

Bool_t TMVA::MethodBase::HasMVAPdfs ( ) const
inline

Definition at line 389 of file MethodBase.h.

Bool_t TMVA::MethodBase::HasTrainingTree ( ) const
inlineprotected

Definition at line 428 of file MethodBase.h.

Bool_t TMVA::MethodBase::Help ( ) const
inlineprotected

Definition at line 419 of file MethodBase.h.

Double_t TMVA::MethodBase::IGetEffForRoot ( Double_t  theCut)
staticprivate

interface for RootFinder

Definition at line 3129 of file MethodBase.cxx.

Bool_t TMVA::MethodBase::IgnoreEventsWithNegWeightsInTraining ( ) const
inlineprotected

Definition at line 602 of file MethodBase.h.

virtual void TMVA::MethodBase::Init ( )
pure virtual
void TMVA::MethodBase::InitBase ( )
private

default initialization called by all constructors

Definition at line 328 of file MethodBase.cxx.

Bool_t TMVA::MethodBase::IsConstructedFromWeightFile ( ) const
inlineprotected

Definition at line 455 of file MethodBase.h.

Bool_t TMVA::MethodBase::IsNormalised ( ) const
inlineprotected

Definition at line 411 of file MethodBase.h.

Bool_t TMVA::MethodBase::IsSignalLike ( )
virtual

uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event would be selected as signal or background

Definition at line 838 of file MethodBase.cxx.

Referenced by TMVA::MethodBoost::AdaBoost(), and TMVA::MethodBoost::GetMvaValue().

Bool_t TMVA::MethodBase::IsSignalLike ( Double_t  mvaVal)
virtual

uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event with this mva output value would tbe selected as signal or background

Definition at line 845 of file MethodBase.cxx.

void TMVA::MethodBase::MakeClass ( const TString classFileName = TString("")) const
virtual

create reader class for method (classification only at present)

Implements TMVA::IMethod.

Reimplemented in TMVA::MethodCategory, TMVA::MethodTMlpANN, TMVA::MethodC50, and TMVA::MethodRXGB.

Definition at line 2834 of file MethodBase.cxx.

Referenced by TMVA::Factory::MakeClass().

virtual void TMVA::MethodBase::MakeClassSpecific ( std::ostream &  ,
const TString = "" 
) const
inlineprotectedvirtual
virtual void TMVA::MethodBase::MakeClassSpecificHeader ( std::ostream &  ,
const TString = "" 
) const
inlineprotectedvirtual

Reimplemented in TMVA::MethodBDT, TMVA::MethodCFMlpANN, and TMVA::MethodLikelihood.

Definition at line 438 of file MethodBase.h.

TDirectory * TMVA::MethodBase::MethodBaseDir ( ) const

returns the ROOT directory where all instances of the corresponding MVA method are stored

Definition at line 1920 of file MethodBase.cxx.

void TMVA::MethodBase::NoErrorCalc ( Double_t *const  err,
Double_t *const  errUpper 
)
protected
std::map< TString, Double_t > TMVA::MethodBase::OptimizeTuningParameters ( TString  fomType = "ROCIntegral",
TString  fitType = "FitGA" 
)
virtual

call the Optimzier with the set of paremeters and ranges that are meant to be tuned.

Reimplemented in TMVA::MethodBDT.

Definition at line 626 of file MethodBase.cxx.

Referenced by TMVA::Factory::OptimizeAllMethods().

void TMVA::MethodBase::PrintHelpMessage ( ) const
virtual

prints out method-specific help method

Implements TMVA::IMethod.

Definition at line 3073 of file MethodBase.cxx.

Referenced by TMVA::Factory::PrintHelpMessage().

void TMVA::MethodBase::ProcessBaseOptions ( )
private

the option string is decoded, for availabel options see "DeclareOptions"

Definition at line 427 of file MethodBase.cxx.

virtual void TMVA::MethodBase::ProcessOptions ( )
pure virtual
void TMVA::MethodBase::ProcessSetup ( )

process all options the "CheckForUnusedOptions" is done in an independent call, since it may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase)

Definition at line 310 of file MethodBase.cxx.

Referenced by TMVA::MethodCategory::AddMethod(), TMVA::Factory::BookMethod(), and TMVA::MethodCompositeBase::ReadWeightsFromXML().

void TMVA::MethodBase::ReadClassesFromXML ( void clsnode)
private

read number of classes from XML

Definition at line 1819 of file MethodBase.cxx.

void TMVA::MethodBase::ReadSpectatorsFromXML ( void specnode)
private

read spectator info from XML

Definition at line 1779 of file MethodBase.cxx.

void TMVA::MethodBase::ReadStateFromFile ( )

Function to write options and weights to file.

Definition at line 1327 of file MethodBase.cxx.

Referenced by TMVA::Reader::BookMVA(), and TMVA::Factory::TrainAllMethods().

void TMVA::MethodBase::ReadStateFromStream ( std::istream &  tf)

read the header from the weight files of the different MVA methods

Definition at line 1492 of file MethodBase.cxx.

void TMVA::MethodBase::ReadStateFromStream ( TFile rf)

write reference MVA distributions (and other information) to a ROOT type weight file

Definition at line 1287 of file MethodBase.cxx.

void TMVA::MethodBase::ReadStateFromXML ( void parent)
private

Definition at line 1386 of file MethodBase.cxx.

Referenced by TMVA::MethodCategory::ReadWeightsFromXML().

void TMVA::MethodBase::ReadStateFromXMLString ( const char *  xmlstr)

for reading from memory

Definition at line 1370 of file MethodBase.cxx.

Referenced by TMVA::Reader::BookMVA().

void TMVA::MethodBase::ReadTargetsFromXML ( void tarnode)
private

read target info from XML

Definition at line 1861 of file MethodBase.cxx.

void TMVA::MethodBase::ReadVariablesFromXML ( void varnode)
private

read variable info from XML

Definition at line 1739 of file MethodBase.cxx.

void TMVA::MethodBase::ReadVarsFromStream ( std::istream &  istr)
private

Read the variables (name, min, max) for a given data transformation method from the stream.

In the stream we only expect the limits which will be set

Definition at line 1627 of file MethodBase.cxx.

virtual void TMVA::MethodBase::ReadWeightsFromStream ( std::istream &  )
protectedpure virtual
virtual void TMVA::MethodBase::ReadWeightsFromStream ( TFile )
inlineprotectedvirtual
virtual void TMVA::MethodBase::ReadWeightsFromXML ( void wghtnode)
protectedpure virtual
void TMVA::MethodBase::RerouteTransformationHandler ( TransformationHandler fTargetTransformation)
inline

Definition at line 357 of file MethodBase.h.

Referenced by TMVA::MethodCompositeBase::ReadWeightsFromXML().

virtual void TMVA::MethodBase::Reset ( void  )
inlinevirtual

Reimplemented in TMVA::MethodPDEFoam, and TMVA::MethodBDT.

Definition at line 170 of file MethodBase.h.

void TMVA::MethodBase::ResetThisBase ( )
private

reset required for RootFinder

Definition at line 3218 of file MethodBase.cxx.

virtual void TMVA::MethodBase::SetAnalysisType ( Types::EAnalysisType  type)
inlinevirtual
void TMVA::MethodBase::SetBaseDir ( TDirectory methodDir)
inline

Definition at line 336 of file MethodBase.h.

void TMVA::MethodBase::SetMethodBaseDir ( TDirectory methodDir)
inline

Definition at line 337 of file MethodBase.h.

Referenced by TMVA::MethodCategory::AddMethod().

void TMVA::MethodBase::SetMethodDir ( TDirectory methodDir)
inline

Definition at line 335 of file MethodBase.h.

void TMVA::MethodBase::SetNormalised ( Bool_t  norm)
inlineprotected

Definition at line 412 of file MethodBase.h.

void TMVA::MethodBase::SetSignalReferenceCut ( Double_t  cut)
inline
void TMVA::MethodBase::SetSignalReferenceCutOrientation ( Double_t  cutOrientation)
inline
void TMVA::MethodBase::SetTestTime ( Double_t  testTime)
inline

Definition at line 142 of file MethodBase.h.

void TMVA::MethodBase::SetTestvarName ( const TString v = "")
inline

Definition at line 306 of file MethodBase.h.

Referenced by MethodBase(), and TMVA::Factory::TrainAllMethods().

void TMVA::MethodBase::SetTrainTime ( Double_t  trainTime)
inline

Definition at line 138 of file MethodBase.h.

void TMVA::MethodBase::SetTuneParameters ( std::map< TString, Double_t tuneParameters)
virtual

set the tuning parameters accoding to the argument This is just a dummy .

. have a look at the MethodBDT how you could perhaps implment the same thing for the other Classifiers..

Reimplemented in TMVA::MethodBDT.

Definition at line 647 of file MethodBase.cxx.

void TMVA::MethodBase::SetupMethod ( )
void TMVA::MethodBase::SetWeightFileDir ( TString  fileDir)
protected
void TMVA::MethodBase::SetWeightFileName ( TString  theWeightFile)
protected

set the weight file name (depreciated)

Definition at line 1953 of file MethodBase.cxx.

void TMVA::MethodBase::Statistics ( Types::ETreeType  treeType,
const TString theVarName,
Double_t meanS,
Double_t meanB,
Double_t rmsS,
Double_t rmsB,
Double_t xmin,
Double_t xmax 
)
protected

calculates rms,mean, xmin, xmax of the event variable this can be either done for the variables as they are or for normalised variables (in the range of 0-1) if "norm" is set to kTRUE

Definition at line 2769 of file MethodBase.cxx.

void TMVA::MethodBase::TestClassification ( )
virtual
void TMVA::MethodBase::TestMulticlass ( )
virtual

test multiclass classification

Definition at line 1032 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

void TMVA::MethodBase::TestRegression ( Double_t bias,
Double_t biasT,
Double_t dev,
Double_t devT,
Double_t rms,
Double_t rmsT,
Double_t mInf,
Double_t mInfT,
Double_t corr,
Types::ETreeType  type 
)
virtual

calculate <sum-of-deviation-squared> of regression output versus "true" value from test sample

bias = average deviation dev = average absolute deviation rms = rms of deviation

Definition at line 931 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods().

virtual void TMVA::MethodBase::Train ( )
pure virtual
void TMVA::MethodBase::TrainMethod ( )
Bool_t TMVA::MethodBase::TxtWeightsOnly ( ) const
inlineprotected

Definition at line 449 of file MethodBase.h.

Bool_t TMVA::MethodBase::Verbose ( void  ) const
inlineprotected

Definition at line 418 of file MethodBase.h.

void TMVA::MethodBase::WriteEvaluationHistosToFile ( Types::ETreeType  treetype)
virtual

writes all MVA evaluation histograms to file

Reimplemented in TMVA::MethodBoost.

Definition at line 1977 of file MethodBase.cxx.

Referenced by TMVA::Factory::EvaluateAllMethods(), and TMVA::MethodBoost::WriteEvaluationHistosToFile().

void TMVA::MethodBase::WriteMonitoringHistosToFile ( void  ) const
virtual

write special monitoring histograms to file dummy implementation here --------------—

Implements TMVA::IMethod.

Reimplemented in TMVA::MethodANNBase, TMVA::MethodBoost, TMVA::MethodCuts, TMVA::MethodBDT, TMVA::MethodLikelihood, and TMVA::MethodRuleFit.

Definition at line 2009 of file MethodBase.cxx.

void TMVA::MethodBase::WriteStateToFile ( ) const

write options and weights to file note that each one text file for the main configuration information and one ROOT file for ROOT objects are created

Definition at line 1306 of file MethodBase.cxx.

void TMVA::MethodBase::WriteStateToStream ( std::ostream &  tf) const
private

general method used in writing the header of the weight files where the used variables, variable transformation type etc.

is specified

Definition at line 1169 of file MethodBase.cxx.

void TMVA::MethodBase::WriteStateToXML ( void parent) const
private

general method used in writing the header of the weight files where the used variables, variable transformation type etc.

is specified

Definition at line 1233 of file MethodBase.cxx.

Referenced by TMVA::MethodCategory::AddWeightsXMLTo().

void TMVA::MethodBase::WriteVarsToStream ( std::ostream &  tf,
const TString prefix = "" 
) const
private

write the list of variables (name, min, max) for a given data transformation method to the stream

Definition at line 1612 of file MethodBase.cxx.

Friends And Related Function Documentation

friend class Factory
friend

Definition at line 93 of file MethodBase.h.

friend class MethodCategory
friend

Definition at line 235 of file MethodBase.h.

friend class MethodCompositeBase
friend

Definition at line 236 of file MethodBase.h.

friend class MethodCuts
friend

Definition at line 525 of file MethodBase.h.

Member Data Documentation

Types::EAnalysisType TMVA::MethodBase::fAnalysisType
protected

Definition at line 517 of file MethodBase.h.

Referenced by DoMulticlass(), DoRegression(), GetAnalysisType(), and SetAnalysisType().

UInt_t TMVA::MethodBase::fBackgroundClass
protected

Definition at line 606 of file MethodBase.h.

TDirectory* TMVA::MethodBase::fBaseDir
private

Definition at line 548 of file MethodBase.h.

Referenced by SetBaseDir(), and SetMethodDir().

Bool_t TMVA::MethodBase::fConstructedFromWeightFile
private

Definition at line 543 of file MethodBase.h.

Referenced by IsConstructedFromWeightFile().

ECutOrientation TMVA::MethodBase::fCutOrientation
private

Definition at line 615 of file MethodBase.h.

Referenced by GetCutOrientation().

DataSetInfo& TMVA::MethodBase::fDataSetInfo
private

set to true in order to suppress writing to XML

Definition at line 530 of file MethodBase.h.

Referenced by DataInfo().

PDF* TMVA::MethodBase::fDefaultPDF
private

Definition at line 560 of file MethodBase.h.

Bool_t TMVA::MethodBase::fDisableWriting
private

Definition at line 527 of file MethodBase.h.

Referenced by DisableWriting().

TH1* TMVA::MethodBase::fEffS
private

Definition at line 558 of file MethodBase.h.

std::vector<const std::vector<TMVA::Event*>*> TMVA::MethodBase::fEventCollections
mutableprivate

Definition at line 624 of file MethodBase.h.

TString TMVA::MethodBase::fFileDir
private

Definition at line 553 of file MethodBase.h.

Referenced by GetWeightFileDir().

Bool_t TMVA::MethodBase::fHasMVAPdfs
private

Definition at line 596 of file MethodBase.h.

Referenced by HasMVAPdfs().

Bool_t TMVA::MethodBase::fHelp
private

Definition at line 595 of file MethodBase.h.

Referenced by Help().

Bool_t TMVA::MethodBase::fIgnoreNegWeightsInTraining
private

Definition at line 598 of file MethodBase.h.

Referenced by IgnoreEventsWithNegWeightsInTraining().

std::vector<TString>* TMVA::MethodBase::fInputVars
protected

Definition at line 510 of file MethodBase.h.

Referenced by GetInternalVarName().

TString TMVA::MethodBase::fJobName
private

Definition at line 537 of file MethodBase.h.

Referenced by GetJobName().

Double_t TMVA::MethodBase::fMeanB
private

Definition at line 578 of file MethodBase.h.

Double_t TMVA::MethodBase::fMeanS
private

Definition at line 577 of file MethodBase.h.

TDirectory* TMVA::MethodBase::fMethodBaseDir
mutableprivate

Definition at line 549 of file MethodBase.h.

Referenced by SetMethodBaseDir(), and SetMethodDir().

TString TMVA::MethodBase::fMethodName
private

Definition at line 538 of file MethodBase.h.

Referenced by GetMethodName(), and GetName().

Types::EMVA TMVA::MethodBase::fMethodType
private

Definition at line 539 of file MethodBase.h.

Referenced by GetMethodType(), and GetMethodTypeName().

std::vector<Float_t>* TMVA::MethodBase::fMulticlassReturnVal
protected

Definition at line 520 of file MethodBase.h.

PDF* TMVA::MethodBase::fMVAPdfB
private

Definition at line 562 of file MethodBase.h.

PDF* TMVA::MethodBase::fMVAPdfS
private

Definition at line 561 of file MethodBase.h.

Int_t TMVA::MethodBase::fNbins
protected

Definition at line 513 of file MethodBase.h.

Int_t TMVA::MethodBase::fNbinsH
protected

Definition at line 515 of file MethodBase.h.

Int_t TMVA::MethodBase::fNbinsMVAoutput
protected

Definition at line 514 of file MethodBase.h.

Int_t TMVA::MethodBase::fNbinsMVAPdf
private

Definition at line 642 of file MethodBase.h.

Bool_t TMVA::MethodBase::fNormalise
private

Definition at line 633 of file MethodBase.h.

Referenced by IsNormalised(), and SetNormalised().

Int_t TMVA::MethodBase::fNsmoothMVAPdf
private

Definition at line 643 of file MethodBase.h.

TString TMVA::MethodBase::fParentDir
private

Definition at line 551 of file MethodBase.h.

Ranking* TMVA::MethodBase::fRanking
protected

Definition at line 509 of file MethodBase.h.

std::vector<Float_t>* TMVA::MethodBase::fRegressionReturnVal
protected

Definition at line 519 of file MethodBase.h.

Double_t TMVA::MethodBase::fRmsB
private

Definition at line 580 of file MethodBase.h.

Double_t TMVA::MethodBase::fRmsS
private

Definition at line 579 of file MethodBase.h.

UInt_t TMVA::MethodBase::fROOTTrainingVersion
private

Definition at line 542 of file MethodBase.h.

Referenced by GetTrainingROOTVersionCode().

Bool_t TMVA::MethodBase::fSetupCompleted

Definition at line 627 of file MethodBase.h.

UInt_t TMVA::MethodBase::fSignalClass
protected

Definition at line 605 of file MethodBase.h.

Double_t TMVA::MethodBase::fSignalReferenceCut
private

the data set information (sometimes needed)

Definition at line 532 of file MethodBase.h.

Referenced by GetSignalReferenceCut(), and SetSignalReferenceCut().

Double_t TMVA::MethodBase::fSignalReferenceCutOrientation
private
PDF* TMVA::MethodBase::fSplB
private

Definition at line 567 of file MethodBase.h.

TSpline* TMVA::MethodBase::fSpleffBvsS
private

Definition at line 568 of file MethodBase.h.

TSpline1* TMVA::MethodBase::fSplRefB
private

Definition at line 619 of file MethodBase.h.

TSpline1* TMVA::MethodBase::fSplRefS
private

Definition at line 618 of file MethodBase.h.

PDF* TMVA::MethodBase::fSplS
private

Definition at line 566 of file MethodBase.h.

PDF* TMVA::MethodBase::fSplTrainB
private

Definition at line 571 of file MethodBase.h.

TSpline* TMVA::MethodBase::fSplTrainEffBvsS
private

Definition at line 572 of file MethodBase.h.

TSpline1* TMVA::MethodBase::fSplTrainRefB
private

Definition at line 622 of file MethodBase.h.

TSpline1* TMVA::MethodBase::fSplTrainRefS
private

Definition at line 621 of file MethodBase.h.

PDF* TMVA::MethodBase::fSplTrainS
private

Definition at line 570 of file MethodBase.h.

Double_t TMVA::MethodBase::fTestTime
private

Definition at line 612 of file MethodBase.h.

Referenced by GetTestTime(), and SetTestTime().

TString TMVA::MethodBase::fTestvar
private

Definition at line 540 of file MethodBase.h.

Referenced by GetProbaName(), GetTestvarName(), and SetTestvarName().

const Event* TMVA::MethodBase::fTmpEvent
mutable

Definition at line 366 of file MethodBase.h.

Referenced by GetRegressionValues().

UInt_t TMVA::MethodBase::fTMVATrainingVersion
private

Definition at line 541 of file MethodBase.h.

Referenced by GetTrainingTMVAVersionCode().

Double_t TMVA::MethodBase::fTrainTime
private

Definition at line 611 of file MethodBase.h.

Referenced by GetTrainTime(), and SetTrainTime().

TransformationHandler TMVA::MethodBase::fTransformation
private

Definition at line 588 of file MethodBase.h.

Referenced by GetTransformationHandler().

TransformationHandler* TMVA::MethodBase::fTransformationPointer
private
Bool_t TMVA::MethodBase::fTxtWeightsOnly
private

Definition at line 641 of file MethodBase.h.

Bool_t TMVA::MethodBase::fUseDecorr
private

Definition at line 639 of file MethodBase.h.

Types::ESBType TMVA::MethodBase::fVariableTransformType
private

Definition at line 534 of file MethodBase.h.

TString TMVA::MethodBase::fVariableTransformTypeString
private

Definition at line 640 of file MethodBase.h.

TString TMVA::MethodBase::fVarTransformString
private

Definition at line 585 of file MethodBase.h.

Bool_t TMVA::MethodBase::fVerbose
private

Definition at line 592 of file MethodBase.h.

Referenced by Verbose().

EMsgType TMVA::MethodBase::fVerbosityLevel
private

Definition at line 594 of file MethodBase.h.

TString TMVA::MethodBase::fVerbosityLevelString
private

Definition at line 593 of file MethodBase.h.

TString TMVA::MethodBase::fWeightFile
private

Definition at line 554 of file MethodBase.h.

Double_t TMVA::MethodBase::fXmax
private

Definition at line 582 of file MethodBase.h.

Double_t TMVA::MethodBase::fXmin
private

Definition at line 581 of file MethodBase.h.


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