Quick Links: ROOT Homepage Class Index Class Hierarchy

Source: header file inheritance tree (.pdf)

Sections: class description function members data members class charts

class TMVA::Envelope: public TMVA::Configurable

Function Members (Methods)

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

public:

virtual	~Envelope()
void	TObject::AbstractMethod(const char* method) const
void	TMVA::Configurable::AddOptionsXMLTo(void* parent) const
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	BookMethod(TString methodname, TString methodtitle, TString options = "")
virtual void	BookMethod(TMVA::Types::EMVA method, TString methodtitle, TString options = "")
virtual void	TObject::Browse(TBrowser* b)
void	TMVA::Configurable::CheckForUnusedOptions() const
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
TMVA::Configurable	TMVA::Configurable::Configurable(const TString& theOption = "")
TMVA::Configurable	TMVA::Configurable::Configurable(const TMVA::Configurable&)
virtual void	TNamed::Copy(TObject& named) const
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
TMVA::Envelope	Envelope(const TMVA::Envelope&)
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	Evaluate()
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
virtual void	TNamed::FillBuffer(char*& buffer)
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
TMVA::DataLoader*	GetDataLoader()
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
TFile*	GetFile()
virtual const char*	TObject::GetIconName() const
virtual const char*	TNamed::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
virtual const char*	TNamed::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::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	IsModelPersistence()
Bool_t	TObject::IsOnHeap() const
Bool_t	IsSilentFile()
virtual Bool_t	TNamed::IsSortable() const
Bool_t	IsVerbose()
Bool_t	TObject::IsZombie() const
TMVA::MsgLogger&	TMVA::Configurable::Log() const
virtual void	TNamed::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
void	TObject::operator delete(void* ptr)
void	TObject::operator delete(void* ptr, void* vp)
void	TObject::operator delete[](void* ptr)
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)
TMVA::Envelope&	operator=(const TMVA::Envelope&)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TMVA::Configurable::ParseOptions()
virtual void	TObject::Pop()
virtual void	TNamed::Print(Option_t* option = "") const
void	TMVA::Configurable::PrintOptions() const
virtual Int_t	TObject::Read(const char* name)
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)
void	SetDataLoader(TMVA::DataLoader* dalaloader)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
void	SetFile(TFile* file)
void	SetModelPersistence(Bool_t status = kTRUE)
void	TMVA::Configurable::SetMsgType(TMVA::EMsgType t)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
static void	TObject::SetObjectStat(Bool_t stat)
void	TMVA::Configurable::SetOptions(const TString& s)
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TObject::SetUniqueID(UInt_t uid)
void	SetVerbose(Bool_t status)
virtual void	ShowMembers(TMemberInspector& insp) const
virtual Int_t	TNamed::Sizeof() const
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()
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)
TMVA::Envelope	Envelope(const TString& name, TMVA::DataLoader* dataloader = nullptr, TFile* file = nullptr, const TString options = "")
TMVA::DataInputHandler&	GetDataLoaderDataInput()
TMVA::DataSetInfo&	GetDataLoaderDataSetInfo()
TMVA::DataSetManager*	GetDataLoaderDataSetManager()
TMVA::OptionMap&	GetMethod()
const TString&	TMVA::Configurable::GetReferenceFile() const
Bool_t	TMVA::Configurable::LooseOptionCheckingEnabled() const
void	TObject::MakeZombie()
void	TMVA::Configurable::ResetSetFlag()
void	TMVA::Configurable::WriteOptionsReferenceToFile()

Data Members

public:

static TObject::(anonymous)	TObject::kBitMask
static TObject::EStatusBits	TObject::kCanDelete
static TObject::EStatusBits	TObject::kCannotPick
static TObject::EStatusBits	TObject::kHasUUID
static TObject::EStatusBits	TObject::kInvalidObject
static TObject::(anonymous)	TObject::kIsOnHeap
static TObject::EStatusBits	TObject::kIsReferenced
static TObject::EStatusBits	TObject::kMustCleanup
static TObject::EStatusBits	TObject::kNoContextMenu
static TObject::(anonymous)	TObject::kNotDeleted
static TObject::EStatusBits	TObject::kObjInCanvas
static TObject::(anonymous)	TObject::kOverwrite
static TObject::(anonymous)	TObject::kSingleKey
static TObject::(anonymous)	TObject::kWriteDelete
static TObject::(anonymous)	TObject::kZombie

