ROOT 6.12/07 Reference Guide |
The Reader class serves to use the MVAs in a specific analysis context.
Within an event loop, a vector is filled that corresponds to the variables that were used to train the MVA(s) during the training stage. This vector is transfered to the Reader, who takes care of interpreting the weight file of the MVA of choice, and to return the MVA's output. This is then used by the user for further analysis.
Usage:
Public Member Functions | |
Reader (const TString &theOption="", Bool_t verbose=0) | |
constructor More... | |
Reader (std::vector< std::string > &varNames, const TString &theOption="", Bool_t verbose=0) | |
constructor More... | |
Reader (const std::string &varNames, const TString &theOption, Bool_t verbose=0) | |
constructor More... | |
Reader (std::vector< TString > &varNames, const TString &theOption="", Bool_t verbose=0) | |
constructor More... | |
Reader (const TString &varNames, const TString &theOption, Bool_t verbose=0) | |
constructor More... | |
virtual | ~Reader (void) |
destructor More... | |
void | AddSpectator (const TString &expression, Float_t *) |
Add a float spectator or expression to the reader. More... | |
void | AddSpectator (const TString &expression, Int_t *) |
Add an integer spectator or expression to the reader. More... | |
void | AddVariable (const TString &expression, Float_t *) |
Add a float variable or expression to the reader. More... | |
void | AddVariable (const TString &expression, Int_t *) |
IMethod * | BookMVA (const TString &methodTag, const TString &weightfile) |
read method name from weight file More... | |
IMethod * | BookMVA (TMVA::Types::EMVA methodType, const char *xmlstr) |
const DataSetInfo & | DataInfo () const |
DataSetInfo & | DataInfo () |
const std::vector< Float_t > & | EvaluateMulticlass (const TString &methodTag, Double_t aux=0) |
evaluates MVA for given set of input variables More... | |
const std::vector< Float_t > & | EvaluateMulticlass (MethodBase *method, Double_t aux=0) |
evaluates the multiclass MVA check for NaN in event data: (note: in the factory, this check was done already at the creation of the datasets, hence it is not again checked in each of these subsequent calls. More... | |
Float_t | EvaluateMulticlass (UInt_t clsNumber, const TString &methodTag, Double_t aux=0) |
evaluates the multiclass MVA More... | |
Double_t | EvaluateMVA (const std::vector< Float_t > &, const TString &methodTag, Double_t aux=0) |
Evaluate a std::vector<float> of input data for a given method The parameter aux is obligatory for the cuts method where it represents the efficiency cutoff. More... | |
Double_t | EvaluateMVA (const std::vector< Double_t > &, const TString &methodTag, Double_t aux=0) |
Evaluate a std::vector<double> of input data for a given method The parameter aux is obligatory for the cuts method where it represents the efficiency cutoff. More... | |
Double_t | EvaluateMVA (MethodBase *method, Double_t aux=0) |
evaluates the MVA More... | |
Double_t | EvaluateMVA (const TString &methodTag, Double_t aux=0) |
evaluates MVA for given set of input variables More... | |
const std::vector< Float_t > & | EvaluateRegression (const TString &methodTag, Double_t aux=0) |
evaluates MVA for given set of input variables More... | |
const std::vector< Float_t > & | EvaluateRegression (MethodBase *method, Double_t aux=0) |
evaluates the regression MVA check for NaN in event data: (note: in the factory, this check was done already at the creation of the datasets, hence it is not again checked in each of these subsequent calls. More... | |
Float_t | EvaluateRegression (UInt_t tgtNumber, const TString &methodTag, Double_t aux=0) |
evaluates the regression MVA More... | |
MethodCuts * | FindCutsMVA (const TString &methodTag) |
special function for Cuts to avoid dynamic_casts in ROOT macros, which are not properly handled by CINT More... | |
IMethod * | FindMVA (const TString &methodTag) |
return pointer to method with tag "methodTag" More... | |
Double_t | GetMVAError () const |
Double_t | GetMVAErrorLower () const |
Double_t | GetMVAErrorUpper () const |
virtual const char * | GetName () const |
Returns name of object. More... | |
Double_t | GetProba (const TString &methodTag, Double_t ap_sig=0.5, Double_t mvaVal=-9999999) |
evaluates probability of MVA for given set of input variables More... | |
Double_t | GetRarity (const TString &methodTag, Double_t mvaVal=-9999999) |
evaluates the MVA's rarity More... | |
void | SetVerbose (Bool_t v) |
Bool_t | Verbose (void) const |
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 > | |
OptionBase * | DeclareOptionRef (T &ref, const TString &name, const TString &desc="") |
template<class T > | |
OptionBase * | DeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="") |
template<class T > | |
TMVA::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) |
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 TString &name, const TString &title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. More... | |
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 * | 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 () |
Checked and record whether for 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 | 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 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 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... | |
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 |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
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 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, Bool_t set) |
Set or unset the user status bits as specified in f. More... | |
void | SetBit (UInt_t f) |
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... | |
Private Member Functions | |
IMethod * | BookMVA (Types::EMVA method, const TString &weightfile) |
books MVA method from weightfile More... | |
void | DeclareOptions () |
declaration of configuration options More... | |
void | DecodeVarNames (const std::string &varNames) |
decodes "name1:name2:..." form More... | |
void | DecodeVarNames (const TString &varNames) |
decodes "name1:name2:..." form More... | |
TString | GetMethodTypeFromFile (const TString &filename) |
read the method type from the file More... | |
void | Init (void) |
default initialisation (no member variables) More... | |
MsgLogger & | Log () const |
Private Attributes | |
Bool_t | fCalculateError |
Bool_t | fColor |
DataInputHandler | fDataInputHandler |
DataSetInfo | fDataSetInfo |
DataSetManager * | fDataSetManager |
MsgLogger * | fLogger |
std::map< TString, IMethod * > | fMethodMap |
Double_t | fMvaEventError |
Double_t | fMvaEventErrorUpper |
Bool_t | fSilent |
std::vector< Float_t > | fTmpEvalVec |
Bool_t | fVerbose |
Additional Inherited Members | |
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) } |
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... | |
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 inherited from TMVA::Configurable | |
MsgLogger * | fLogger |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
#include <TMVA/Reader.h>
constructor
Definition at line 128 of file Reader.cxx.
TMVA::Reader::Reader | ( | std::vector< std::string > & | varNames, |
const TString & | theOption = "" , |
||
Bool_t | verbose = 0 |
||
) |
constructor
Definition at line 183 of file Reader.cxx.
TMVA::Reader::Reader | ( | const std::string & | varNames, |
const TString & | theOption, | ||
Bool_t | verbose = 0 |
||
) |
constructor
Definition at line 213 of file Reader.cxx.
TMVA::Reader::Reader | ( | std::vector< TString > & | varNames, |
const TString & | theOption = "" , |
||
Bool_t | verbose = 0 |
||
) |
constructor
Definition at line 153 of file Reader.cxx.
constructor
Definition at line 241 of file Reader.cxx.
|
virtual |
destructor
Definition at line 282 of file Reader.cxx.
Add a float spectator or expression to the reader.
Definition at line 326 of file Reader.cxx.
Add an integer spectator or expression to the reader.
Definition at line 334 of file Reader.cxx.
Add a float variable or expression to the reader.
Definition at line 308 of file Reader.cxx.
Definition at line 315 of file Reader.cxx.
TMVA::IMethod * TMVA::Reader::BookMVA | ( | const TString & | methodTag, |
const TString & | weightfile | ||
) |
read method name from weight file
Definition at line 377 of file Reader.cxx.
TMVA::IMethod * TMVA::Reader::BookMVA | ( | TMVA::Types::EMVA | methodType, |
const char * | xmlstr | ||
) |
Definition at line 438 of file Reader.cxx.
|
private |
books MVA method from weightfile
Definition at line 402 of file Reader.cxx.
|
inline |
|
inline |
|
private |
declaration of configuration options
Definition at line 269 of file Reader.cxx.
|
private |
decodes "name1:name2:..." form
Definition at line 798 of file Reader.cxx.
decodes "name1:name2:..." form
Definition at line 812 of file Reader.cxx.
const std::vector< Float_t > & TMVA::Reader::EvaluateMulticlass | ( | const TString & | methodTag, |
Double_t | aux = 0 |
||
) |
evaluates MVA for given set of input variables
Definition at line 647 of file Reader.cxx.
const std::vector< Float_t > & TMVA::Reader::EvaluateMulticlass | ( | MethodBase * | method, |
Double_t | aux = 0 |
||
) |
evaluates the multiclass MVA check for NaN in event data: (note: in the factory, this check was done already at the creation of the datasets, hence it is not again checked in each of these subsequent calls.
Definition at line 682 of file Reader.cxx.
Float_t TMVA::Reader::EvaluateMulticlass | ( | UInt_t | clsNumber, |
const TString & | methodTag, | ||
Double_t | aux = 0 |
||
) |
evaluates the multiclass MVA
Definition at line 697 of file Reader.cxx.
Double_t TMVA::Reader::EvaluateMVA | ( | const std::vector< Float_t > & | inputVec, |
const TString & | methodTag, | ||
Double_t | aux = 0 |
||
) |
Evaluate a std::vector<float> of input data for a given method The parameter aux is obligatory for the cuts method where it represents the efficiency cutoff.
Definition at line 485 of file Reader.cxx.
Double_t TMVA::Reader::EvaluateMVA | ( | const std::vector< Double_t > & | inputVec, |
const TString & | methodTag, | ||
Double_t | aux = 0 |
||
) |
Evaluate a std::vector<double> of input data for a given method The parameter aux is obligatory for the cuts method where it represents the efficiency cutoff.
Definition at line 516 of file Reader.cxx.
Double_t TMVA::Reader::EvaluateMVA | ( | MethodBase * | method, |
Double_t | aux = 0 |
||
) |
evaluates the MVA
Definition at line 565 of file Reader.cxx.
evaluates MVA for given set of input variables
Definition at line 531 of file Reader.cxx.
const std::vector< Float_t > & TMVA::Reader::EvaluateRegression | ( | const TString & | methodTag, |
Double_t | aux = 0 |
||
) |
evaluates MVA for given set of input variables
Definition at line 582 of file Reader.cxx.
const std::vector< Float_t > & TMVA::Reader::EvaluateRegression | ( | MethodBase * | method, |
Double_t | aux = 0 |
||
) |
evaluates the regression MVA check for NaN in event data: (note: in the factory, this check was done already at the creation of the datasets, hence it is not again checked in each of these subsequent calls.
Definition at line 616 of file Reader.cxx.
Float_t TMVA::Reader::EvaluateRegression | ( | UInt_t | tgtNumber, |
const TString & | methodTag, | ||
Double_t | aux = 0 |
||
) |
evaluates the regression MVA
Definition at line 631 of file Reader.cxx.
TMVA::MethodCuts * TMVA::Reader::FindCutsMVA | ( | const TString & | methodTag | ) |
special function for Cuts to avoid dynamic_casts in ROOT macros, which are not properly handled by CINT
Definition at line 724 of file Reader.cxx.
TMVA::IMethod * TMVA::Reader::FindMVA | ( | const TString & | methodTag | ) |
return pointer to method with tag "methodTag"
Definition at line 712 of file Reader.cxx.
read the method type from the file
Definition at line 342 of file Reader.cxx.
|
inlinevirtual |
Double_t TMVA::Reader::GetProba | ( | const TString & | methodTag, |
Double_t | ap_sig = 0.5 , |
||
Double_t | mvaVal = -9999999 |
||
) |
evaluates probability of MVA for given set of input variables
Definition at line 732 of file Reader.cxx.
evaluates the MVA's rarity
Definition at line 763 of file Reader.cxx.
default initialisation (no member variables)
Definition at line 297 of file Reader.cxx.
|
private |
|
private |
|
private |