Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file source file viewVC header viewVC source

Sections: class description function members data members class charts

class TMVA::Reader: public TMVA::Configurable


  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:

    // ------ before starting the event loop (eg, in the initialisation step)


    // create TMVA::Reader object

    TMVA::Reader *reader = new TMVA::Reader();

    // create a set of variables and declare them to the reader
    // - the variable names must corresponds in name and type to
    // those given in the weight file(s) that you use
    Float_t var1, var2, var3, var4;
    reader->AddVariable( "var1", &var1 );
    reader->AddVariable( "var2", &var2 );
    reader->AddVariable( "var3", &var3 );
    reader->AddVariable( "var4", &var4 );

    // book the MVA of your choice (prior training of these methods, ie,
    // existence of the weight files is required)
    reader->BookMVA( "Fisher method",  "weights/Fisher.weights.txt"   );
    reader->BookMVA( "MLP method",     "weights/MLP.weights.txt" );
    // ... etc

    // ------- start your event loop

    for (Long64_t ievt=0; ievt<myTree->GetEntries();ievt++) {

      // fill vector with values of variables computed from those in the tree
      var1 = myvar1;
      var2 = myvar2;
      var3 = myvar3;
      var4 = myvar4;

      // retrieve the corresponding MVA output
      double mvaFi = reader->EvaluateMVA( "Fisher method" );
      double mvaNN = reader->EvaluateMVA( "MLP method"    );

      // do something with these ...., e.g., fill them into your ntuple

    } // end of event loop

    delete reader;


  An example application of the Reader can be found in TMVA/macros/TMVApplication.C.

Function Members (Methods)

public:

virtual	~Reader()
void	TObject::AbstractMethod(const char* method) const
void	TMVA::Configurable::AddOptionsXMLTo(void* parent) const
void	AddSpectator(const TString& expression, Float_t*)
void	AddSpectator(const TString& expression, Int_t*)
void	AddVariable(const TString& expression, Float_t*)
void	AddVariable(const TString& expression, Int_t*)
virtual void	TObject::AppendPad(Option_t* option = "")
TMVA::IMethod*	BookMVA(const TString& methodTag, const TString& weightfile)
TMVA::IMethod*	BookMVA(TMVA::Types::EMVA methodType, const char* xmlstr)
virtual void	TObject::Browse(TBrowser* b)
void	TMVA::Configurable::CheckForUnusedOptions() const
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
TMVA::Configurable	TMVA::Configurable::Configurable(const TString& theOption = "")
virtual void	TObject::Copy(TObject& object) const
const TMVA::DataSetInfo&	DataInfo() const
TMVA::DataSetInfo&	DataInfo()
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
const vector<Float_t>&	EvaluateMulticlass(const TString& methodTag, Double_t aux = 0)
const vector<Float_t>&	EvaluateMulticlass(TMVA::MethodBase* method, Double_t aux = 0)
Float_t	EvaluateMulticlass(UInt_t clsNumber, const TString& methodTag, Double_t aux = 0)
Double_t	EvaluateMVA(TMVA::MethodBase* method, Double_t aux = 0)
Double_t	EvaluateMVA(const TString& methodTag, Double_t aux = 0)
Double_t	EvaluateMVA(const vector<Float_t>&, const TString& methodTag, Double_t aux = 0)
Double_t	EvaluateMVA(const vector<Double_t>&, const TString& methodTag, Double_t aux = 0)
const vector<Float_t>&	EvaluateRegression(const TString& methodTag, Double_t aux = 0)
const vector<Float_t>&	EvaluateRegression(TMVA::MethodBase* method, Double_t aux = 0)
Float_t	EvaluateRegression(UInt_t tgtNumber, const TString& methodTag, Double_t aux = 0)
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
TMVA::MethodCuts*	FindCutsMVA(const TString& methodTag)
TMVA::IMethod*	FindMVA(const TString& methodTag)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
const char*	TMVA::Configurable::GetConfigDescription() const
const char*	TMVA::Configurable::GetConfigName() const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
virtual const char*	TObject::GetIconName() const
Double_t	GetMVAError() const
Double_t	GetMVAErrorLower() const
Double_t	GetMVAErrorUpper() const
virtual const char*	GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
const TString&	TMVA::Configurable::GetOptions() const
Double_t	GetProba(const TString& methodTag, Double_t ap_sig = 0.5, Double_t mvaVal = -9999999)
Double_t	GetRarity(const TString& methodTag, Double_t mvaVal = -9999999)
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TObject::Hash() const
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TObject::IsSortable() const
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
TObject&	TObject::operator=(const TObject& rhs)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TMVA::Configurable::ParseOptions()
virtual void	TObject::Pop()
virtual void	TObject::Print(Option_t* option = "") const
void	TMVA::Configurable::PrintOptions() const
virtual Int_t	TObject::Read(const char* name)
TMVA::Reader	Reader(const TString& theOption = "", Bool_t verbose = 0)
TMVA::Reader	Reader(vector<std::string>& varNames, const TString& theOption = "", Bool_t verbose = 0)
TMVA::Reader	Reader(const string& varNames, const TString& theOption, Bool_t verbose = 0)
TMVA::Reader	Reader(vector<TString>& varNames, const TString& theOption = "", Bool_t verbose = 0)
TMVA::Reader	Reader(const TString& varNames, const TString& theOption, Bool_t verbose = 0)
void	TMVA::Configurable::ReadOptionsFromStream(istream& istr)
void	TMVA::Configurable::ReadOptionsFromXML(void* node)
virtual void	TObject::RecursiveRemove(TObject* obj)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
void	TMVA::Configurable::SetConfigDescription(const char* d)
void	TMVA::Configurable::SetConfigName(const char* n)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	TMVA::Configurable::SetMsgType(TMVA::EMsgType t)
static void	TObject::SetObjectStat(Bool_t stat)
void	TMVA::Configurable::SetOptions(const TString& s)
virtual void	TObject::SetUniqueID(UInt_t uid)
void	SetVerbose(Bool_t v)
virtual void	ShowMembers(TMemberInspector&)
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
virtual void	TObject::UseCurrentStyle()
Bool_t	Verbose() const
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
void	TMVA::Configurable::WriteOptionsToStream(ostream& o, const TString& prefix) const

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TMVA::Configurable::EnableLooseOptions(Bool_t b = kTRUE)
const TString&	TMVA::Configurable::GetReferenceFile() const
Bool_t	TMVA::Configurable::LooseOptionCheckingEnabled() const
void	TObject::MakeZombie()
void	TMVA::Configurable::ResetSetFlag()
void	TMVA::Configurable::WriteOptionsReferenceToFile()