protected:

shared_ptr<TMVA::DataLoader>	fDataLoader	data
shared_ptr<TFile>	fFile	!file to save the results
TMVA::MsgLogger*	TMVA::Configurable::fLogger	! message logger
TMVA::OptionMap	fMethod	Booked method information
Bool_t	fModelPersistence	flag to save the trained model
TString	TNamed::fName	object identifier
TString	TNamed::fTitle	object title
Bool_t	fVerbose	flag for extra information

Class Charts

Inheritance Chart:

TObject

←

TNamed

←

TMVA::Configurable

←

TMVA::Envelope

←

TMVA::CrossValidation

TMVA::HyperParameterOptimisation

TMVA::VariableImportance

Function documentation

Envelope(const TString& name, TMVA::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.
           \param name the name algorithm.
           \param dataloader TMVA::DataLoader object with the data.
           \param file optional file to save the results.
           \param options extra options for the algorithm.

~Envelope()

           Default destructor

void BookMethod(TString methodname, TString methodtitle, TString options = "")

            Method to book the machine learning method to perform the algorithm.
            \param methodname String with the name of the mva method
            \param methodtitle String with the method title.
            \param options String with the options for the method.

void BookMethod(TMVA::Types::EMVA method, TString methodtitle, TString options = "")

            Method to book the machine learning method to perform the algorithm.
            \param method enum TMVA::Types::EMVA with the type of the mva method
            \param methodtitle String with the method title.
            \param options String with the options for the method.

Bool_t IsSilentFile()

            Method to see if a file is available to save results
            \return Boolean with the status.

TFile* GetFile()

            Method to get the pointer to TFile object.
            \return pointer to TFile object.

void SetFile(TFile* file)

            Method to set the pointer to TFile object,
            with a writable file.
            \param file pointer to TFile object.

DataLoader * GetDataLoader()

            Method to get the pointer to TMVA::DataLoader object.
            \return  pointer to TMVA::DataLoader object.

void SetDataLoader(TMVA::DataLoader* dalaloader)

            Method to set the pointer to TMVA::DataLoader object.
            \param file pointer to TFile object.

Bool_t IsModelPersistence()

            Method to see if the algorithm model is saved in xml or serialized files.
            \return Boolean with the status.

void SetModelPersistence(Bool_t status = kTRUE)

            Method enable model persistence, then algorithms model is saved in xml or serialized files.
            \param status Boolean with the status.

Bool_t IsVerbose()

            Method to see if the algorithm should print extra information.
            \return Boolean with the status.

void SetVerbose(Bool_t status)

            Method enable print extra information in the algorithms.
            \param status Boolean with the status.

void Evaluate()

            Virtual method to be implmented with your algorithm.

OptionMap & GetMethod()

            Method get the Booked method in a option map object.
            \return TMVA::OptionMap with the information of the Booked method

DataInputHandler& GetDataLoaderDataInput()

            Utility method to get TMVA::DataInputHandler reference from the DataLoader.
            \return TMVA::DataInputHandler reference.

{ return *fDataLoader->fDataInputHandler; }

DataSetInfo& GetDataLoaderDataSetInfo()

            Utility method to get TMVA::DataSetInfo reference from the DataLoader.
            \return TMVA::DataSetInfo reference.

{return fDataLoader->DefaultDataSetInfo();}

DataSetManager* GetDataLoaderDataSetManager()

            Utility method to get TMVA::DataSetManager pointer from the DataLoader.
            \return TMVA::DataSetManager pointer.

{return fDataLoader->fDataSetManager;}