Definition at line 50 of file RuleFitAPI.h.

Classes
struct	IntParms

struct	RealParms

Public Member Functions
	RuleFitAPI (const TMVA::MethodRuleFit rfbase, TMVA::RuleFit rulefit, EMsgType minType)

virtual	~RuleFitAPI ()
	destructor More...

void	WelcomeMessage ()
	welcome message More...

void	HowtoSetupRF ()
	howto message More...

void	SetRFWorkDir (const char *wdir)
	set the directory containing rf_go.exe. More...

void	CheckRFWorkDir ()
	check if the rulefit work dir is properly setup. More...

void	TrainRuleFit ()

void	TestRuleFit ()

void	VarImp ()

Bool_t	ReadModelSum ()
	read model from rulefit.sum More...

const TString	GetRFWorkDir () const

Protected Types
enum	ERFMode { kRfRegress =1, kRfClass =2 }

enum	EModel { kRfLinear =0, kRfRules =1, kRfBoth =2 }

enum	ERFProgram { kRfTrain =0, kRfPredict, kRfVarimp }

Protected Member Functions
void	InitRuleFit ()
	default initialisation SetRFWorkDir("./rulefit"); More...

void	FillRealParmsDef ()
	set default real params More...

void	FillIntParmsDef ()
	set default int params More...

void	ImportSetup ()
	import setup from MethodRuleFit More...

void	SetTrainParms ()
	set the training parameters More...

void	SetTestParms ()
	set the test params More...

Int_t	RunRuleFit ()
	execute rf_go.exe More...

void	SetRFTrain ()

void	SetRFPredict ()

void	SetRFVarimp ()

TString	GetRFName (TString name)

Bool_t	OpenRFile (TString name, std::ofstream &f)

Bool_t	OpenRFile (TString name, std::ifstream &f)

Bool_t	WriteInt (std::ofstream &f, const Int_t *v, Int_t n=1)

Bool_t	WriteFloat (std::ofstream &f, const Float_t *v, Int_t n=1)

Int_t	ReadInt (std::ifstream &f, Int_t *v, Int_t n=1) const

Int_t	ReadFloat (std::ifstream &f, Float_t *v, Int_t n=1) const

Bool_t	WriteAll ()
	write all files read by rf_go.exe More...

Bool_t	WriteIntParms ()
	write int params file More...

Bool_t	WriteRealParms ()
	write int params file More...

Bool_t	WriteLx ()
	Save input variable mask. More...

Bool_t	WriteProgram ()
	write command to rf_go.exe More...

Bool_t	WriteRealVarImp ()
	write the minimum importance to be considered More...

Bool_t	WriteRfOut ()
	written by rf_go.exe; write rulefit output (rfout) More...

Bool_t	WriteRfStatus ()
	written by rf_go.exe; write rulefit status More...

Bool_t	WriteRuleFitMod ()
	written by rf_go.exe (NOTE:Format unknown!) More...

Bool_t	WriteRuleFitSum ()
	written by rf_go.exe (NOTE: format unknown!) More...

Bool_t	WriteTrain ()
	write training data, columnwise More...

Bool_t	WriteVarNames ()
	write variable names, ascii More...

Bool_t	WriteVarImp ()

Bool_t	WriteYhat ()
	written by rf_go.exe More...

Bool_t	WriteTest ()
	Write test data. More...

Bool_t	ReadYhat ()
	read the score More...

Bool_t	ReadIntParms ()

Bool_t	ReadRealParms ()

Bool_t	ReadLx ()

Bool_t	ReadProgram ()

Bool_t	ReadRealVarImp ()

Bool_t	ReadRfOut ()

Bool_t	ReadRfStatus ()

Bool_t	ReadRuleFitMod ()

Bool_t	ReadRuleFitSum ()

Bool_t	ReadTrainX ()

Bool_t	ReadTrainY ()

Bool_t	ReadTrainW ()

Bool_t	ReadVarNames ()

Bool_t	ReadVarImp ()
	read variable importance More...

Private Member Functions
	RuleFitAPI ()

Private Attributes
const MethodRuleFit *	fMethodRuleFit

RuleFit *	fRuleFit

std::vector< Float_t >	fRFYhat

std::vector< Float_t >	fRFVarImp

std::vector< Int_t >	fRFVarImpInd

TString	fRFWorkDir

IntParms	fRFIntParms

RealParms	fRFRealParms

std::vector< int >	fRFLx

ERFProgram	fRFProgram

TString	fModelType

MsgLogger	fLogger

#include <TMVA/RuleFitAPI.h>

