ROOT  6.06/09
Reference Guide
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TMVA::Reader Class Reference

Definition at line 73 of file Reader.h.

Public Member Functions

 Reader (const TString &theOption="", Bool_t verbose=0)
 
 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...
 
IMethodBookMVA (const TString &methodTag, const TString &weightfile)
 read method name from weight file More...
 
IMethodBookMVA (TMVA::Types::EMVA methodType, const char *xmlstr)
 
IMethodFindMVA (const TString &methodTag)
 return pointer to method with tag "methodTag" More...
 
MethodCutsFindCutsMVA (const TString &methodTag)
 special function for Cuts to avoid dynamic_casts in ROOT macros, which are not properly handled by CINT 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...
 
Double_t GetMVAError () const
 
Double_t GetMVAErrorLower () const
 
Double_t GetMVAErrorUpper () const
 
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 subsequet calls. More...
 
Float_t EvaluateRegression (UInt_t tgtNumber, const TString &methodTag, Double_t aux=0)
 evaluates the regression MVA More...
 
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 subsequet calls. More...
 
Float_t EvaluateMulticlass (UInt_t clsNumber, const TString &methodTag, Double_t aux=0)
 evaluates the multiclass MVA 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...
 
virtual const char * GetName () const
 Returns name of object. More...
 
Bool_t Verbose (void) const
 
void SetVerbose (Bool_t v)
 
const DataSetInfoDataInfo () const
 
DataSetInfoDataInfo ()
 
void AddVariable (const TString &expression, Float_t *)
 Add a float variable or expression to the reader. More...
 
void AddVariable (const TString &expression, Int_t *)
 
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...
 
- Public Member Functions inherited from TMVA::Configurable
 Configurable (const TString &theOption="")
 
virtual ~Configurable ()
 default destructur More...
 
virtual void ParseOptions ()
 options parser More...
 
void PrintOptions () const
 prints out the options set in the options string and the defaults More...
 
const char * GetConfigName () const
 
const char * GetConfigDescription () const
 
void SetConfigName (const char *n)
 
void SetConfigDescription (const char *d)
 
template<class T >
OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc="")
 
template<class T >
OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")
 
template<class T >
void AddPreDefVal (const T &)
 
template<class T >
void AddPreDefVal (const TString &optname, const T &)
 
void CheckForUnusedOptions () const
 checks for unused options in option string More...
 
const TStringGetOptions () const
 
void SetOptions (const TString &s)
 
void WriteOptionsToStream (std::ostream &o, const TString &prefix) const
 write options to output stream (e.g. in writing the MVA weight files More...
 
void ReadOptionsFromStream (std::istream &istr)
 read option back from the weight file More...
 
void AddOptionsXMLTo (void *parent) const
 write options to XML file More...
 
void ReadOptionsFromXML (void *node)
 
void SetMsgType (EMsgType t)
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T &ref, const TString &name, const TString &desc)
 
template<class T >
TMVA::OptionBaseDeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Private Member Functions

TString GetMethodTypeFromFile (const TString &filename)
 read the method type from the file More...
 
IMethodBookMVA (Types::EMVA method, const TString &weightfile)
 books MVA method from weightfile More...
 
void Init (void)
 default initialisation (no member variables) default initialisation (no member variables) More...
 
void DecodeVarNames (const std::string &varNames)
 decodes "name1:name2:..." form More...
 
void DecodeVarNames (const TString &varNames)
 decodes "name1:name2:..." form More...
 
void DeclareOptions ()
 declaration of configuration options More...
 
MsgLoggerLog () const
 

Private Attributes

DataSetManagerfDataSetManager
 
DataSetInfo fDataSetInfo
 
DataInputHandler fDataInputHandler
 
Bool_t fVerbose
 
Bool_t fSilent
 
Bool_t fColor
 
Bool_t fCalculateError
 
Double_t fMvaEventError
 
Double_t fMvaEventErrorUpper
 
std::map< TString, IMethod * > fMethodMap
 
std::vector< Float_tfTmpEvalVec
 
MsgLoggerfLogger
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TMVA::Configurable
Bool_t LooseOptionCheckingEnabled () const
 
void EnableLooseOptions (Bool_t b=kTRUE)
 
void WriteOptionsReferenceToFile ()
 write complete options to output stream More...
 
void ResetSetFlag ()
 resets the IsSet falg for all declare options to be called before options are read from stream More...
 
const TStringGetReferenceFile () const
 
MsgLoggerLog () const
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

#include <TMVA/Reader.h>

+ Inheritance diagram for TMVA::Reader:
+ Collaboration diagram for TMVA::Reader:

Constructor & Destructor Documentation

TMVA::Reader::Reader ( const TString theOption = "",
Bool_t  verbose = 0 
)
TMVA::Reader::Reader ( std::vector< std::string > &  varNames,
const TString theOption = "",
Bool_t  verbose = 0 
)

constructor

Definition at line 181 of file Reader.cxx.

TMVA::Reader::Reader ( const std::string &  varNames,
const TString theOption,
Bool_t  verbose = 0 
)

constructor

Definition at line 211 of file Reader.cxx.

TMVA::Reader::Reader ( std::vector< TString > &  varNames,
const TString theOption = "",
Bool_t  verbose = 0 
)

constructor

Definition at line 151 of file Reader.cxx.

TMVA::Reader::Reader ( const TString varNames,
const TString theOption,
Bool_t  verbose = 0 
)

constructor

Definition at line 239 of file Reader.cxx.

TMVA::Reader::~Reader ( void  )
virtual

destructor

Definition at line 280 of file Reader.cxx.

Member Function Documentation

void TMVA::Reader::AddSpectator ( const TString expression,
Float_t datalink 
)

