+
class TMVA::MethodBase
-
library: libTMVA
#include "MethodBase.h"
Display options:
Show inherited
Show non-public

class TMVA::MethodBase: public TMVA::IMethod, public TMVA::Configurable


/* Virtual base Class for all MVA method MethodBase hosts several specific evaluation methods The kind of MVA that provides optimal performance in an analysis strongly depends on the particular application. The evaluation factory provides a number of numerical benchmark results to directly assess the performance of the MVA training on the independent test sample. These are: The MVA standard output also prints the linear correlation coefficients between signal and background, which can be useful to eliminate variables that exhibit too strong correlations. */

Function Members (Methods)

 
    This is an abstract class, constructors will not be documented.
    Look at the header to check for available constructors.

public:
virtual~MethodBase()
voidTObject::AbstractMethod(const char* method) const
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::AppendPad(Option_t* option = "")
TDirectory*BaseDir() const
virtual voidTObject::Browse(TBrowser* b)
virtual voidTObject::Browse(TBrowser* b)
voidTMVA::Configurable::CheckForUnusedOptions() const
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual Int_tTObject::Compare(const TObject* obj) const
TMVA::ConfigurableTMVA::Configurable::Configurable(const TString& theOption = "")
virtual voidTObject::Copy(TObject& object) const
virtual voidTObject::Copy(TObject& object) const
voidCreateMVAPdfs()
virtual const TMVA::Ranking*TMVA::IMethod::CreateRanking()
TMVA::DataSet&Data() const
virtual voidDeclareOptions()
virtual voidTObject::Delete(Option_t* option = "")
virtual voidTObject::Delete(Option_t* option = "")
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() const
virtual voidTObject::DrawClass() const
virtual TObject*TObject::DrawClone(Option_t* option = "") const
virtual TObject*TObject::DrawClone(Option_t* option = "") const
virtual voidTObject::Dump() const
virtual voidTObject::Dump() const
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Option_t*TObject::GetDrawOption() const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
static Long_tTObject::GetDtorOnly()
Double_tGetEffForRoot(Double_t)
virtual Double_tGetEfficiency(TString, TTree*, Double_t& err)
TMVA::Event&GetEvent() const
Double_tGetEventVal(Int_t ivar) const
Double_tGetEventWeight() const
virtual const char*TObject::GetIconName() const
virtual const char*TObject::GetIconName() const
const TString&GetInputExp(int i) const
const TString&GetInputVar(int i) const
const TString&GetJobName() const
const TString&GetMethodName() const
const TString&GetMethodTitle() const
TMVA::Types::EMVAGetMethodType() const
virtual Double_tGetmuTransform(TTree*)
virtual Double_tGetMvaValue()
virtual const char*GetName() const
Int_tGetNvar() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
static Bool_tTObject::GetObjectStat()
virtual Double_tGetOptimalSignificance(Double_t SignalEvents, Double_t BackgroundEvents, Double_t& optimal_significance_value) const
virtual Option_t*TObject::GetOption() const
virtual Option_t*TObject::GetOption() const
const TString&TMVA::Configurable::GetOptions() const
virtual Double_tGetProba(Double_t mvaVal, Double_t ap_sig)
const TStringGetProbaName() const
virtual Double_tGetRarity(Double_t mvaVal, TMVA::Types::ESBType reftype = Types::kBackground) const
Double_tGetRMS(Int_t ivar) const
virtual Double_tGetSeparation(TH1*, TH1*) const
virtual Double_tGetSeparation(TMVA::PDF* pdfS = 0, TMVA::PDF* pdfB = 0) const
Double_tGetSignalReferenceCut() const
virtual Double_tGetSignificance() const
TTree*GetTestTree() const
const TString&GetTestvarName() const
static TMVA::MethodBase*GetThisBase()
virtual const char*TObject::GetTitle() const
virtual const char*TObject::GetTitle() const
virtual Double_tGetTrainingEfficiency(TString)
TTree*GetTrainingTree() const
virtual UInt_tTObject::GetUniqueID() const
virtual UInt_tTObject::GetUniqueID() const
TMVA::Types::EVariableTransformGetVariableTransform() const
TMVA::VariableTransformBase&GetVarTransform() const
TStringGetWeightFileDir() const
TStringGetWeightFileName() const
Double_tGetXmax(Int_t ivar) const
Double_tGetXmax(const TString& var) const
Double_tGetXmin(Int_t ivar) const
Double_tGetXmin(const TString& var) const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
virtual ULong_tTObject::Hash() const
Bool_tHasTrainingTree() const
Bool_tHelp() const
static Double_tIGetEffForRoot(Double_t)
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() const
virtual voidTObject::Inspect() const
voidTObject::InvertBit(UInt_t f)
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
virtual Bool_tTObject::IsFolder() const
Bool_tIsMVAPdfs() const
Bool_tIsNormalised() const
Bool_tIsOK() const
Bool_tTObject::IsOnHeap() const
Bool_tTObject::IsOnHeap() const
Bool_tIsSignalEvent() const
virtual Bool_tIsSignalLike()
virtual Bool_tTObject::IsSortable() const
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
virtual voidTObject::ls(Option_t* option = "") const
virtual voidMakeClass(const TString& classFileName = "") const
voidTObject::MayNotUse(const char* method) const
voidTObject::MayNotUse(const char* method) const
TDirectory*MethodBaseDir() const
Double_tNorm(Int_t ivar, Double_t x) const
Double_tNorm(TString var, Double_t x) const
virtual Bool_tTObject::Notify()
virtual Bool_tTObject::Notify()
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
void*TObject::operator new[](size_t sz, void* vp)
TMVA::IMethod&TMVA::IMethod::operator=(const TMVA::IMethod&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Paint(Option_t* option = "")
voidTMVA::Configurable::ParseOptions(Bool_t verbose = kTRUE)
virtual voidTObject::Pop()
virtual voidTObject::Pop()
virtual voidPrepareEvaluationTree(TTree* theTestTree)
virtual voidTObject::Print(Option_t* option = "") const
virtual voidTObject::Print(Option_t* option = "") const
virtual voidPrintHelpMessage() const
voidTMVA::Configurable::PrintOptions() const
virtual voidProcessOptions()
virtual Int_tTObject::Read(const char* name)
virtual Int_tTObject::Read(const char* name)
virtual Bool_tReadEvent(TTree* tr, UInt_t ievt, TMVA::Types::ESBType type = Types::kMaxSBType) const
voidReadStateFromFile()
voidReadStateFromStream(istream& tf)
voidReadStateFromStream(TFile& rf)
virtual Bool_tReadTestEvent(UInt_t ievt, TMVA::Types::ESBType type = Types::kMaxSBType) const
virtual Bool_tReadTrainingEvent(UInt_t ievt, TMVA::Types::ESBType type = Types::kMaxSBType) const
virtual voidReadWeightsFromStream(istream& tf)
virtual voidReadWeightsFromStream(TFile&)
virtual voidTObject::RecursiveRemove(TObject* obj)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") const
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") const
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")
virtual voidTObject::SetDrawOption(Option_t* option = "")
static voidTObject::SetDtorOnly(void* obj)
static voidTObject::SetDtorOnly(void* obj)
voidSetHelp(Bool_t h = kTRUE)
voidSetJobName(TString jobName)
voidSetMethodName(TString methodName)
voidSetMethodTitle(TString methodTitle)
voidSetMethodType(TMVA::Types::EMVA methodType)
voidTMVA::Configurable::SetName(const char* n)
voidSetNormalised(Bool_t norm)
voidSetNvar(Int_t n)
static voidTObject::SetObjectStat(Bool_t stat)
static voidTObject::SetObjectStat(Bool_t stat)
voidTMVA::Configurable::SetOptions(const TString& s)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidTObject::SetUniqueID(UInt_t uid)
voidSetVariableTransform(TMVA::Types::EVariableTransform m)
voidSetVerbose(Bool_t v = kTRUE)
voidSetWeightFileDir(TString fileDir)
voidSetWeightFileName(TString)
voidSetXmax(Int_t ivar, Double_t x)
voidSetXmax(const TString& var, Double_t x)
voidSetXmin(Int_t ivar, Double_t x)
voidSetXmin(const TString& var, Double_t x)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
virtual voidTest(TTree* theTestTree = 0)
Bool_tTObject::TestBit(UInt_t f) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTestInit(TTree* theTestTree = 0)
virtual voidTMVA::IMethod::Train()
voidTrainMethod()
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::UseCurrentStyle()
Bool_tVerbose() const
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
voidWriteEvaluationHistosToFile(TDirectory* targetDir = 0)
virtual voidWriteMonitoringHistosToFile() const
voidWriteStateToFile() const
voidWriteStateToStream(TFile& rf) const
voidWriteStateToStream(ostream& tf, Bool_t isClass = kFALSE) const
virtual voidWriteWeightsToStream(ostream& tf) const
virtual voidWriteWeightsToStream(TFile&) const
protected:
Bool_tCheckSanity(TTree* theTree = 0)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTMVA::Configurable::EnableLooseOptions(Bool_t b = kTRUE)
TMVA::MethodBase::ECutOrientationGetCutOrientation() const
virtual voidTMVA::IMethod::GetHelpMessage() const
const TString&GetInternalVarName(Int_t ivar) const
const TString&GetOriginalVarName(Int_t ivar) const
const TString&GetTestvarPrefix() const
UInt_tGetTrainingROOTVersionCode() const
TStringGetTrainingROOTVersionString() const
UInt_tGetTrainingTMVAVersionCode() const
TStringGetTrainingTMVAVersionString() const
TMVA::Types::ESBTypeGetVariableTransformType() const
TDirectory*LocalTDir() const
Bool_tTMVA::Configurable::LooseOptionCheckingEnabled() const
virtual voidMakeClassSpecific(ostream&, const TString& = "") const
virtual voidMakeClassSpecificHeader(ostream&, const TString& = "") const
voidTObject::MakeZombie()
voidTObject::MakeZombie()
voidTMVA::Configurable::ReadOptionsFromStream(istream& istr)
voidTMVA::Configurable::ResetSetFlag()
voidResetThisBase()
voidSetSignalReferenceCut(Double_t cut)
voidSetTestvarName(const TString& v = "")
voidSetTestvarPrefix(TString prefix)
voidSetVariableTransformType(TMVA::Types::ESBType t)
voidStatistics(TMVA::Types::ETreeType treeType, const TString& theVarName, Double_t&, Double_t&, Double_t&, Double_t&, Double_t&, Double_t&, Bool_t norm = kFALSE)
Bool_tTxtWeightsOnly() const
voidTMVA::Configurable::WriteOptionsToStream(ostream& o, const TString& prefix) const
private:
Double_tGetEventValNormalised(Int_t ivar) const
boolGetLine(istream& fin, char* buf)
voidInit()
voidSetBaseDir(TDirectory* d)

Data Members

public:
enum EWeightFileType { kROOT
kTEXT
};
enum ECutOrientation { kNegative
kPositive
};
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TMVA::MethodBase::ECutOrientationfCutOrientation+1 if Sig>Bkg, -1 otherwise
TH1*fEffBefficiency plot (background)
TH1*fEffBvsSbackground efficiency versus signal efficiency
TH1*fEffSefficiency plot (signal)
TGraph*fGraphBgraphs used for splines for efficiency (background)
TGraph*fGraphSgraphs used for splines for efficiency (signal)
TGraph*fGraphTrainBgraphs used for splines for training efficiency (background)
TGraph*fGraphTrainEffBvsSgraphs used for splines for training signal eff. versus background eff.
TGraph*fGraphTrainSgraphs used for splines for training efficiency (signal)
TGraph*fGrapheffBvsSgraphs used for splines for signal eff. versus background eff.
TH1*fHistB_highbinMVA plots used for efficiency calculations (background)
TH1*fHistB_plotbinMVA plots used for graphics representation (background)
TH1*fHistBhatBworking histograms needed for mu-transform (background)
TH1*fHistBhatSworking histograms needed for mu-transform (signal)
TH1*fHistMuBmu-transform (background)
TH1*fHistMuSmu-transform (signal)
TH1*fHistS_highbinMVA plots used for efficiency calculations (signal)
TH1*fHistS_plotbinMVA plots used for graphics representation (signal)
vector<TString>*fInputVarsvector of input variables used in MVA
Bool_tfIsOKstatus of sanity checks
TMVA::MsgLoggerfLoggermessage logger
TMVA::PDF*fMVAPdfBbackground MVA PDF
TMVA::PDF*fMVAPdfSsignal MVA PDF
Double_tfMode
Int_tfNbinsnumber of bins in representative histograms
Int_tfNbinsHnumber of bins in evaluation histograms
Int_tfNbinsMVAPdfnumber of bins used in histogram that creates PDF
Int_tfNsmoothMVAPdfnumber of times a histogram is smoothed before creating the PDF
TH1*fProbaB_plotbinP(MVA) plots used for graphics representation (background)
TH1*fProbaS_plotbinP(MVA) plots used for graphics representation (signal)
TMVA::Ranking*fRankingranking
TH1*fRarityB_plotbinR(MVA) plots used for graphics representation (background)
TH1*fRarityS_plotbinR(MVA) plots used for graphics representation (signal)
TH1*fRejBvsSbackground rejection (=1-eff.) versus signal efficiency
TMVA::PDF*fSplBPDFs of MVA distribution (background)
TMVA::TSpline1*fSplRefBhelper splines for RootFinder (background)
TMVA::TSpline1*fSplRefShelper splines for RootFinder (signal)
TMVA::PDF*fSplSPDFs of MVA distribution (signal)
TMVA::PDF*fSplTrainBPDFs of training MVA distribution (background)
TSpline*fSplTrainEffBvsSsplines for training signal eff. versus background eff.
TMVA::TSpline1*fSplTrainRefBhelper splines for RootFinder (background)
TMVA::TSpline1*fSplTrainRefShelper splines for RootFinder (signal)
TMVA::PDF*fSplTrainSPDFs of training MVA distribution (signal)
TSpline*fSpleffBvsSsplines for signal eff. versus background eff.
TH1*fTrainEffBTraining efficiency plot (background)
TH1*fTrainEffBvsSTraining background efficiency versus signal efficiency
TH1*fTrainEffSTraining efficiency plot (signal)
TH1*fTrainRejBvsSTraining background rejection (=1-eff.) versus signal efficiency
Double_tfX
TH1*finvBeffvsSeffinverse background eff (1/eff.) versus signal efficiency
private:
TDirectory*fBaseDirbase directory for the instance, needed to know where to jump back from localDir
TMVA::DataSet&fData! the data set
TStringfFileDirunix sub-directory for weight files (default: "weights")
Bool_tfHelphelp flag
Bool_tfIsMVAPdfscreate MVA Pdfs
TStringfJobNamename of job -> user defined, appears in weight files
Double_tfMeanBmean (background)
Double_tfMeanSmean (signal)
TDirectory*fMethodBaseDirbase directory for the method
TStringfMethodNamename of the method (set in derived class)
TStringfMethodTitleuser-defined title for method (used for weight-file names)
TMVA::Types::EMVAfMethodTypetype of method (set in derived class)
Bool_tfNormalisenormalise input variables
Int_tfNvarnumber of input variables
UInt_tfROOTTrainingVersionROOT version used for training
Double_tfRmsBRMS (background)
Double_tfRmsSRMS (signal)
Double_tfSignalReferenceCutminimum requirement on the MVA output to declare an event signal-like
UInt_tfTMVATrainingVersionTMVA version used for training
TStringfTestvarvariable used in evaluation, etc (mostly the MVA)
TStringfTestvarPrefix'MVA_' prefix of MVA variable
Bool_tfTxtWeightsOnlyif TRUE, write weights only to text files
Bool_tfUseDecorrkept for backward compatibility
TMVA::VariableTransformBase*fVarTransformthe variable transformer
TStringfVarTransformStringlabels variable transform method
TMVA::Types::EVariableTransformfVariableTransformDecorrelation, PCA, etc.
TMVA::Types::ESBTypefVariableTransformTypethis is the event type (sig or bgd) assumed for variable transform
TStringfVariableTransformTypeStringlabels variable transform type
Bool_tfVerboseverbose flag
TMVA::EMsgTypefVerbosityLevelverbosity level
TStringfVerbosityLevelStringverbosity level (user input string)
TStringfWeightFileweight file name
Double_tfXmaxmaximum (signal and background)
Double_tfXminminimum (signal and background)
static TMVA::MethodBase*fgThisBasethis pointer

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

~MethodBase( void )
 default destructur
void Init()
 default initialization called by all constructors
void DeclareOptions()
 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
               fIsMVAPdfs          create PDFs for the MVA outputs
               V                   for Verbose output (!V) for non verbos
               H                   for Help message
void ProcessOptions()
 the option string is decoded, for availabel options see "DeclareOptions"
void PrintHelpMessage()
 prints out classifier-specific help method
void TrainMethod()
 train the classifier method
Double_t GetProba(Double_t mvaVal, Double_t ap_sig)
 compute likelihood ratio
Double_t GetRarity(Double_t mvaVal, TMVA::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
void CreateMVAPdfs()
 Create PDFs of the MVA output variables
void WriteStateToStream(ostream& tf, Bool_t isClass = kFALSE) const
 general method used in writing the header of the weight files where
 the used variables, variable transformation type etc. is specified
void WriteStateToStream(TFile& rf) const
 write reference MVA distributions (and other information)
 to a ROOT type weight file
void ReadStateFromStream( TFile& rf )
 write reference MVA distributions (and other information)
 to a ROOT type weight file
void WriteStateToFile()
 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
void ReadStateFromFile()
 Function to write options and weights to file
bool GetLine(istream& fin, char* buf)
 reads one line from the input stream
 checks for certain keywords and interprets
 the line if keywords are found
void ReadStateFromStream( std::istream& fin )
 read the header from the weight files of the different MVA methods
TDirectory* BaseDir()
 returns the ROOT directory where info/histograms etc of the
 corresponding MVA method instance are stored
TDirectory* MethodBaseDir()
 returns the ROOT directory where all instances of the
 corresponding MVA method are stored
void SetWeightFileName(TString )
 set the weight file name (depreciated)
TString GetWeightFileName()
 retrieve weight file name
Bool_t CheckSanity(TTree* theTree = 0)
 tree sanity checks
void SetWeightFileDir(TString fileDir)
 set directory of weight file
Double_t Norm( TString var, Double_t x )
 renormalises variable with respect to its min and max
Double_t Norm( Int_t ivar, Double_t x )
 renormalises variable with respect to its min and max
void TestInit(TTree* theTestTree = 0)
 initialization of MVA testing
void PrepareEvaluationTree(TTree* theTestTree)
 prepare tree branch with the method's discriminating variable
void Test(TTree* theTestTree = 0)
 test the method - not much is done here... mainly furthor initialization
Double_t GetEfficiency(TString , TTree* , Double_t& err)
 fill background efficiency (resp. rejection) versus signal efficiency plots
 returns signal efficiency at background efficiency indicated in theString
Double_t GetTrainingEfficiency(TString )
 fill background efficiency (resp. rejection) versus signal efficiency plots
 returns signal efficiency at background efficiency indicated in theString
Double_t GetSignificance( void )
 compute significance of mean difference
 significance = |<S> - <B>|/Sqrt(RMS_S2 + RMS_B2)
Double_t GetSeparation( TH1* histoS, TH1* histoB )
 compute "separation" defined as
 <s2> = (1/2) Int_-oo..+oo { (S(x)2 - B(x)2)/(S(x) + B(x)) dx }
Double_t GetSeparation( PDF* pdfS, PDF* pdfB )
 compute "separation" defined as
 <s2> = (1/2) Int_-oo..+oo { (S(x)2 - B(x)2)/(S(x) + B(x)) dx }
Double_t GetOptimalSignificance(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 optimal significance
 also returned via reference is the optimal significance
Double_t GetmuTransform(TTree* )
 computes Mu-transform

 Authors     : Francois Le Diberder and Muriel Pivk
 Reference   : Muriel Pivk,
               "Etude de la violation de CP dans la désintégration
                B0 -> h+ h- (h = pi, K) auprès du détecteur BaBar à SLAC",
               PhD thesis at Universite de Paris VI-VII, LPNHE (IN2P3/CNRS), Paris, 2003
               http://tel.ccsd.cnrs.fr/documents/archives0/00/00/29/91/index_fr.html

 Definitions : Bhat = PDFbackground(x)/(PDFbackground(x) + PDFsignal(x))
               mu   = mu(b) = Int_0B Bhat[b'] db'

void Statistics(TMVA::Types::ETreeType treeType, const TString& theVarName, Double_t& , Double_t& , Double_t& , Double_t& , Double_t& , Double_t& , Bool_t norm = kFALSE)
 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
void WriteEvaluationHistosToFile(TDirectory* targetDir = 0)
 writes all MVA evaluation histograms to file
void MakeClass(const TString& classFileName = "") const
 create reader class for classifier
Double_t IGetEffForRoot(Double_t )
 interface for RootFinder
Double_t GetEffForRoot(Double_t )
 returns efficiency as function of cut
void WriteMonitoringHistosToFile( void )
 write special monitoring histograms to file - not implemented for this method
TString GetTrainingTMVAVersionString()
 calculates the TMVA version string from the training version code on the fly
TString GetTrainingROOTVersionString()
 calculates the ROOT version string from the training version code on the fly
Bool_t IsMVAPdfs()
{ return fIsMVAPdfs; }
void WriteWeightsToStream( std::ostream& tf )
void WriteWeightsToStream( TFile& /*rf*/ )
{}
void ReadWeightsFromStream( std::istream& tf )
void ReadWeightsFromStream( TFile& /*rf*/ )
{}
Bool_t IsSignalLike()
{ return GetMvaValue() > GetSignalReferenceCut() ? kTRUE : kFALSE; }
Double_t GetMvaValue()
 individual initialistion for testing of each method
 overload this one for individual initialisation of the testing,
 it is then called automatically within the global "TestInit"
 the new way to get the MVA value
const TString& GetJobName()
 accessors
{ return fJobName; }
const TString& GetMethodName()
{ return fMethodName; }
const char* GetName()
{ return GetMethodName().Data(); }
const TString& GetMethodTitle()
{ return fMethodTitle; }
Types::EMVA GetMethodType()
{ return fMethodType; }
void SetJobName(TString jobName)
{ fJobName = jobName; }
void SetMethodName(TString methodName)
{ fMethodName = methodName; }
void SetMethodTitle(TString methodTitle)
{ fMethodTitle = methodTitle; }
void SetMethodType(TMVA::Types::EMVA methodType)
{ fMethodType = methodType; }
TString GetWeightFileDir()
{ return fFileDir; }
const TString& GetInputVar(int i) const
{ return Data().GetInternalVarName(i); }
const TString& GetInputExp(int i) const
{ return Data().GetExpression(i); }
Bool_t HasTrainingTree()
{ return Data().GetTrainingTree() != 0; }
TTree* GetTrainingTree()
return Data()
TTree* GetTestTree()
Int_t GetNvar()
{ return fNvar; }
void SetNvar(Int_t n)
{ fNvar = n; }
Double_t GetRMS(Int_t ivar) const
 normalisation accessors
{ return GetVarTransform().Variable(ivar).GetRMS(); }
Double_t GetXmin( Int_t ivar )
{ return GetVarTransform().Variable(ivar).GetMin(); }
Double_t GetXmax( Int_t ivar )
{ return GetVarTransform().Variable(ivar).GetMax(); }
Double_t GetXmin( const TString& var )
{ return GetVarTransform().Variable(var) .GetMin(); }
Double_t GetXmax( const TString& var )
{ return GetVarTransform().Variable(var) .GetMax(); }
void SetXmin( Int_t ivar, Double_t x )
{ GetVarTransform().Variable(ivar).SetMin(x); }
void SetXmax( Int_t ivar, Double_t x )
{ GetVarTransform().Variable(ivar).SetMax(x); }
void SetXmin( const TString& var, Double_t x )
{ GetVarTransform().Variable(var) .SetMin(x); }
void SetXmax( const TString& var, Double_t x )
{ GetVarTransform().Variable(var) .SetMax(x); }
Bool_t IsNormalised()
 are variables normalised ?
{ return fNormalise; }
void SetNormalised(Bool_t norm)
{ fNormalise = norm; }
Bool_t IsOK()
 member functions for the "evaluation"
 accessors
{ return fIsOK; }
Types::EVariableTransform GetVariableTransform()
{ return fVariableTransform; }
void SetVariableTransform(TMVA::Types::EVariableTransform m)
{ fVariableTransform = m; }
Bool_t Verbose()
{ return fVerbose; }
Bool_t Help()
{ return fHelp; }
void SetVerbose(Bool_t v = kTRUE)
{ fVerbose = v; }
void SetHelp(Bool_t h = kTRUE)
{ fHelp = h; }
Bool_t ReadEvent(TTree* tr, UInt_t ievt, TMVA::Types::ESBType type = Types::kMaxSBType) const
Bool_t ReadTrainingEvent(UInt_t ievt, TMVA::Types::ESBType type = Types::kMaxSBType) const
Bool_t ReadTestEvent(UInt_t ievt, TMVA::Types::ESBType type = Types::kMaxSBType) const
TMVA::Event& GetEvent()
{ return GetVarTransform().GetEvent(); }
Bool_t IsSignalEvent()
{ return GetEvent().IsSignal(); }
Double_t GetEventVal(Int_t ivar) const
Double_t GetEventWeight()
{ return GetEvent().GetWeight(); }
const TString& GetTestvarName()
 TestVar (the variable name used for the MVA)
{ return fTestvar; }
const TString GetProbaName()
{ return fTestvar + "_Proba"; }
VariableTransformBase& GetVarTransform()
 retrieve variable transformer
{ return *fVarTransform; }
Double_t GetSignalReferenceCut()
 sets the minimum requirement on the MVA output to declare an event signal-like
{ return fSignalReferenceCut; }
void MakeClassSpecific(ostream& , const TString& = "") const
 make ROOT-independent C++ class for classifier response (classifier-specific implementation)
{}
void MakeClassSpecificHeader(ostream& , const TString& = "") const
 header and auxiliary classes
{}
MethodBase* GetThisBase()
 static pointer to this object
{ return fgThisBase; }
ECutOrientation GetCutOrientation()
{ return fCutOrientation; }
void ResetThisBase()
 reset required for RootFinder
{ fgThisBase = this; }
void SetSignalReferenceCut(Double_t cut)
 sets the minimum requirement on the MVA output to declare an event signal-like
{ fSignalReferenceCut = cut; }
Types::ESBType GetVariableTransformType()
{ return fVariableTransformType; }
void SetVariableTransformType(TMVA::Types::ESBType t)
{ fVariableTransformType = t; }
UInt_t GetTrainingTMVAVersionCode()
 the versions can be checked using
 if(GetTrainingTMVAVersionCode()>TMVA_VERSION(3,7,2)) {...}
 or
 if(GetTrainingROOTVersionCode()>ROOT_VERSION(5,15,5)) {...}
{ return fTMVATrainingVersion; }
UInt_t GetTrainingROOTVersionCode()
{ return fROOTTrainingVersion; }
const TString& GetInternalVarName(Int_t ivar) const
{ return (*fInputVars)[ivar]; }
const TString& GetOriginalVarName(Int_t ivar) const
{ return Data().GetExpression(ivar); }
TDirectory* LocalTDir()
 protected accessors for derived classes
      TDirectory*      BaseDir() const;
{ return Data().LocalRootDir(); }
void SetTestvarName(const TString& v = "")
 TestVar (the variable name used for the MVA)
{ fTestvar = (v=="")?(fTestvarPrefix + GetMethodTitle()):v; }
const TString& GetTestvarPrefix()
 MVA prefix (e.g., "TMVA_")
{ return fTestvarPrefix; }
void SetTestvarPrefix(TString prefix)
{ fTestvarPrefix = prefix; }
Bool_t TxtWeightsOnly()
 if TRUE, write weights only to text files
{ return fTxtWeightsOnly; }
void SetBaseDir(TDirectory* d)
{ fBaseDir = d; }
Double_t GetEventValNormalised(Int_t ivar) const
 normalises input variables

Author: Andreas Hoecker, Joerg Stelzer, Helge Voss, Kai Voss
Last update: root/tmva $Id: MethodBase.cxx,v 1.20 2007/06/19 13:26:21 brun Exp $
Copyright (c) 2005: *

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.