Collaboration diagram for TMVA::RuleFitAPI:

Member Enumeration Documentation

§ EModel

enum TMVA::RuleFitAPI::EModel

protected

Enumerator
kRfLinear
kRfRules
kRfBoth

Definition at line 84 of file RuleFitAPI.h.

§ ERFMode

enum TMVA::RuleFitAPI::ERFMode

protected

Enumerator
kRfRegress
kRfClass

Definition at line 83 of file RuleFitAPI.h.

§ ERFProgram

enum TMVA::RuleFitAPI::ERFProgram

protected

Enumerator
kRfTrain
kRfPredict
kRfVarimp

Definition at line 85 of file RuleFitAPI.h.

Constructor & Destructor Documentation

§ RuleFitAPI() [1/2]

TMVA::RuleFitAPI::RuleFitAPI	(	const TMVA::MethodRuleFit *	rfbase,
		TMVA::RuleFit *	rulefit,
		EMsgType	minType = `kINFO`
	)

Definition at line 45 of file RuleFitAPI.cxx.

§ ~RuleFitAPI()

TMVA::RuleFitAPI::~RuleFitAPI ( )

virtual

destructor

Definition at line 66 of file RuleFitAPI.cxx.

§ RuleFitAPI() [2/2]

TMVA::RuleFitAPI::RuleFitAPI ( )

private

Referenced by SetRFVarimp().

Member Function Documentation

§ CheckRFWorkDir()

void TMVA::RuleFitAPI::CheckRFWorkDir ( )

check if the rulefit work dir is properly setup.

it aborts (kFATAL) if not.

Check existance of directory

Definition at line 163 of file RuleFitAPI.cxx.

Referenced by InitRuleFit().

§ FillIntParmsDef()

void TMVA::RuleFitAPI::FillIntParmsDef ( )

protected

set default int params

Definition at line 225 of file RuleFitAPI.cxx.

Referenced by InitRuleFit().

§ FillRealParmsDef()

void TMVA::RuleFitAPI::FillRealParmsDef ( )

protected

set default real params

Definition at line 210 of file RuleFitAPI.cxx.

Referenced by InitRuleFit().

§ GetRFName()

TString TMVA::RuleFitAPI::GetRFName ( TString name )

inlineprotected

Definition at line 230 of file RuleFitAPI.h.

Referenced by OpenRFile(), and SetRFVarimp().

§ GetRFWorkDir()

const TString TMVA::RuleFitAPI::GetRFWorkDir ( ) const

inline

Definition at line 79 of file RuleFitAPI.h.

§ HowtoSetupRF()

void TMVA::RuleFitAPI::HowtoSetupRF ( )

howto message

Definition at line 89 of file RuleFitAPI.cxx.

Referenced by CheckRFWorkDir().

§ ImportSetup()

void TMVA::RuleFitAPI::ImportSetup ( )

protected

import setup from MethodRuleFit

Definition at line 129 of file RuleFitAPI.cxx.

Referenced by SetTestParms(), and SetTrainParms().

§ InitRuleFit()

void TMVA::RuleFitAPI::InitRuleFit ( )

protected

default initialisation SetRFWorkDir("./rulefit");

Definition at line 119 of file RuleFitAPI.cxx.

§ OpenRFile() [1/2]

Bool_t TMVA::RuleFitAPI::OpenRFile	(	TString	name,
		std::ofstream &	f
	)

inlineprotected

Definition at line 237 of file RuleFitAPI.h.

Referenced by ReadModelSum(), ReadVarImp(), ReadYhat(), SetRFVarimp(), WriteIntParms(), WriteLx(), WriteProgram(), WriteRealParms(), WriteRealVarImp(), WriteTest(), WriteTrain(), and WriteVarNames().

§ OpenRFile() [2/2]

Bool_t TMVA::RuleFitAPI::OpenRFile	(	TString	name,
		std::ifstream &	f
	)

inlineprotected

Definition at line 251 of file RuleFitAPI.h.

§ ReadFloat()

Int_t TMVA::RuleFitAPI::ReadFloat	(	std::ifstream &	f,
		Float_t *	v,
		Int_t	n = `1`
	)		const

inlineprotected

Definition at line 290 of file RuleFitAPI.h.

Referenced by ReadModelSum(), ReadVarImp(), ReadYhat(), and SetRFVarimp().

§ ReadInt()

Int_t TMVA::RuleFitAPI::ReadInt	(	std::ifstream &	f,
		Int_t *	v,
		Int_t	n = `1`
	)		const

inlineprotected

