Definition at line 44 of file VariableImportance.h.

Public Member Functions
	VariableImportance (DataLoader *loader)

	~VariableImportance ()

virtual void	Evaluate ()
	Virtual method to be implemented with your algorithm.

const VariableImportanceResult &	GetResults () const

VIType	GetType ()

virtual TClass *	IsA () const

void	SetType (VIType type)

virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TMVA::Envelope
	~Envelope ()
	Default destructor.

virtual void	BookMethod (TString methodname, TString methodtitle, TString options="")
	Method to book the machine learning method to perform the algorithm.

virtual void	BookMethod (Types::EMVA method, TString methodtitle, TString options="")
	Method to book the machine learning method to perform the algorithm.

DataLoader *	GetDataLoader ()
	Method to get the pointer to TMVA::DataLoader object.

TFile *	GetFile ()
	Method to get the pointer to TFile object.

std::vector< OptionMap > &	GetMethods ()
	Method get the Booked methods in a option map object.

Bool_t	HasMethod (TString methodname, TString methodtitle)
	function to check methods booked

Bool_t	IsModelPersistence ()
	Method to see if the algorithm model is saved in xml or serialized files.

Bool_t	IsSilentFile ()
	Method to see if a file is available to save results.

Bool_t	IsVerbose ()
	Method to see if the algorithm should print extra information.

virtual void	ParseOptions ()
	Method to parse the internal option string.

void	SetDataLoader (DataLoader *dalaloader)
	Method to set the pointer to TMVA::DataLoader object.

void	SetFile (TFile *file)
	Method to set the pointer to TFile object, with a writable file.

void	SetModelPersistence (Bool_t status=kTRUE)
	Method enable model persistence, then algorithms model is saved in xml or serialized files.

void	SetVerbose (Bool_t status)
	Method enable print extra information in the algorithms.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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

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.

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	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::Envelope
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.

Protected Member Functions
void	EvaluateImportanceAll ()

void	EvaluateImportanceRandom (UInt_t nseeds)

void	EvaluateImportanceShort ()

TH1F *	GetImportance (const UInt_t nbits, std::vector< Float_t > &importances, std::vector< TString > &varNames)

ULong_t	Sum (ULong_t i)

Protected Member Functions inherited from TMVA::Envelope
	Envelope (const TString &name, DataLoader dataloader=nullptr, TFile file=nullptr, const TString options="")
	Constructor for the initialization of Envelopes, differents Envelopes may needs differents constructors then this is a generic one protected.

DataInputHandler &	GetDataLoaderDataInput ()
	Utility method to get TMVA::DataInputHandler reference from the DataLoader.

DataSetInfo &	GetDataLoaderDataSetInfo ()
	Utility method to get TMVA::DataSetInfo reference from the DataLoader.

DataSetManager *	GetDataLoaderDataSetManager ()
	Utility method to get TMVA::DataSetManager pointer from the DataLoader.

TDirectory *	RootBaseDir ()
	Utility method to get base dir directory from current file.

void	WriteDataInformation (TMVA::DataSetInfo &fDataSetInfo, TMVA::Types::EAnalysisType fAnalysisType)
	method to save Train/Test information into the output file.

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 ()

Private Attributes
std::unique_ptr< Factory >	fClassifier

UInt_t	fNumFolds = 0

VariableImportanceResult	fResults

VIType	fType {kShort}

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 Attributes inherited from TMVA::Envelope
std::shared_ptr< DataLoader >	fDataLoader
	! data

std::shared_ptr< TFile >	fFile
	! file to save the results

UInt_t	fJobs
	! number of jobs to run some high level algorithm in parallel

std::vector< OptionMap >	fMethods
	! Booked method information

Bool_t	fModelPersistence
	! flag to save the trained model

Bool_t	fSilentFile
	! if true dont produce file output

TStopwatch	fTimer
	! timer to measure the time.

TString	fTransformations
	! List of transformations to test

Bool_t	fVerbose
	! flag for extra information

TProcPool	fWorkers
	! procpool object

Protected Attributes inherited from TMVA::Configurable
MsgLogger *	fLogger
	! message logger

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TMVA/VariableImportance.h>

