ROOT 6.18/05 Reference Guide |
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:
\[ \frac{1}{2} \int \frac{(S(x) - B(x))^2}{(S(x) + B(x))} dx \]
where \( S(x) \) and \( B(x) \) are the signal and background distributions, respectively. The separation is zero for identical signal and background MVA shapes, and it is one for disjunctive shapes.The average, \( \int x \mu (S(x)) dx \), of the signal \( \mu_{transform} \). The \( \mu_{transform} \) of an MVA denotes the transformation that yields a uniform background distribution. In this way, the signal distributions \( S(x) \) can be directly compared among the various MVAs. The stronger \( S(x) \) peaks towards one, the better is the discrimination of the MVA. The \( \mu_{transform} \) is documented here.
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.
Definition at line 109 of file MethodBase.h.
Public Types | |
enum | EWeightFileType { kROOT =0 , kTEXT } |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) } |
enum | EDeprecatedStatusBits { kObjInCanvas = BIT(3) } |
enum | EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) } |
Public Member Functions | |
MethodBase (const TString &jobName, Types::EMVA methodType, const TString &methodTitle, DataSetInfo &dsi, const TString &theOption="") | |
standard constructor More... | |
MethodBase (Types::EMVA methodType, DataSetInfo &dsi, const TString &weightFile) | |
constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles More... | |
virtual | ~MethodBase () |
destructor More... | |
void | AddOutput (Types::ETreeType type, Types::EAnalysisType analysisType) |
TDirectory * | BaseDir () const |
returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored 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... | |
virtual const Ranking * | CreateRanking ()=0 |
DataSet * | Data () const |
DataSetInfo & | DataInfo () const |
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 weight file at hand More... | |
virtual void | DeclareOptions ()=0 |
void | DisableWriting (Bool_t setter) |
Bool_t | DoMulticlass () const |
Bool_t | DoRegression () const |
void | ExitFromTraining () |
Types::EAnalysisType | GetAnalysisType () const |
UInt_t | GetCurrentIter () |
virtual Double_t | GetEfficiency (const TString &, Types::ETreeType, Double_t &err) |
fill background efficiency (resp. More... | |
const Event * | GetEvent () const |
const Event * | GetEvent (const TMVA::Event *ev) const |
const Event * | GetEvent (Long64_t ievt) const |
const Event * | GetEvent (Long64_t ievt, Types::ETreeType type) const |
const std::vector< TMVA::Event * > & | GetEventCollection (Types::ETreeType type) |
returns the event collection (i.e. More... | |
TFile * | GetFile () const |
const TString & | GetInputLabel (Int_t i) const |
const char * | GetInputTitle (Int_t i) const |
const TString & | GetInputVar (Int_t i) const |
TMultiGraph * | GetInteractiveTrainingError () |
const TString & | GetJobName () const |
virtual Double_t | GetKSTrainingVsTest (Char_t SorB, TString opt="X") |
virtual Double_t | GetMaximumSignificance (Double_t SignalEvents, Double_t BackgroundEvents, Double_t &optimal_significance_value) const |
plot significance, \( \frac{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... | |
UInt_t | GetMaxIter () |
Double_t | GetMean (Int_t ivar) const |
const TString & | GetMethodName () const |
Types::EMVA | GetMethodType () const |
TString | GetMethodTypeName () const |
virtual TMatrixD | GetMulticlassConfusionMatrix (Double_t effB, Types::ETreeType type) |
Construct a confusion matrix for a multiclass classifier. More... | |
virtual std::vector< Float_t > | GetMulticlassEfficiency (std::vector< std::vector< Float_t > > &purity) |
virtual std::vector< Float_t > | GetMulticlassTrainingEfficiency (std::vector< std::vector< Float_t > > &purity) |
virtual const std::vector< Float_t > & | GetMulticlassValues () |
Double_t | GetMvaValue (const TMVA::Event *const ev, Double_t *err=0, Double_t *errUpper=0) |
virtual Double_t | GetMvaValue (Double_t *errLower=0, Double_t *errUpper=0)=0 |
const char * | GetName () const |
UInt_t | GetNEvents () const |
temporary event when testing on a different DataSet than the own one More... | |
UInt_t | GetNTargets () const |
UInt_t | GetNvar () const |
UInt_t | GetNVariables () const |
virtual Double_t | GetProba (const Event *ev) |
virtual Double_t | GetProba (Double_t mvaVal, Double_t ap_sig) |
compute likelihood ratio More... | |
const TString | GetProbaName () const |
virtual Double_t | GetRarity (Double_t mvaVal, Types::ESBType reftype=Types::kBackground) const |
compute rarity: More... | |
virtual void | GetRegressionDeviation (UInt_t tgtNum, Types::ETreeType type, Double_t &stddev, Double_t &stddev90Percent) const |
virtual const std::vector< Float_t > & | GetRegressionValues () |
const std::vector< Float_t > & | GetRegressionValues (const TMVA::Event *const ev) |
Double_t | GetRMS (Int_t ivar) const |
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 | 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 | GetSeparation (PDF *pdfS=0, PDF *pdfB=0) const |
compute "separation" defined as More... | |
virtual Double_t | GetSeparation (TH1 *, TH1 *) const |
compute "separation" defined as More... | |
Double_t | GetSignalReferenceCut () const |
Double_t | GetSignalReferenceCutOrientation () const |
virtual Double_t | GetSignificance () const |
compute significance of mean difference More... | |
const Event * | GetTestingEvent (Long64_t ievt) const |
Double_t | GetTestTime () const |
const TString & | GetTestvarName () const |
virtual Double_t | GetTrainingEfficiency (const TString &) |
const Event * | GetTrainingEvent (Long64_t ievt) const |
UInt_t | GetTrainingROOTVersionCode () const |
TString | GetTrainingROOTVersionString () const |
calculates the ROOT version string from the training version code on the fly More... | |
UInt_t | GetTrainingTMVAVersionCode () const |
TString | GetTrainingTMVAVersionString () const |
calculates the TMVA version string from the training version code on the fly More... | |
Double_t | GetTrainTime () const |
TransformationHandler & | GetTransformationHandler (Bool_t takeReroutedIfAvailable=true) |
const TransformationHandler & | GetTransformationHandler (Bool_t takeReroutedIfAvailable=true) const |
TString | GetWeightFileName () const |
retrieve weight file name More... | |
Double_t | GetXmax (Int_t ivar) const |
Double_t | GetXmin (Int_t ivar) const |
Bool_t | HasMVAPdfs () const |
virtual void | Init ()=0 |
void | InitIPythonInteractive () |
Bool_t | IsModelPersistence () |
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 be selected as signal or background More... | |
Bool_t | IsSilentFile () |
virtual void | MakeClass (const TString &classFileName=TString("")) const |
create reader class for method (classification only at present) More... | |
TDirectory * | MethodBaseDir () const |
returns the ROOT directory where all instances of the corresponding MVA method are stored More... | |
virtual std::map< TString, Double_t > | OptimizeTuningParameters (TString fomType="ROCIntegral", TString fitType="FitGA") |
call the Optimizer with the set of parameters and ranges that are meant to be tuned. More... | |
void | PrintHelpMessage () const |
prints out method-specific help method More... | |
virtual void | ProcessOptions ()=0 |
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... | |
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... | |
void | RerouteTransformationHandler (TransformationHandler *fTargetTransformation) |
virtual void | Reset () |
virtual void | SetAnalysisType (Types::EAnalysisType type) |
void | SetBaseDir (TDirectory *methodDir) |
void | SetFile (TFile *file) |
void | SetMethodBaseDir (TDirectory *methodDir) |
void | SetMethodDir (TDirectory *methodDir) |
void | SetModelPersistence (Bool_t status) |
void | SetSignalReferenceCut (Double_t cut) |
void | SetSignalReferenceCutOrientation (Double_t cutOrientation) |
void | SetSilentFile (Bool_t status) |
void | SetTestTime (Double_t testTime) |
void | SetTestvarName (const TString &v="") |
void | SetTrainTime (Double_t trainTime) |
virtual void | SetTuneParameters (std::map< TString, Double_t > tuneParameters) |
set the tuning parameters according to the argument This is just a dummy . More... | |
void | SetupMethod () |
setup of methods More... | |
virtual void | TestClassification () |
initialization More... | |
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 | Train ()=0 |
bool | TrainingEnded () |
void | TrainMethod () |
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... | |
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... | |
Public Member Functions inherited from TMVA::IMethod | |
IMethod () | |
virtual | ~IMethod () |
virtual const Ranking * | CreateRanking ()=0 |
virtual void | DeclareOptions ()=0 |
virtual Double_t | GetMvaValue (Double_t *err=0, Double_t *errUpper=0)=0 |
virtual const char * | GetName () const =0 |
virtual Bool_t | HasAnalysisType (Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets)=0 |
virtual void | Init ()=0 |
virtual void | MakeClass (const TString &classFileName=TString("")) const =0 |
virtual void | PrintHelpMessage () const =0 |
virtual void | ProcessOptions ()=0 |
virtual void | ReadWeightsFromStream (std::istream &)=0 |
virtual void | Train (void)=0 |
virtual void | WriteMonitoringHistosToFile (void) const =0 |
Public Member Functions inherited from TMVA::Configurable | |
Configurable (const TString &theOption="") | |
constructor More... | |
virtual | ~Configurable () |
default destructor More... | |
void | AddOptionsXMLTo (void *parent) const |
write options to XML file More... | |
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... | |
template<class T > | |
TMVA::OptionBase * | DeclareOptionRef (T &ref, const TString &name, const TString &desc) |
template<class T > | |
OptionBase * | DeclareOptionRef (T &ref, const TString &name, const TString &desc="") |
template<class T > | |
TMVA::OptionBase * | DeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc) |
template<class T > | |
OptionBase * | DeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="") |
const char * | GetConfigDescription () const |
const char * | GetConfigName () const |
const TString & | GetOptions () const |
MsgLogger & | Log () const |
virtual void | ParseOptions () |
options parser More... | |
void | PrintOptions () const |
prints out the options set in the options string and the defaults More... | |
void | ReadOptionsFromStream (std::istream &istr) |
read option back from the weight file More... | |
void | ReadOptionsFromXML (void *node) |
void | SetConfigDescription (const char *d) |
void | SetConfigName (const char *n) |
void | SetMsgType (EMsgType t) |
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... | |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. More... | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. More... | |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). More... | |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. More... | |
virtual Int_t | Compare (const TObject *obj) const |
Compare two TNamed objects. More... | |
virtual void | Copy (TObject &named) const |
Copy this to obj. More... | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual ULong_t | Hash () const |
Return hash value for this object. More... | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List TNamed name and title. More... | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. More... | |
virtual void | Print (Option_t *option="") const |
Print TNamed name and title. More... | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. More... | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). More... | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. More... | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. More... | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. More... | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
virtual | ~TObject () |
TObject destructor. 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... | |
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... | |
ULong_t | CheckedHash () |
Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (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 TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad) . More... | |
virtual void | Dump () const |
Dump contents of object on stdout. More... | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. 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 void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. More... | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. More... | |
virtual const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () const |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. 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... | |
Bool_t | HasInconsistentHash () const |
Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More... | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. 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... | |
void | InvertBit (UInt_t f) |
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 | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
virtual Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. 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... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *vp) |
void * | operator new[] (size_t sz) |
void * | operator new[] (size_t sz, void *vp) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. 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... | |
void | ResetBit (UInt_t f) |
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... | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. 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 | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. More... | |
R__ALWAYS_INLINE Bool_t | TestBit (UInt_t f) const |
Int_t | TestBits (UInt_t f) const |
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 void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. 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... | |
Public Attributes | |
Bool_t | fSetupCompleted |
const Event * | fTmpEvent |
Protected Member Functions | |
virtual void | AddWeightsXMLTo (void *parent) const =0 |
const TString & | GetInternalVarName (Int_t ivar) const |
virtual std::vector< Double_t > | GetMvaValues (Long64_t firstEvt=0, Long64_t lastEvt=-1, Bool_t logProgress=false) |
get all the MVA values for the events of the current Data type More... | |
const TString & | GetOriginalVarName (Int_t ivar) const |
const TString & | GetWeightFileDir () const |
Bool_t | HasTrainingTree () const |
Bool_t | Help () const |
Bool_t | IgnoreEventsWithNegWeightsInTraining () const |
Bool_t | IsConstructedFromWeightFile () const |
Bool_t | IsNormalised () const |
virtual void | MakeClassSpecific (std::ostream &, const TString &="") const |
virtual void | MakeClassSpecificHeader (std::ostream &, const TString &="") const |
void | NoErrorCalc (Double_t *const err, Double_t *const errUpper) |
virtual void | ReadWeightsFromStream (std::istream &)=0 |
virtual void | ReadWeightsFromStream (TFile &) |
virtual void | ReadWeightsFromXML (void *wghtnode)=0 |
void | SetNormalised (Bool_t norm) |
void | SetWeightFileDir (TString fileDir) |
set directory of weight file More... | |
void | SetWeightFileName (TString) |
set the weight file name (depreciated) More... | |
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 | Verbose () const |
Protected Member Functions inherited from TMVA::IMethod | |
virtual void | GetHelpMessage () const =0 |
virtual void | MakeClassSpecific (std::ostream &, const TString &) const =0 |
Protected Member Functions inherited from TMVA::Configurable | |
void | EnableLooseOptions (Bool_t b=kTRUE) |
const TString & | GetReferenceFile () const |
Bool_t | LooseOptionCheckingEnabled () const |
void | ResetSetFlag () |
resets the IsSet flag for all declare options to be called before options are read from stream More... | |
void | WriteOptionsReferenceToFile () |
write complete options to output stream More... | |
Protected Member Functions inherited from TObject | |
virtual void | DoError (int level, const char *location, const char *fmt, va_list va) const |
Interface to ErrorHandler (protected). More... | |
void | MakeZombie () |
Protected Attributes | |
Types::EAnalysisType | fAnalysisType |
UInt_t | fBackgroundClass |
bool | fExitFromTraining = false |
std::vector< TString > * | fInputVars |
IPythonInteractive * | fInteractive = nullptr |
UInt_t | fIPyCurrentIter = 0 |
UInt_t | fIPyMaxIter = 0 |
std::vector< Float_t > * | fMulticlassReturnVal |
Int_t | fNbins |
Int_t | fNbinsH |
Int_t | fNbinsMVAoutput |
Ranking * | fRanking |
std::vector< Float_t > * | fRegressionReturnVal |
Results * | fResults |
UInt_t | fSignalClass |
Protected Attributes inherited from TMVA::Configurable | |
MsgLogger * | fLogger |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
Private Types | |
enum | ECutOrientation { kNegative = -1 , kPositive = +1 } |
Private Member Functions | |
void | AddClassesXMLTo (void *parent) const |
write class info to XML 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... | |
void | AddInfoItem (void *gi, const TString &name, const TString &value) const |
xml writing More... | |
virtual void | AddMulticlassOutput (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... | |
void | AddSpectatorsXMLTo (void *parent) const |
write spectator info to XML More... | |
void | AddTargetsXMLTo (void *parent) const |
write target info to XML More... | |
void | AddVarsXMLTo (void *parent) const |
write variable info to XML More... | |
void | CreateMVAPdfs () |
Create PDFs of the MVA output variables. 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... | |
ECutOrientation | GetCutOrientation () const |
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 Double_t | GetValueForRoot (Double_t) |
returns efficiency as function of cut More... | |
void | InitBase () |
default initialization called by all constructors More... | |
void | ProcessBaseOptions () |
the option string is decoded, for available options see "DeclareOptions" More... | |
void | ReadClassesFromXML (void *clsnode) |
read number of classes from XML More... | |
void | ReadSpectatorsFromXML (void *specnode) |
read spectator info from XML More... | |
void | ReadStateFromXML (void *parent) |
void | ReadTargetsFromXML (void *tarnode) |
read target info from XML More... | |
void | ReadVariablesFromXML (void *varnode) |
read variable info 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 | ResetThisBase () |
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 | 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 | 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... | |
Friends | |
class | CrossValidation |
class | Experimental::Classification |
class | Factory |
class | MethodBoost |
class | MethodCategory |
class | MethodCompositeBase |
class | MethodCrossValidation |
class | MethodCuts |
class | RootFinder |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
#include <TMVA/MethodBase.h>
|
private |
Enumerator | |
---|---|
kNegative | |
kPositive |
Definition at line 540 of file MethodBase.h.
Enumerator | |
---|---|
kROOT | |
kTEXT |
Definition at line 120 of file MethodBase.h.
TMVA::MethodBase::MethodBase | ( | const TString & | jobName, |
Types::EMVA | methodType, | ||
const TString & | methodTitle, | ||
DataSetInfo & | dsi, | ||
const TString & | theOption = "" |
||
) |
standard constructor
Definition at line 242 of file MethodBase.cxx.
TMVA::MethodBase::MethodBase | ( | Types::EMVA | methodType, |
DataSetInfo & | dsi, | ||
const TString & | weightFile | ||
) |
constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles
Definition at line 308 of file MethodBase.cxx.
|
virtual |
destructor
Definition at line 369 of file MethodBase.cxx.
write class info to XML
Definition at line 1801 of file MethodBase.cxx.
|
privatevirtual |
prepare tree branch with the method's discriminating variable
Definition at line 873 of file MethodBase.cxx.
|
privatevirtual |
prepare tree branch with the method's discriminating variable
Definition at line 941 of file MethodBase.cxx.
|
private |
xml writing
Definition at line 1297 of file MethodBase.cxx.
|
privatevirtual |
prepare tree branch with the method's discriminating variable
Definition at line 799 of file MethodBase.cxx.
void TMVA::MethodBase::AddOutput | ( | Types::ETreeType | type, |
Types::EAnalysisType | analysisType | ||
) |
Definition at line 1306 of file MethodBase.cxx.
|
privatevirtual |
prepare tree branch with the method's discriminating variable
Definition at line 749 of file MethodBase.cxx.
write spectator info to XML
Definition at line 1778 of file MethodBase.cxx.
write target info to XML
Definition at line 1821 of file MethodBase.cxx.
write variable info to XML
Definition at line 1762 of file MethodBase.cxx.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCompositeBase, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::PyMethodBase, and TMVA::RMethodBase.
TDirectory * TMVA::MethodBase::BaseDir | ( | ) | const |
returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored
Definition at line 1980 of file MethodBase.cxx.
|
virtual |
check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase)
Reimplemented in TMVA::MethodBoost, TMVA::MethodCuts, and TMVA::MethodFDA.
Definition at line 438 of file MethodBase.cxx.
|
private |
Create PDFs of the MVA output variables.
Definition at line 2171 of file MethodBase.cxx.
|
pure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::PyMethodBase, TMVA::RMethodBase, and TMVA::MethodCompositeBase.
|
inline |
Definition at line 400 of file MethodBase.h.
|
inline |
Definition at line 401 of file MethodBase.h.
|
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:
Definition at line 514 of file MethodBase.cxx.
|
virtual |
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 weight file at hand
Reimplemented in TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCrossValidation, TMVA::MethodDT, TMVA::MethodKNN, TMVA::MethodLikelihood, TMVA::MethodPDEFoam, and TMVA::MethodSVM.
Definition at line 601 of file MethodBase.cxx.
|
pure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodMLP, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::PyMethodBase, TMVA::RMethodBase, and TMVA::MethodCompositeBase.
Definition at line 433 of file MethodBase.h.
|
inline |
Definition at line 430 of file MethodBase.h.
|
inline |
Definition at line 429 of file MethodBase.h.
|
inline |
Definition at line 453 of file MethodBase.h.
|
inline |
Definition at line 428 of file MethodBase.h.
|
inline |
Definition at line 470 of file MethodBase.h.
|
inlineprivate |
Definition at line 541 of file MethodBase.h.
|
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 2288 of file MethodBase.cxx.
|
inline |
Definition at line 740 of file MethodBase.h.
|
inline |
Definition at line 735 of file MethodBase.h.
|
inline |
Definition at line 748 of file MethodBase.h.
|
inline |
Definition at line 754 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 3337 of file MethodBase.cxx.
|
inline |
Definition at line 361 of file MethodBase.h.
Definition at line 341 of file MethodBase.h.
|
inline |
Definition at line 342 of file MethodBase.h.
Definition at line 340 of file MethodBase.h.
|
inline |
Definition at line 450 of file MethodBase.h.
Definition at line 499 of file MethodBase.h.
|
inline |
Definition at line 321 of file MethodBase.h.
Definition at line 3382 of file MethodBase.cxx.
|
private |
reads one line from the input stream checks for certain keywords and interprets the line if keywords are found
Definition at line 2128 of file MethodBase.cxx.
|
virtual |
plot significance, \( \frac{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 2872 of file MethodBase.cxx.
|
inline |
Definition at line 467 of file MethodBase.h.
Definition at line 345 of file MethodBase.h.
|
inline |
Definition at line 322 of file MethodBase.h.
|
inline |
Definition at line 324 of file MethodBase.h.
|
inline |
Definition at line 323 of file MethodBase.h.
|
virtual |
Construct a confusion matrix for a multiclass classifier.
The confusion matrix compares, in turn, each class agaist all other classes in a pair-wise fashion. In rows with index \( k_r = 0 ... K \), \( k_r \) is considered signal for the sake of comparison and for each column \( k_c = 0 ... K \) the corresponding class is considered background.
Note that the diagonal elements will be returned as NaN since this will compare a class against itself.
[in] | effB | The background efficiency for which to evaluate. |
[in] | type | The data set on which to evaluate (training, testing ...). |
Definition at line 2736 of file MethodBase.cxx.
|
virtual |
Definition at line 2689 of file MethodBase.cxx.
|
virtual |
Definition at line 2701 of file MethodBase.cxx.
|
inlinevirtual |
Reimplemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodANNBase, TMVA::MethodBDT, TMVA::MethodCrossValidation, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodFDA, and TMVA::MethodPDEFoam.
Definition at line 224 of file MethodBase.h.
Double_t TMVA::MethodBase::GetMvaValue | ( | const TMVA::Event *const | ev, |
Double_t * | err = 0 , |
||
Double_t * | errUpper = 0 |
||
) |
Definition at line 848 of file MethodBase.cxx.
|
pure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCompositeBase, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodMLP, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::MethodPyKeras, TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::PyMethodBase, TMVA::RMethodBase, and TMVA::MethodCompositeBase.
|
protectedvirtual |
get all the MVA values for the events of the current Data type
Reimplemented in TMVA::MethodPyKeras, TMVA::MethodDL, TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, and TMVA::PyMethodBase.
Definition at line 899 of file MethodBase.cxx.
|
inlinevirtual |
Implements TMVA::IMethod.
Definition at line 325 of file MethodBase.h.
temporary event when testing on a different DataSet than the own one
Definition at line 408 of file MethodBase.h.
|
inline |
Definition at line 337 of file MethodBase.h.
|
inline |
Definition at line 335 of file MethodBase.h.
|
inline |
Definition at line 336 of file MethodBase.h.
Definition at line 500 of file MethodBase.h.
Definition at line 2233 of file MethodBase.cxx.
compute likelihood ratio
Definition at line 2250 of file MethodBase.cxx.
|
inline |
Definition at line 327 of file MethodBase.h.
|
virtual |
compute rarity:
\[ R(x) = \int_{[-\infty..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 2271 of file MethodBase.cxx.
|
virtual |
Definition at line 729 of file MethodBase.cxx.
|
inlinevirtual |
Reimplemented in TMVA::MethodPyKeras, TMVA::MethodANNBase, TMVA::MethodBDT, TMVA::MethodCategory, TMVA::MethodCrossValidation, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodFDA, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodPDEFoam, TMVA::MethodPDERS, and TMVA::MethodSVM.
Definition at line 218 of file MethodBase.h.
|
inline |
Definition at line 211 of file MethodBase.h.
Definition at line 346 of file MethodBase.h.
calculate the area (integral) under the ROC curve as a overall quality measure of the classification
Definition at line 2842 of file MethodBase.cxx.
calculate the area (integral) under the ROC curve as a overall quality measure of the classification
Definition at line 2808 of file MethodBase.cxx.
compute "separation" defined as
\[ <s2> = \frac{1}{2} \int_{-\infty}^{+\infty} { \frac{(S(x) - B(x))^2}{(S(x) + B(x))} dx } \]
Reimplemented in TMVA::MethodCuts.
Definition at line 2786 of file MethodBase.cxx.
compute "separation" defined as
\[ <s2> = \frac{1}{2} \int_{-\infty}^{+\infty} { \frac{(S(x) - B(x))^2}{(S(x) + B(x))} dx } \]
Reimplemented in TMVA::MethodCuts.
Definition at line 2775 of file MethodBase.cxx.
|
inline |
Definition at line 351 of file MethodBase.h.
|
inline |
Definition at line 352 of file MethodBase.h.
compute significance of mean difference
\[ significance = \frac{|<S> - <B>|}{\sqrt{RMS_{S2} + RMS_{B2}}} \]
Reimplemented in TMVA::MethodCuts.
Definition at line 2762 of file MethodBase.cxx.
|
inline |
Definition at line 766 of file MethodBase.h.
|
inline |
Definition at line 164 of file MethodBase.h.
|
inline |
Definition at line 326 of file MethodBase.h.
Reimplemented in TMVA::MethodCuts.
Definition at line 2514 of file MethodBase.cxx.
|
inline |
Definition at line 760 of file MethodBase.h.
|
inline |
Definition at line 381 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 3371 of file MethodBase.cxx.
|
inline |
Definition at line 380 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 3359 of file MethodBase.cxx.
|
inline |
Definition at line 160 of file MethodBase.h.
|
inline |
Definition at line 385 of file MethodBase.h.
|
inline |
Definition at line 389 of file MethodBase.h.
returns efficiency as function of cut
Definition at line 3310 of file MethodBase.cxx.
|
inlineprotected |
Definition at line 481 of file MethodBase.h.
TString TMVA::MethodBase::GetWeightFileName | ( | ) | const |
retrieve weight file name
Definition at line 2068 of file MethodBase.cxx.
Definition at line 348 of file MethodBase.h.
Definition at line 347 of file MethodBase.h.
|
inline |
Definition at line 426 of file MethodBase.h.
|
inlineprotected |
Definition at line 502 of file MethodBase.h.
|
inlineprotected |
Definition at line 493 of file MethodBase.h.
|
inlineprotected |
Definition at line 675 of file MethodBase.h.
|
pure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodBoost, TMVA::MethodCategory, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodHMatrix, TMVA::MethodLikelihood, TMVA::MethodMLP, TMVA::PyMethodBase, TMVA::RMethodBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCFMlpANN, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, and TMVA::MethodTMlpANN.
|
private |
default initialization called by all constructors
Definition at line 446 of file MethodBase.cxx.
|
inline |
Definition at line 444 of file MethodBase.h.
|
inlineprotected |
Definition at line 529 of file MethodBase.h.
|
inline |
Definition at line 374 of file MethodBase.h.
|
inlineprotected |
Definition at line 485 of file MethodBase.h.
|
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 859 of file MethodBase.cxx.
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 be selected as signal or background
Definition at line 866 of file MethodBase.cxx.
|
inline |
Definition at line 370 of file MethodBase.h.
create reader class for method (classification only at present)
Implements TMVA::IMethod.
Reimplemented in TMVA::MethodCategory, TMVA::MethodC50, TMVA::MethodRXGB, and TMVA::MethodTMlpANN.
Definition at line 2993 of file MethodBase.cxx.
|
inlineprotectedvirtual |
Implements TMVA::IMethod.
Reimplemented in TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCFMlpANN, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDNN, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodMLP, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, and TMVA::MethodTMlpANN.
Definition at line 509 of file MethodBase.h.
|
inlineprotectedvirtual |
Reimplemented in TMVA::MethodBDT, TMVA::MethodCrossValidation, TMVA::MethodCFMlpANN, and TMVA::MethodLikelihood.
Definition at line 512 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 2013 of file MethodBase.cxx.
Definition at line 841 of file MethodBase.cxx.
|
virtual |
call the Optimizer with the set of parameters and ranges that are meant to be tuned.
Reimplemented in TMVA::MethodBDT, and TMVA::MethodSVM.
Definition at line 628 of file MethodBase.cxx.
|
virtual |
prints out method-specific help method
Implements TMVA::IMethod.
Definition at line 3254 of file MethodBase.cxx.
|
private |
the option string is decoded, for available options see "DeclareOptions"
Definition at line 545 of file MethodBase.cxx.
|
pure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodMLP, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::PyMethodBase, TMVA::RMethodBase, and TMVA::MethodCompositeBase.
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 428 of file MethodBase.cxx.
read number of classes from XML
Definition at line 1917 of file MethodBase.cxx.
read spectator info from XML
Definition at line 1877 of file MethodBase.cxx.
void TMVA::MethodBase::ReadStateFromFile | ( | ) |
Function to write options and weights to file.
Definition at line 1417 of file MethodBase.cxx.
void TMVA::MethodBase::ReadStateFromStream | ( | std::istream & | tf | ) |
read the header from the weight files of the different MVA methods
Definition at line 1590 of file MethodBase.cxx.
write reference MVA distributions (and other information) to a ROOT type weight file
Definition at line 1376 of file MethodBase.cxx.
Definition at line 1480 of file MethodBase.cxx.
void TMVA::MethodBase::ReadStateFromXMLString | ( | const char * | xmlstr | ) |
for reading from memory
Definition at line 1464 of file MethodBase.cxx.
read target info from XML
Definition at line 1959 of file MethodBase.cxx.
read variable info from XML
Definition at line 1837 of file MethodBase.cxx.
|
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 1725 of file MethodBase.cxx.
|
protectedpure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodDL, TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyRandomForest, TMVA::PyMethodBase, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::RMethodBase, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCFMlpANN, TMVA::MethodCompositeBase, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodPDEFoam, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::MethodCuts, TMVA::MethodDNN, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodLD, TMVA::MethodPDEFoam, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCFMlpANN, TMVA::MethodCompositeBase, TMVA::MethodCrossValidation, TMVA::MethodDT, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLikelihood, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, and TMVA::MethodTMlpANN.
Reimplemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::PyMethodBase, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::RMethodBase, TMVA::MethodANNBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCFMlpANN, TMVA::MethodCompositeBase, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodPDEFoam, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::MethodSVM, TMVA::MethodLikelihood, TMVA::MethodPDERS, and TMVA::MethodKNN.
Definition at line 257 of file MethodBase.h.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodCrossValidation, TMVA::MethodANNBase, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCompositeBase, TMVA::MethodCuts, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodHMatrix, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodLikelihood, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, TMVA::MethodTMlpANN, TMVA::PyMethodBase, and TMVA::RMethodBase.
|
inline |
Definition at line 394 of file MethodBase.h.
Reimplemented in TMVA::MethodPDEFoam, TMVA::MethodBDT, TMVA::MethodCrossValidation, and TMVA::MethodSVM.
Definition at line 191 of file MethodBase.h.
|
private |
|
inlinevirtual |
Definition at line 427 of file MethodBase.h.
|
inline |
Definition at line 364 of file MethodBase.h.
Definition at line 366 of file MethodBase.h.
|
inline |
Definition at line 365 of file MethodBase.h.
|
inline |
Definition at line 363 of file MethodBase.h.
Definition at line 373 of file MethodBase.h.
Definition at line 486 of file MethodBase.h.
Definition at line 355 of file MethodBase.h.
Definition at line 356 of file MethodBase.h.
Definition at line 369 of file MethodBase.h.
Definition at line 163 of file MethodBase.h.
Definition at line 332 of file MethodBase.h.
Definition at line 159 of file MethodBase.h.
set the tuning parameters according to the argument This is just a dummy .
. have a look at the MethodBDT how you could perhaps implement the same thing for the other Classifiers..
Reimplemented in TMVA::MethodBDT, and TMVA::MethodSVM.
Definition at line 649 of file MethodBase.cxx.
void TMVA::MethodBase::SetupMethod | ( | ) |
setup of methods
Definition at line 411 of file MethodBase.cxx.
set directory of weight file
Definition at line 2051 of file MethodBase.cxx.
set the weight file name (depreciated)
Definition at line 2060 of file MethodBase.cxx.
|
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 2928 of file MethodBase.cxx.
|
virtual |
initialization
Reimplemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodBoost, and TMVA::MethodCuts.
Definition at line 1116 of file MethodBase.cxx.
|
virtual |
test multiclass classification
Definition at line 1089 of file MethodBase.cxx.
|
virtual |
calculate <sum-of-deviation-squared> of regression output versus "true" value from test sample
Definition at line 982 of file MethodBase.cxx.
|
pure virtual |
Implements TMVA::IMethod.
Implemented in TMVA::MethodPyAdaBoost, TMVA::MethodPyGTB, TMVA::MethodPyKeras, TMVA::MethodPyRandomForest, TMVA::MethodC50, TMVA::MethodRSNNS, TMVA::MethodRSVM, TMVA::MethodRXGB, TMVA::MethodDL, TMVA::MethodDNN, TMVA::MethodHMatrix, TMVA::MethodLikelihood, TMVA::MethodMLP, TMVA::PyMethodBase, TMVA::RMethodBase, TMVA::MethodANNBase, TMVA::MethodCompositeBase, TMVA::MethodBayesClassifier, TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCategory, TMVA::MethodCFMlpANN, TMVA::MethodCrossValidation, TMVA::MethodCuts, TMVA::MethodDT, TMVA::MethodFDA, TMVA::MethodFisher, TMVA::MethodKNN, TMVA::MethodLD, TMVA::MethodPDEFoam, TMVA::MethodPDERS, TMVA::MethodRuleFit, TMVA::MethodSVM, and TMVA::MethodTMlpANN.
|
inline |
Definition at line 458 of file MethodBase.h.
void TMVA::MethodBase::TrainMethod | ( | ) |
Definition at line 655 of file MethodBase.cxx.
|
inlineprotected |
Definition at line 523 of file MethodBase.h.
Definition at line 492 of file MethodBase.h.
|
virtual |
writes all MVA evaluation histograms to file
Reimplemented in TMVA::MethodBoost.
Definition at line 2086 of file MethodBase.cxx.
write special monitoring histograms to file dummy implementation here --------------—
Implements TMVA::IMethod.
Reimplemented in TMVA::MethodANNBase, TMVA::MethodLikelihood, TMVA::MethodBDT, TMVA::MethodBoost, TMVA::MethodCrossValidation, TMVA::MethodCuts, and TMVA::MethodRuleFit.
Definition at line 2119 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 1395 of file MethodBase.cxx.
|
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 1258 of file MethodBase.cxx.
general method used in writing the header of the weight files where the used variables, variable transformation type etc.
is specified
Definition at line 1322 of file MethodBase.cxx.
|
private |
write the list of variables (name, min, max) for a given data transformation method to the stream
Definition at line 1710 of file MethodBase.cxx.
|
friend |
Definition at line 111 of file MethodBase.h.
|
friend |
Definition at line 116 of file MethodBase.h.
|
friend |
Definition at line 112 of file MethodBase.h.
|
friend |
Definition at line 114 of file MethodBase.h.
|
friend |
Definition at line 260 of file MethodBase.h.
|
friend |
Definition at line 261 of file MethodBase.h.
|
friend |
Definition at line 115 of file MethodBase.h.
|
friend |
Definition at line 592 of file MethodBase.h.
|
friend |
Definition at line 113 of file MethodBase.h.
|
protected |
Definition at line 584 of file MethodBase.h.
|
protected |
Definition at line 679 of file MethodBase.h.
|
private |
Definition at line 614 of file MethodBase.h.
|
private |
Definition at line 609 of file MethodBase.h.
|
private |
Definition at line 688 of file MethodBase.h.
|
private |
Definition at line 596 of file MethodBase.h.
|
private |
Definition at line 633 of file MethodBase.h.
|
private |
Definition at line 631 of file MethodBase.h.
|
mutableprivate |
Definition at line 697 of file MethodBase.h.
|
protected |
Definition at line 438 of file MethodBase.h.
|
private |
Definition at line 617 of file MethodBase.h.
|
private |
Definition at line 626 of file MethodBase.h.
|
private |
Definition at line 669 of file MethodBase.h.
|
private |
Definition at line 668 of file MethodBase.h.
|
private |
Definition at line 671 of file MethodBase.h.
|
protected |
Definition at line 577 of file MethodBase.h.
|
protected |
Definition at line 437 of file MethodBase.h.
|
protected |
Definition at line 439 of file MethodBase.h.
|
protected |
Definition at line 439 of file MethodBase.h.
|
private |
Definition at line 603 of file MethodBase.h.
|
private |
Definition at line 651 of file MethodBase.h.
|
private |
Definition at line 650 of file MethodBase.h.
|
mutableprivate |
Definition at line 615 of file MethodBase.h.
|
private |
Definition at line 604 of file MethodBase.h.
|
private |
Definition at line 605 of file MethodBase.h.
|
private |
Definition at line 622 of file MethodBase.h.
|
protected |
Definition at line 587 of file MethodBase.h.
|
private |
Definition at line 635 of file MethodBase.h.
|
private |
Definition at line 634 of file MethodBase.h.
|
protected |
Definition at line 580 of file MethodBase.h.
|
protected |
Definition at line 582 of file MethodBase.h.
|
protected |
Definition at line 581 of file MethodBase.h.
|
private |
Definition at line 715 of file MethodBase.h.
|
private |
Definition at line 711 of file MethodBase.h.
|
private |
Definition at line 716 of file MethodBase.h.
|
private |
Definition at line 624 of file MethodBase.h.
|
protected |
Definition at line 576 of file MethodBase.h.
|
protected |
Definition at line 586 of file MethodBase.h.
|
protected |
Definition at line 719 of file MethodBase.h.
|
private |
Definition at line 653 of file MethodBase.h.
|
private |
Definition at line 652 of file MethodBase.h.
|
private |
Definition at line 608 of file MethodBase.h.
Bool_t TMVA::MethodBase::fSetupCompleted |
Definition at line 700 of file MethodBase.h.
|
protected |
Definition at line 678 of file MethodBase.h.
|
private |
the data set information (sometimes needed)
Definition at line 598 of file MethodBase.h.
|
private |
Definition at line 599 of file MethodBase.h.
|
private |
Definition at line 620 of file MethodBase.h.
|
private |
Definition at line 640 of file MethodBase.h.
|
private |
Definition at line 641 of file MethodBase.h.
|
private |
Definition at line 692 of file MethodBase.h.
|
private |
Definition at line 691 of file MethodBase.h.
|
private |
Definition at line 639 of file MethodBase.h.
|
private |
Definition at line 644 of file MethodBase.h.
|
private |
Definition at line 645 of file MethodBase.h.
|
private |
Definition at line 695 of file MethodBase.h.
|
private |
Definition at line 694 of file MethodBase.h.
|
private |
Definition at line 643 of file MethodBase.h.
|
private |
Definition at line 685 of file MethodBase.h.
|
private |
Definition at line 606 of file MethodBase.h.
|
mutable |
Definition at line 403 of file MethodBase.h.
|
private |
Definition at line 607 of file MethodBase.h.
|
private |
Definition at line 684 of file MethodBase.h.
|
private |
Definition at line 661 of file MethodBase.h.
|
private |
Definition at line 660 of file MethodBase.h.
|
private |
Definition at line 714 of file MethodBase.h.
|
private |
Definition at line 712 of file MethodBase.h.
|
private |
Definition at line 600 of file MethodBase.h.
|
private |
Definition at line 713 of file MethodBase.h.
|
private |
Definition at line 658 of file MethodBase.h.
|
private |
Definition at line 665 of file MethodBase.h.
|
private |
Definition at line 667 of file MethodBase.h.
|
private |
Definition at line 666 of file MethodBase.h.
|
private |
Definition at line 627 of file MethodBase.h.
|
private |
Definition at line 655 of file MethodBase.h.
|
private |
Definition at line 654 of file MethodBase.h.