Definition at line 281 of file RuleFitAPI.h.

Referenced by ReadModelSum(), and SetRFVarimp().

§ ReadIntParms()

Bool_t TMVA::RuleFitAPI::ReadIntParms ( )

protected

Referenced by SetRFVarimp().

§ ReadLx()

Bool_t TMVA::RuleFitAPI::ReadLx ( )

protected

Referenced by SetRFVarimp().

§ ReadModelSum()

Bool_t TMVA::RuleFitAPI::ReadModelSum ( )

read model from rulefit.sum

Definition at line 541 of file RuleFitAPI.cxx.

Referenced by TMVA::MethodRuleFit::TrainJFRuleFit().

§ ReadProgram()

Bool_t TMVA::RuleFitAPI::ReadProgram ( )

protected

Referenced by SetRFVarimp().

§ ReadRealParms()

Bool_t TMVA::RuleFitAPI::ReadRealParms ( )

protected

Referenced by SetRFVarimp().

§ ReadRealVarImp()

Bool_t TMVA::RuleFitAPI::ReadRealVarImp ( )

protected

Referenced by SetRFVarimp().

§ ReadRfOut()

Bool_t TMVA::RuleFitAPI::ReadRfOut ( )

protected

Referenced by SetRFVarimp().

§ ReadRfStatus()

Bool_t TMVA::RuleFitAPI::ReadRfStatus ( )

protected

Referenced by SetRFVarimp().

§ ReadRuleFitMod()

Bool_t TMVA::RuleFitAPI::ReadRuleFitMod ( )

protected

Referenced by SetRFVarimp().

§ ReadRuleFitSum()

Bool_t TMVA::RuleFitAPI::ReadRuleFitSum ( )

protected

Referenced by SetRFVarimp().

§ ReadTrainW()

Bool_t TMVA::RuleFitAPI::ReadTrainW ( )

protected

Referenced by SetRFVarimp().

§ ReadTrainX()

Bool_t TMVA::RuleFitAPI::ReadTrainX ( )

protected

Referenced by SetRFVarimp().

§ ReadTrainY()

Bool_t TMVA::RuleFitAPI::ReadTrainY ( )

protected

Referenced by SetRFVarimp().

§ ReadVarImp()

Bool_t TMVA::RuleFitAPI::ReadVarImp ( )

protected

read variable importance

Definition at line 504 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and VarImp().

§ ReadVarNames()

Bool_t TMVA::RuleFitAPI::ReadVarNames ( )

protected

Referenced by SetRFVarimp().

§ ReadYhat()

Bool_t TMVA::RuleFitAPI::ReadYhat ( )

protected

read the score

Definition at line 479 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and TestRuleFit().

§ RunRuleFit()

Int_t TMVA::RuleFitAPI::RunRuleFit ( )

protected

execute rf_go.exe

Definition at line 769 of file RuleFitAPI.cxx.

Referenced by TestRuleFit(), TrainRuleFit(), and VarImp().

§ SetRFPredict()

void TMVA::RuleFitAPI::SetRFPredict ( )

inlineprotected

Definition at line 128 of file RuleFitAPI.h.

§ SetRFTrain()

void TMVA::RuleFitAPI::SetRFTrain ( )

inlineprotected

Definition at line 127 of file RuleFitAPI.h.

§ SetRFVarimp()

void TMVA::RuleFitAPI::SetRFVarimp ( )

inlineprotected

Definition at line 129 of file RuleFitAPI.h.

Referenced by VarImp().

§ SetRFWorkDir()

void TMVA::RuleFitAPI::SetRFWorkDir ( const char * wdir )

set the directory containing rf_go.exe.

Definition at line 152 of file RuleFitAPI.cxx.

§ SetTestParms()

void TMVA::RuleFitAPI::SetTestParms ( )

protected

set the test params

Definition at line 198 of file RuleFitAPI.cxx.

Referenced by TestRuleFit().

§ SetTrainParms()

void TMVA::RuleFitAPI::SetTrainParms ( )

protected

set the training parameters

Definition at line 185 of file RuleFitAPI.cxx.

Referenced by TrainRuleFit().

§ TestRuleFit()

void TMVA::RuleFitAPI::TestRuleFit ( )

inline

Definition at line 210 of file RuleFitAPI.h.

§ TrainRuleFit()

void TMVA::RuleFitAPI::TrainRuleFit ( )

inline

Definition at line 201 of file RuleFitAPI.h.

Referenced by TMVA::MethodRuleFit::TrainJFRuleFit().

§ VarImp()