Inheritance diagram for TMVA::VariableImportance:

[legend]

Constructor & Destructor Documentation

◆ VariableImportance()

TMVA::VariableImportance::VariableImportance ( TMVA::DataLoader * dataloader )

explicit

Definition at line 91 of file VariableImportance.cxx.

◆ ~VariableImportance()

TMVA::VariableImportance::~VariableImportance ( )

Definition at line 98 of file VariableImportance.cxx.

Member Function Documentation

◆ Class()

static TClass * TMVA::VariableImportance::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMVA::VariableImportance::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::VariableImportance::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 75 of file VariableImportance.h.

◆ DeclFileName()

static const char * TMVA::VariableImportance::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 75 of file VariableImportance.h.

◆ Evaluate()

void TMVA::VariableImportance::Evaluate ( )

virtual

Virtual method to be implemented with your algorithm.

Implements TMVA::Envelope.

Definition at line 105 of file VariableImportance.cxx.

◆ EvaluateImportanceAll()

void TMVA::VariableImportance::EvaluateImportanceAll ( )

protected

Definition at line 413 of file VariableImportance.cxx.

◆ EvaluateImportanceRandom()

void TMVA::VariableImportance::EvaluateImportanceRandom ( UInt_t nseeds )

protected

Definition at line 293 of file VariableImportance.cxx.

◆ EvaluateImportanceShort()

void TMVA::VariableImportance::EvaluateImportanceShort ( )

protected

Definition at line 183 of file VariableImportance.cxx.

◆ GetImportance()

TH1F * TMVA::VariableImportance::GetImportance	(	const UInt_t	nbits,
		std::vector< Float_t > &	importances,
		std::vector< TString > &	varNames
	)

protected

Definition at line 140 of file VariableImportance.cxx.

◆ GetResults()

const VariableImportanceResult & TMVA::VariableImportance::GetResults ( ) const

inline

Definition at line 58 of file VariableImportance.h.

◆ GetType()

VIType TMVA::VariableImportance::GetType ( )

inline

Definition at line 56 of file VariableImportance.h.

◆ IsA()

virtual TClass * TMVA::VariableImportance::IsA ( ) const

inlinevirtual

Returns: TClass describing current object

Reimplemented from TMVA::Envelope.

Definition at line 75 of file VariableImportance.h.

◆ SetType()

void TMVA::VariableImportance::SetType ( VIType type )

inline

Definition at line 55 of file VariableImportance.h.

◆ Streamer()

virtual void TMVA::VariableImportance::Streamer ( TBuffer & R__b )

virtual

Stream an object of class TObject.

Reimplemented from TMVA::Envelope.

◆ StreamerNVirtual()

void TMVA::VariableImportance::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 75 of file VariableImportance.h.

◆ Sum()

ULong_t TMVA::VariableImportance::Sum ( ULong_t i )

protected

Definition at line 131 of file VariableImportance.cxx.

Member Data Documentation

◆ fClassifier

std::unique_ptr<Factory> TMVA::VariableImportance::fClassifier

private

Definition at line 74 of file VariableImportance.h.

◆ fNumFolds

UInt_t TMVA::VariableImportance::fNumFolds = 0

private

Definition at line 46 of file VariableImportance.h.

◆ fResults

VariableImportanceResult TMVA::VariableImportance::fResults

private

Definition at line 47 of file VariableImportance.h.

◆ fType

VIType TMVA::VariableImportance::fType {kShort}

private

Definition at line 48 of file VariableImportance.h.

Libraries for TMVA::VariableImportance:

[legend]

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

tmva/tmva/inc/TMVA/VariableImportance.h
tmva/tmva/src/VariableImportance.cxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ VariableImportance()

◆ ~VariableImportance()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ Evaluate()

◆ EvaluateImportanceAll()

◆ EvaluateImportanceRandom()

◆ EvaluateImportanceShort()

◆ GetImportance()

◆ GetResults()

◆ GetType()

◆ IsA()

◆ SetType()

◆ Streamer()

◆ StreamerNVirtual()

◆ Sum()

Member Data Documentation

◆ fClassifier

◆ fNumFolds

◆ fResults

◆ fType