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 std::string &varNames, const TString &theOption, Bool_t verbose=0) | |
constructor | |
Reader (const TString &theOption="", Bool_t verbose=0) | |
constructor | |
Reader (const TString &varNames, const TString &theOption, Bool_t verbose=0) | |
constructor | |
Reader (std::vector< std::string > &varNames, const TString &theOption="", Bool_t verbose=0) | |
constructor | |
Reader (std::vector< TString > &varNames, const TString &theOption="", Bool_t verbose=0) | |
constructor | |
virtual | ~Reader (void) |
destructor | |
void | AddSpectator (const TString &expression, Float_t *) |
Add a float spectator or expression to the reader. | |
void | AddSpectator (const TString &expression, Int_t *) |
Add an integer spectator or expression to the reader. | |
void | AddVariable (const TString &expression, Float_t *) |
Add a float variable or expression to the reader. | |
void | AddVariable (const TString &expression, Int_t *) |
IMethod * | BookMVA (const TString &methodTag, const TString &weightfile) |
read method name from weight file | |
IMethod * | BookMVA (TMVA::Types::EMVA methodType, const char *xmlstr) |
DataSetInfo & | DataInfo () |
const DataSetInfo & | DataInfo () const |
const std::vector< Float_t > & | EvaluateMulticlass (const TString &methodTag, Double_t aux=0) |
evaluates MVA for given set of input variables | |
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. | |
Float_t | EvaluateMulticlass (UInt_t clsNumber, const TString &methodTag, Double_t aux=0) |
evaluates the multiclass MVA | |
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. | |
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. | |
Double_t | EvaluateMVA (const TString &methodTag, Double_t aux=0) |
evaluates MVA for given set of input variables | |
Double_t | EvaluateMVA (MethodBase *method, Double_t aux=0) |
evaluates the MVA | |
const std::vector< Float_t > & | EvaluateRegression (const TString &methodTag, Double_t aux=0) |
evaluates MVA for given set of input variables | |
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. | |
Float_t | EvaluateRegression (UInt_t tgtNumber, const TString &methodTag, Double_t aux=0) |
evaluates the regression MVA | |
MethodCuts * | FindCutsMVA (const TString &methodTag) |
special function for Cuts to avoid dynamic_casts in ROOT macros, which are not properly handled by CINT | |
IMethod * | FindMVA (const TString &methodTag) |
return pointer to method with tag "methodTag" | |
Double_t | GetMVAError () const |
Double_t | GetMVAErrorLower () const |
Double_t | GetMVAErrorUpper () const |
virtual const char * | GetName () const |
Returns name of object. | |
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 | |
Double_t | GetRarity (const TString &methodTag, Double_t mvaVal=-9999999) |
evaluates the MVA's rarity | |
virtual TClass * | IsA () const |
void | SetVerbose (Bool_t v) |
virtual void | Streamer (TBuffer &) |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Bool_t | Verbose (void) const |
Public Member Functions inherited from TMVA::Configurable | |
Configurable (const TString &theOption="") | |
constructor | |
virtual | ~Configurable () |
default destructor | |
void | AddOptionsXMLTo (void *parent) const |
write options to XML file | |
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 | |
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 | |
void | PrintOptions () const |
prints out the options set in the options string and the defaults | |
void | ReadOptionsFromStream (std::istream &istr) |
read option back from the weight file | |
void | ReadOptionsFromXML (void *node) |
void | SetConfigDescription (const char *d) |
void | SetConfigName (const char *n) |
void | SetMsgType (EMsgType t) |
void | SetOptions (const TString &s) |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
void | WriteOptionsToStream (std::ostream &o, const TString &prefix) const |
write options to output stream (e.g. in writing the MVA weight files | |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. | |
void | Clear (Option_t *option="") override |
Set name and title to empty strings (""). | |
TObject * | Clone (const char *newname="") const override |
Make a clone of an object using the Streamer facility. | |
Int_t | Compare (const TObject *obj) const override |
Compare two TNamed objects. | |
void | Copy (TObject &named) const override |
Copy this to obj. | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. | |
const char * | GetName () const override |
Returns name of object. | |
const char * | GetTitle () const override |
Returns title of object. | |
ULong_t | Hash () const override |
Return hash value for this object. | |
TClass * | IsA () const override |
Bool_t | IsSortable () const override |
void | ls (Option_t *option="") const override |
List TNamed name and title. | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
void | Print (Option_t *option="") const override |
Print TNamed name and title. | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. | |
void | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. | |
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. | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. | |
virtual void | Delete (Option_t *option="") |
Delete this object. | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1) . | |
virtual void | Dump () const |
Dump contents of object on stdout. | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. | |
virtual void | Execute (const char *method, const char *params, Int_t *error=nullptr) |
Execute method on this object with the given parameter string, e.g. | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr) |
Execute method on this object with parameters stored in the TObjArray. | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. | |
virtual const char * | GetIconName () const |
Returns mime type name of object. | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). | |
virtual Option_t * | GetOption () const |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. | |
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. | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. | |
void | InvertBit (UInt_t f) |
Bool_t | IsDestructed () const |
IsDestructed. | |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). | |
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). | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification (the base implementation is no-op). | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. | |
void | operator delete (void *ptr) |
Operator delete. | |
void | operator delete (void *ptr, void *vp) |
Only called by placement new when throwing an exception. | |
void | operator delete[] (void *ptr) |
Operator delete []. | |
void | operator delete[] (void *ptr, void *vp) |
Only called by placement new[] when throwing an exception. | |
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. | |
virtual void | Paint (Option_t *option="") |
This method must be overridden if a class wants to paint itself. | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. | |
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. | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. | |
virtual Int_t | Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. | |
Static Public Member Functions | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TMVA::Configurable | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TNamed | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
static Longptr_t | GetDtorOnly () |
Return destructor only flag. | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. | |
Private Member Functions | |
IMethod * | BookMVA (Types::EMVA method, const TString &weightfile) |
books MVA method from weightfile | |
void | DeclareOptions () |
declaration of configuration options | |
void | DecodeVarNames (const std::string &varNames) |
decodes "name1:name2:..." form | |
void | DecodeVarNames (const TString &varNames) |
decodes "name1:name2:..." form | |
TString | GetMethodTypeFromFile (const TString &filename) |
read the method type from the file | |
void | Init (void) |
default initialisation (no member variables) | |
MsgLogger & | Log () const |
Private Attributes | |
Bool_t | fCalculateError |
error calculation mode | |
Bool_t | fColor |
color mode | |
DataInputHandler | fDataInputHandler |
DataSetInfo | fDataSetInfo |
DataSetManager * | fDataSetManager |
MsgLogger * | fLogger |
message logger | |
std::map< TString, IMethod * > | fMethodMap |
map of methods | |
Double_t | fMvaEventError |
per-event error returned by MVA | |
Double_t | fMvaEventErrorUpper |
per-event error returned by MVA | |
Bool_t | fSilent |
silent mode | |
std::vector< Float_t > | fTmpEvalVec |
temporary evaluation vector (if user input is v<double>) | |
Bool_t | fVerbose |
verbosity | |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
Protected Types inherited from TObject | |
enum | { kOnlyPrepStep = (1ULL << ( 3 )) } |
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 | |
void | WriteOptionsReferenceToFile () |
write complete options to output stream | |
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). | |
void | MakeZombie () |
Protected Attributes inherited from TMVA::Configurable | |
MsgLogger * | fLogger |
! message logger | |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
#include <TMVA/Reader.h>
constructor
Definition at line 123 of file Reader.cxx.
TMVA::Reader::Reader | ( | std::vector< std::string > & | varNames, |
const TString & | theOption = "" , |
||
Bool_t | verbose = 0 |
||
) |
constructor
Definition at line 178 of file Reader.cxx.
TMVA::Reader::Reader | ( | const std::string & | varNames, |
const TString & | theOption, | ||
Bool_t | verbose = 0 |
||
) |
constructor
Definition at line 208 of file Reader.cxx.
TMVA::Reader::Reader | ( | std::vector< TString > & | varNames, |
const TString & | theOption = "" , |
||
Bool_t | verbose = 0 |
||
) |
constructor
Definition at line 148 of file Reader.cxx.
constructor
Definition at line 236 of file Reader.cxx.
|
virtual |
destructor
Definition at line 277 of file Reader.cxx.
Add a float spectator or expression to the reader.
Definition at line 321 of file Reader.cxx.
Add an integer spectator or expression to the reader.
Definition at line 329 of file Reader.cxx.
Add a float variable or expression to the reader.
Definition at line 303 of file Reader.cxx.
Definition at line 310 of file Reader.cxx.
TMVA::IMethod * TMVA::Reader::BookMVA | ( | const TString & | methodTag, |
const TString & | weightfile | ||
) |
read method name from weight file
Definition at line 368 of file Reader.cxx.
TMVA::IMethod * TMVA::Reader::BookMVA | ( | TMVA::Types::EMVA | methodType, |
const char * | xmlstr | ||
) |
Definition at line 429 of file Reader.cxx.
|
private |
books MVA method from weightfile
Definition at line 393 of file Reader.cxx.
|
static |
|
inlinestaticconstexpr |
|
inline |
|
inline |
|
private |
declaration of configuration options
Definition at line 264 of file Reader.cxx.
|
inlinestatic |
|
private |
decodes "name1:name2:..." form
Definition at line 781 of file Reader.cxx.
|
private |
decodes "name1:name2:..." form
Definition at line 795 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 630 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 665 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 680 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 499 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 468 of file Reader.cxx.
evaluates MVA for given set of input variables
Definition at line 514 of file Reader.cxx.
Double_t TMVA::Reader::EvaluateMVA | ( | MethodBase * | method, |
Double_t | aux = 0 |
||
) |
evaluates the MVA
Definition at line 548 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 565 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 599 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 614 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 707 of file Reader.cxx.
TMVA::IMethod * TMVA::Reader::FindMVA | ( | const TString & | methodTag | ) |
return pointer to method with tag "methodTag"
Definition at line 695 of file Reader.cxx.
read the method type from the file
Definition at line 337 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 715 of file Reader.cxx.
evaluates the MVA's rarity
Definition at line 746 of file Reader.cxx.
|
private |
default initialisation (no member variables)
Definition at line 292 of file Reader.cxx.
|
inlinevirtual |
Reimplemented from TMVA::Configurable.
|
virtual |
Stream an object of class TObject.
Reimplemented from TMVA::Configurable.
|
inline |
|
private |
|
private |
|
private |
|
private |
|
mutableprivate |
|
private |
|
private |
|
private |