void TMVA::RuleFitAPI::VarImp ( )

inline

Definition at line 220 of file RuleFitAPI.h.

§ WelcomeMessage()

void TMVA::RuleFitAPI::WelcomeMessage ( )

welcome message

Definition at line 73 of file RuleFitAPI.cxx.

Referenced by TMVA::MethodRuleFit::TrainJFRuleFit().

§ WriteAll()

Bool_t TMVA::RuleFitAPI::WriteAll ( )

protected

write all files read by rf_go.exe

Definition at line 245 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), TestRuleFit(), TrainRuleFit(), and VarImp().

§ WriteFloat()

Bool_t TMVA::RuleFitAPI::WriteFloat	(	std::ofstream &	f,
		const Float_t *	v,
		Int_t	n = `1`
	)

inlineprotected

Definition at line 273 of file RuleFitAPI.h.

Referenced by SetRFVarimp(), WriteRealParms(), WriteRealVarImp(), WriteTest(), and WriteTrain().

§ WriteInt()

Bool_t TMVA::RuleFitAPI::WriteInt	(	std::ofstream &	f,
		const Int_t *	v,
		Int_t	n = `1`
	)

inlineprotected

Definition at line 265 of file RuleFitAPI.h.

Referenced by SetRFVarimp(), WriteIntParms(), and WriteLx().

§ WriteIntParms()

Bool_t TMVA::RuleFitAPI::WriteIntParms ( )

protected

write int params file

Definition at line 261 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteLx()

Bool_t TMVA::RuleFitAPI::WriteLx ( )

protected

Save input variable mask.