private:

TMVA::IMethod*	BookMVA(TMVA::Types::EMVA method, const TString& weightfile)
void	DeclareOptions()
void	DecodeVarNames(const string& varNames)
void	DecodeVarNames(const TString& varNames)
TString	GetMethodTypeFromFile(const TString& filename)
void	Init()
TMVA::MsgLogger&	Log() const

Data Members

public:

enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

private:

Bool_t	fCalculateError	error calculation mode
Bool_t	fColor	color mode
TMVA::DataInputHandler	fDataInputHandler
TMVA::DataSetInfo	fDataSetInfo	the data set
TMVA::DataSetManager*	fDataSetManager	DSMTEST
TMVA::MsgLogger*	fLogger	message logger
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
vector<Float_t>	fTmpEvalVec	temporary evaluation vector (if user input is v<double>)
Bool_t	fVerbose	verbosity

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

Reader(const TString& theOption = "", Bool_t verbose = 0)

 constructor

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

 constructor

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

 constructor

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

 constructor

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

 constructor

void DeclareOptions()

 declaration of configuration options

~Reader( void )

 destructor

void Init( void )

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

void AddVariable(const TString& expression, Float_t* )

 Add a float variable or expression to the reader

void AddVariable(const TString& expression, Int_t* )

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

TString GetMethodTypeFromFile(const TString& filename)

 read the method type from the file

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

 read method name from weight file

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

 books MVA method from weightfile

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

Double_t EvaluateMVA( const std::vector<Float_t>& inputVec, const TString& methodTag, Double_t aux )

 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 std::vector<Double_t>& inputVec, const TString& methodTag, Double_t aux )

 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 TString& methodTag, Double_t aux = 0)

 evaluates MVA for given set of input variables

Double_t EvaluateMVA(TMVA::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(TMVA::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..

Float_t EvaluateRegression(UInt_t tgtNumber, const TString& methodTag, Double_t aux = 0)

 evaluates the regression MVA

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(TMVA::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..

Float_t EvaluateMulticlass(UInt_t clsNumber, const TString& methodTag, Double_t aux = 0)

 evaluates the multiclass MVA

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

 return pointer to method with tag "methodTag"

TMVA::MethodCuts* FindCutsMVA(const TString& methodTag)

 special function for Cuts to avoid dynamic_casts in ROOT macros,
 which are not properly handled by CINT

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

void DecodeVarNames( const std::string& varNames )

 decodes "name1:name2:..." form

void DecodeVarNames(const TString& varNames)

 decodes "name1:name2:..." form

Double_t GetMVAError() const

 returns error on MVA response for given event
 NOTE: must be called AFTER "EvaluateMVA(...)" call !

{ return fMvaEventError; }

Double_t GetMVAErrorLower() const

{ return fMvaEventError; }

Double_t GetMVAErrorUpper() const

{ return fMvaEventErrorUpper; }

const char* GetName() const

 accessors

{ return "Reader"; }

Bool_t Verbose( void )

{ return fVerbose; }

void SetVerbose(Bool_t v)

{ fVerbose = v; }

const DataSetInfo& DataInfo() const

{ return fDataSetInfo; }

DataSetInfo& DataInfo()

{ return fDataSetInfo; }