Add a float spectator or expression to the reader.

Definition at line 320 of file Reader.cxx.

void TMVA::Reader::AddSpectator ( const TString expression,
Int_t datalink 
)

Add an integer spectator or expression to the reader.

Definition at line 328 of file Reader.cxx.

void TMVA::Reader::AddVariable ( const TString expression,
Float_t datalink 
)

Add a float variable or expression to the reader.

Definition at line 302 of file Reader.cxx.

void TMVA::Reader::AddVariable ( const TString expression,
Int_t datalink 
)

Definition at line 309 of file Reader.cxx.

TMVA::IMethod * TMVA::Reader::BookMVA ( const TString methodTag,
const TString weightfile 
)

read method name from weight file

Definition at line 371 of file Reader.cxx.

TMVA::IMethod * TMVA::Reader::BookMVA ( TMVA::Types::EMVA  methodType,
const char *  xmlstr 
)

Definition at line 432 of file Reader.cxx.

TMVA::IMethod * TMVA::Reader::BookMVA ( Types::EMVA  method,
const TString weightfile 
)
private

books MVA method from weightfile

Definition at line 396 of file Reader.cxx.

const DataSetInfo& TMVA::Reader::DataInfo ( ) const
inline

Definition at line 130 of file Reader.h.

Referenced by Reader().

DataSetInfo& TMVA::Reader::DataInfo ( )
inline

Definition at line 131 of file Reader.h.

void TMVA::Reader::DeclareOptions ( )
private

declaration of configuration options

Definition at line 267 of file Reader.cxx.

Referenced by Reader().

void TMVA::Reader::DecodeVarNames ( const std::string &  varNames)
private

decodes "name1:name2:..." form

Definition at line 792 of file Reader.cxx.

Referenced by Reader().

void TMVA::Reader::DecodeVarNames ( const TString varNames)
private

decodes "name1:name2:..." form

Definition at line 806 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 641 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 subsequet calls.

Definition at line 676 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 691 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 479 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 510 of file Reader.cxx.

Double_t TMVA::Reader::EvaluateMVA ( MethodBase method,
Double_t  aux = 0 
)

evaluates the MVA

Definition at line 559 of file Reader.cxx.

Double_t TMVA::Reader::EvaluateMVA ( const TString methodTag,
Double_t  aux = 0 
)

evaluates MVA for given set of input variables

Definition at line 525 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 576 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 subsequet calls.

Definition at line 610 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 625 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 718 of file Reader.cxx.

TMVA::IMethod * TMVA::Reader::FindMVA ( const TString methodTag)

return pointer to method with tag "methodTag"

Definition at line 706 of file Reader.cxx.

TString TMVA::Reader::GetMethodTypeFromFile ( const TString filename)
private

read the method type from the file

Definition at line 336 of file Reader.cxx.

Double_t TMVA::Reader::GetMVAError ( ) const
inline

Definition at line 107 of file Reader.h.

Double_t TMVA::Reader::GetMVAErrorLower ( ) const
inline

Definition at line 108 of file Reader.h.

Double_t TMVA::Reader::GetMVAErrorUpper ( ) const
inline

Definition at line 109 of file Reader.h.

virtual const char* TMVA::Reader::GetName ( ) const
inlinevirtual

Returns name of object.

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

Reimplemented from TMVA::Configurable.

Definition at line 126 of file Reader.h.

Referenced by Reader().

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 726 of file Reader.cxx.

Double_t TMVA::Reader::GetRarity ( const TString methodTag,
Double_t  mvaVal = -9999999 
)

evaluates the MVA's rarity

Definition at line 757 of file Reader.cxx.

void TMVA::Reader::Init ( void  )
private

default initialisation (no member variables) default initialisation (no member variables)

Definition at line 291 of file Reader.cxx.

Referenced by Reader().

MsgLogger& TMVA::Reader::Log ( ) const
inlineprivate

Definition at line 175 of file Reader.h.

void TMVA::Reader::SetVerbose ( Bool_t  v)
inline

Definition at line 128 of file Reader.h.

Bool_t TMVA::Reader::Verbose ( void  ) const
inline

Definition at line 127 of file Reader.h.

Member Data Documentation

Bool_t TMVA::Reader::fCalculateError
private

Definition at line 165 of file Reader.h.

Bool_t TMVA::Reader::fColor
private

Definition at line 164 of file Reader.h.

DataInputHandler TMVA::Reader::fDataInputHandler
private

Definition at line 151 of file Reader.h.

Referenced by Reader().

DataSetInfo TMVA::Reader::fDataSetInfo
private

Definition at line 149 of file Reader.h.

Referenced by DataInfo(), and Reader().

DataSetManager* TMVA::Reader::fDataSetManager
private

Definition at line 141 of file Reader.h.

Referenced by Reader().

MsgLogger* TMVA::Reader::fLogger
mutableprivate

Definition at line 174 of file Reader.h.

Referenced by Log(), and Reader().

std::map<TString, IMethod*> TMVA::Reader::fMethodMap
private

Definition at line 170 of file Reader.h.

Double_t TMVA::Reader::fMvaEventError
private

Definition at line 167 of file Reader.h.

Referenced by GetMVAError(), and GetMVAErrorLower().

Double_t TMVA::Reader::fMvaEventErrorUpper
private

Definition at line 168 of file Reader.h.

Referenced by GetMVAErrorUpper().

Bool_t TMVA::Reader::fSilent
private

Definition at line 163 of file Reader.h.

std::vector<Float_t> TMVA::Reader::fTmpEvalVec
private

Definition at line 172 of file Reader.h.

Bool_t TMVA::Reader::fVerbose
private

Definition at line 162 of file Reader.h.

Referenced by SetVerbose(), and Verbose().


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