If the lx vector size is not the same as inputVars, resize it and fill it with 1 NOTE: Always set all to 1 if (fRFLx.size() != m_inputVars->size()) {

Definition at line 288 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteProgram()

Bool_t TMVA::RuleFitAPI::WriteProgram ( )

protected

write command to rf_go.exe

Definition at line 302 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteRealParms()

Bool_t TMVA::RuleFitAPI::WriteRealParms ( )

protected

write int params file

Definition at line 272 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteRealVarImp()

Bool_t TMVA::RuleFitAPI::WriteRealVarImp ( )

protected

write the minimum importance to be considered

Definition at line 330 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteRfOut()

Bool_t TMVA::RuleFitAPI::WriteRfOut ( )

protected

written by rf_go.exe; write rulefit output (rfout)

Definition at line 344 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp().

§ WriteRfStatus()

Bool_t TMVA::RuleFitAPI::WriteRfStatus ( )

protected

written by rf_go.exe; write rulefit status

Definition at line 353 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp().

§ WriteRuleFitMod()

Bool_t TMVA::RuleFitAPI::WriteRuleFitMod ( )

protected

written by rf_go.exe (NOTE:Format unknown!)

Definition at line 362 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp().

§ WriteRuleFitSum()

Bool_t TMVA::RuleFitAPI::WriteRuleFitSum ( )

protected

written by rf_go.exe (NOTE: format unknown!)

Definition at line 371 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp().

§ WriteTest()

Bool_t TMVA::RuleFitAPI::WriteTest ( )

protected

Write test data.

Definition at line 415 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteTrain()

Bool_t TMVA::RuleFitAPI::WriteTrain ( )

protected

write training data, columnwise

Definition at line 380 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteVarImp()

Bool_t TMVA::RuleFitAPI::WriteVarImp ( )

protected

Definition at line 459 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp().

§ WriteVarNames()

Bool_t TMVA::RuleFitAPI::WriteVarNames ( )

protected

write variable names, ascii

Definition at line 447 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp(), and WriteAll().

§ WriteYhat()

Bool_t TMVA::RuleFitAPI::WriteYhat ( )

protected

written by rf_go.exe

Definition at line 470 of file RuleFitAPI.cxx.

Referenced by SetRFVarimp().

Member Data Documentation

§ fLogger

MsgLogger TMVA::RuleFitAPI::fLogger

mutableprivate

Definition at line 192 of file RuleFitAPI.h.

Referenced by CheckRFWorkDir(), HowtoSetupRF(), OpenRFile(), ReadModelSum(), ReadYhat(), WelcomeMessage(), WriteRfOut(), WriteRfStatus(), WriteRuleFitMod(), WriteRuleFitSum(), WriteTest(), WriteTrain(), WriteVarImp(), and WriteYhat().

§ fMethodRuleFit

const MethodRuleFit* TMVA::RuleFitAPI::fMethodRuleFit

private

Definition at line 179 of file RuleFitAPI.h.

Referenced by ImportSetup(), ReadVarImp(), ReadYhat(), SetTestParms(), SetTrainParms(), WriteLx(), WriteTest(), WriteTrain(), and WriteVarNames().

§ fModelType

TString TMVA::RuleFitAPI::fModelType

private

Definition at line 190 of file RuleFitAPI.h.

§ fRFIntParms

IntParms TMVA::RuleFitAPI::fRFIntParms

private

Definition at line 186 of file RuleFitAPI.h.

Referenced by FillIntParmsDef(), ImportSetup(), SetTestParms(), SetTrainParms(), and WriteIntParms().

§ fRFLx

std::vector<int> TMVA::RuleFitAPI::fRFLx

private

Definition at line 188 of file RuleFitAPI.h.

Referenced by WriteLx().

§ fRFProgram

ERFProgram TMVA::RuleFitAPI::fRFProgram

private

Definition at line 189 of file RuleFitAPI.h.

Referenced by SetRFPredict(), SetRFTrain(), SetRFVarimp(), SetTestParms(), SetTrainParms(), WriteAll(), and WriteProgram().

§ fRFRealParms

RealParms TMVA::RuleFitAPI::fRFRealParms

private

Definition at line 187 of file RuleFitAPI.h.

Referenced by FillRealParmsDef(), ImportSetup(), and WriteRealParms().

§ fRFVarImp

std::vector<Float_t> TMVA::RuleFitAPI::fRFVarImp

private

Definition at line 183 of file RuleFitAPI.h.

Referenced by ReadModelSum(), and ReadVarImp().

§ fRFVarImpInd

std::vector<Int_t> TMVA::RuleFitAPI::fRFVarImpInd

private

Definition at line 184 of file RuleFitAPI.h.

Referenced by ReadVarImp().

§ fRFWorkDir

TString TMVA::RuleFitAPI::fRFWorkDir

private

Definition at line 185 of file RuleFitAPI.h.

Referenced by CheckRFWorkDir(), GetRFName(), GetRFWorkDir(), HowtoSetupRF(), RunRuleFit(), and SetRFWorkDir().

§ fRFYhat

std::vector<Float_t> TMVA::RuleFitAPI::fRFYhat

private

Definition at line 182 of file RuleFitAPI.h.

Referenced by ReadYhat().

§ fRuleFit

RuleFit* TMVA::RuleFitAPI::fRuleFit

private

Definition at line 180 of file RuleFitAPI.h.

Referenced by ImportSetup(), and ReadModelSum().

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

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Member Enumeration Documentation

§ EModel

§ ERFMode

§ ERFProgram

Constructor & Destructor Documentation

§ RuleFitAPI() [1/2]

§ ~RuleFitAPI()

§ RuleFitAPI() [2/2]

Member Function Documentation

§ CheckRFWorkDir()

§ FillIntParmsDef()

§ FillRealParmsDef()

§ GetRFName()

§ GetRFWorkDir()

§ HowtoSetupRF()

§ ImportSetup()

§ InitRuleFit()

§ OpenRFile() [1/2]

§ OpenRFile() [2/2]

§ ReadFloat()

§ ReadInt()

§ ReadIntParms()

§ ReadLx()

§ ReadModelSum()

§ ReadProgram()

§ ReadRealParms()

§ ReadRealVarImp()

§ ReadRfOut()

§ ReadRfStatus()

§ ReadRuleFitMod()

§ ReadRuleFitSum()

§ ReadTrainW()

§ ReadTrainX()

§ ReadTrainY()

§ ReadVarImp()

§ ReadVarNames()

§ ReadYhat()

§ RunRuleFit()

§ SetRFPredict()

§ SetRFTrain()

§ SetRFVarimp()

§ SetRFWorkDir()

§ SetTestParms()

§ SetTrainParms()

§ TestRuleFit()

§ TrainRuleFit()

§ VarImp()

§ WelcomeMessage()

§ WriteAll()

§ WriteFloat()

§ WriteInt()

§ WriteIntParms()

§ WriteLx()

§ WriteProgram()

§ WriteRealParms()

§ WriteRealVarImp()

§ WriteRfOut()

§ WriteRfStatus()

§ WriteRuleFitMod()

§ WriteRuleFitSum()

§ WriteTest()

§ WriteTrain()

§ WriteVarImp()

§ WriteVarNames()

§ WriteYhat()

Member Data Documentation

§ fLogger

§ fMethodRuleFit

§ fModelType

§ fRFIntParms

§ fRFLx

§ fRFProgram

§ fRFRealParms

§ fRFVarImp