Function discriminant analysis (FDA).

This simple classifier fits any user-defined TFormula (via option configuration string) to the training data by requiring a formula response of 1 (0) to signal (background) events. The parameter fitting is done via the abstract class FitterBase, featuring Monte Carlo sampling, Genetic Algorithm, Simulated Annealing, MINUIT and combinations of these.

Can compute regression value for one dimensional output

Definition at line 61 of file MethodFDA.h.

Public Member Functions
	MethodFDA (const TString &jobName, const TString &methodTitle, DataSetInfo &theData, const TString &theOption="")
	standard constructor

	MethodFDA (DataSetInfo &theData, const TString &theWeightFile)
	constructor from weight file

virtual	~MethodFDA (void)
	destructor

void	AddWeightsXMLTo (void *parent) const
	create XML description for LD classification and regression (for arbitrary number of output classes/targets)

void	CheckSetup ()
	check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase)

const Ranking *	CreateRanking ()

Double_t	EstimatorFunction (std::vector< Double_t > &)
	compute estimator for given parameter set (to be minimised)

virtual const std::vector< Float_t > &	GetMulticlassValues ()

Double_t	GetMvaValue (Double_t err=nullptr, Double_t errUpper=nullptr)
	returns MVA value for given event

virtual const std::vector< Float_t > &	GetRegressionValues ()

Bool_t	HasAnalysisType (Types::EAnalysisType type, UInt_t numberClasses, UInt_t numberTargets)
	FDA can handle classification with 2 classes and regression with one regression-target.

void	Init (void)
	default initialisation

virtual TClass *	IsA () const

virtual void	ReadWeightsFromStream (std::istream &)=0

void	ReadWeightsFromStream (std::istream &i)
	read back the training results from a file (stream)

virtual void	ReadWeightsFromStream (TFile &)

void	ReadWeightsFromXML (void *wghtnode)
	read coefficients from xml weight file

virtual void	Streamer (TBuffer &)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	Train (void)
	FDA training.

Public Member Functions inherited from TMVA::MethodBase
	MethodBase (const TString &jobName, Types::EMVA methodType, const TString &methodTitle, DataSetInfo &dsi, const TString &theOption="")
	standard constructor

	MethodBase (Types::EMVA methodType, DataSetInfo &dsi, const TString &weightFile)
	constructor used for Testing + Application of the MVA, only (no training), using given WeightFiles

virtual	~MethodBase ()
	destructor

void	AddOutput (Types::ETreeType type, Types::EAnalysisType analysisType)

TDirectory *	BaseDir () const
	returns the ROOT directory where info/histograms etc of the corresponding MVA method instance are stored

DataSet *	Data () const

DataSetInfo &	DataInfo () const

virtual void	DeclareCompatibilityOptions ()
	options that are used ONLY for the READER to ensure backward compatibility they are hence without any effect (the reader is only reading the training options that HAD been used at the training of the .xml weight file at hand

void	DisableWriting (Bool_t setter)

Bool_t	DoMulticlass () const

Bool_t	DoRegression () const

void	ExitFromTraining ()

Types::EAnalysisType	GetAnalysisType () const

UInt_t	GetCurrentIter ()

virtual Double_t	GetEfficiency (const TString &, Types::ETreeType, Double_t &err)
	fill background efficiency (resp.

const Event *	GetEvent () const

const Event *	GetEvent (const TMVA::Event *ev) const

const Event *	GetEvent (Long64_t ievt) const

const Event *	GetEvent (Long64_t ievt, Types::ETreeType type) const

const std::vector< TMVA::Event * > &	GetEventCollection (Types::ETreeType type)
	returns the event collection (i.e.

TFile *	GetFile () const

const TString &	GetInputLabel (Int_t i) const

const char *	GetInputTitle (Int_t i) const

const TString &	GetInputVar (Int_t i) const

TMultiGraph *	GetInteractiveTrainingError ()

const TString &	GetJobName () const

virtual Double_t	GetKSTrainingVsTest (Char_t SorB, TString opt="X")

virtual Double_t	GetMaximumSignificance (Double_t SignalEvents, Double_t BackgroundEvents, Double_t &optimal_significance_value) const
	plot significance, \( \frac{S}{\sqrt{S^2 + B^2}} \), curve for given number of signal and background events; returns cut for maximum significance also returned via reference is the maximum significance

UInt_t	GetMaxIter ()

Double_t	GetMean (Int_t ivar) const

const TString &	GetMethodName () const

Types::EMVA	GetMethodType () const

TString	GetMethodTypeName () const

virtual TMatrixD	GetMulticlassConfusionMatrix (Double_t effB, Types::ETreeType type)
	Construct a confusion matrix for a multiclass classifier.

virtual std::vector< Float_t >	GetMulticlassEfficiency (std::vector< std::vector< Float_t > > &purity)

virtual std::vector< Float_t >	GetMulticlassTrainingEfficiency (std::vector< std::vector< Float_t > > &purity)

Double_t	GetMvaValue (const TMVA::Event const ev, Double_t err=nullptr, Double_t *errUpper=nullptr)

const char *	GetName () const

UInt_t	GetNEvents () const

UInt_t	GetNTargets () const

UInt_t	GetNvar () const

UInt_t	GetNVariables () const

virtual Double_t	GetProba (const Event *ev)

virtual Double_t	GetProba (Double_t mvaVal, Double_t ap_sig)
	compute likelihood ratio

const TString	GetProbaName () const

virtual Double_t	GetRarity (Double_t mvaVal, Types::ESBType reftype=Types::kBackground) const
	compute rarity:

virtual void	GetRegressionDeviation (UInt_t tgtNum, Types::ETreeType type, Double_t &stddev, Double_t &stddev90Percent) const

const std::vector< Float_t > &	GetRegressionValues (const TMVA::Event *const ev)

Double_t	GetRMS (Int_t ivar) const

virtual Double_t	GetROCIntegral (PDF pdfS=nullptr, PDF pdfB=nullptr) const
	calculate the area (integral) under the ROC curve as a overall quality measure of the classification

virtual Double_t	GetROCIntegral (TH1D histS, TH1D histB) const
	calculate the area (integral) under the ROC curve as a overall quality measure of the classification

virtual Double_t	GetSeparation (PDF pdfS=nullptr, PDF pdfB=nullptr) const
	compute "separation" defined as

virtual Double_t	GetSeparation (TH1 , TH1 ) const
	compute "separation" defined as

Double_t	GetSignalReferenceCut () const

Double_t	GetSignalReferenceCutOrientation () const

virtual Double_t	GetSignificance () const
	compute significance of mean difference

const Event *	GetTestingEvent (Long64_t ievt) const

Double_t	GetTestTime () const

const TString &	GetTestvarName () const

virtual Double_t	GetTrainingEfficiency (const TString &)

const Event *	GetTrainingEvent (Long64_t ievt) const

virtual const std::vector< Float_t > &	GetTrainingHistory (const char *)

UInt_t	GetTrainingROOTVersionCode () const

TString	GetTrainingROOTVersionString () const
	calculates the ROOT version string from the training version code on the fly

UInt_t	GetTrainingTMVAVersionCode () const

TString	GetTrainingTMVAVersionString () const
	calculates the TMVA version string from the training version code on the fly

Double_t	GetTrainTime () const

TransformationHandler &	GetTransformationHandler (Bool_t takeReroutedIfAvailable=true)

const TransformationHandler &	GetTransformationHandler (Bool_t takeReroutedIfAvailable=true) const

TString	GetWeightFileName () const
	retrieve weight file name

Double_t	GetXmax (Int_t ivar) const

Double_t	GetXmin (Int_t ivar) const

Bool_t	HasMVAPdfs () const

void	InitIPythonInteractive ()

Bool_t	IsModelPersistence () const

virtual Bool_t	IsSignalLike ()
	uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event would be selected as signal or background

virtual Bool_t	IsSignalLike (Double_t mvaVal)
	uses a pre-set cut on the MVA output (SetSignalReferenceCut and SetSignalReferenceCutOrientation) for a quick determination if an event with this mva output value would be selected as signal or background

Bool_t	IsSilentFile () const

virtual void	MakeClass (const TString &classFileName=TString("")) const
	create reader class for method (classification only at present)

TDirectory *	MethodBaseDir () const
	returns the ROOT directory where all instances of the corresponding MVA method are stored

virtual std::map< TString, Double_t >	OptimizeTuningParameters (TString fomType="ROCIntegral", TString fitType="FitGA")
	call the Optimizer with the set of parameters and ranges that are meant to be tuned.

void	PrintHelpMessage () const
	prints out method-specific help method

void	ProcessSetup ()
	process all options the "CheckForUnusedOptions" is done in an independent call, since it may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase)

void	ReadStateFromFile ()
	Function to write options and weights to file.

void	ReadStateFromStream (std::istream &tf)
	read the header from the weight files of the different MVA methods

void	ReadStateFromStream (TFile &rf)
	write reference MVA distributions (and other information) to a ROOT type weight file

void	ReadStateFromXMLString (const char *xmlstr)
	for reading from memory

void	RerouteTransformationHandler (TransformationHandler *fTargetTransformation)

virtual void	Reset ()

virtual void	SetAnalysisType (Types::EAnalysisType type)

void	SetBaseDir (TDirectory *methodDir)

void	SetFile (TFile *file)

void	SetMethodBaseDir (TDirectory *methodDir)

void	SetMethodDir (TDirectory *methodDir)

void	SetModelPersistence (Bool_t status)

void	SetSignalReferenceCut (Double_t cut)

void	SetSignalReferenceCutOrientation (Double_t cutOrientation)

void	SetSilentFile (Bool_t status)

void	SetTestTime (Double_t testTime)

void	SetTestvarName (const TString &v="")

void	SetTrainTime (Double_t trainTime)

virtual void	SetTuneParameters (std::map< TString, Double_t > tuneParameters)
	set the tuning parameters according to the argument This is just a dummy .

void	SetupMethod ()
	setup of methods

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	TestClassification ()
	initialization

virtual void	TestMulticlass ()
	test multiclass classification

virtual void	TestRegression (Double_t &bias, Double_t &biasT, Double_t &dev, Double_t &devT, Double_t &rms, Double_t &rmsT, Double_t &mInf, Double_t &mInfT, Double_t &corr, Types::ETreeType type)
	calculate <sum-of-deviation-squared> of regression output versus "true" value from test sample

bool	TrainingEnded ()

void	TrainMethod ()

virtual void	WriteEvaluationHistosToFile (Types::ETreeType treetype)
	writes all MVA evaluation histograms to file

virtual void	WriteMonitoringHistosToFile () const
	write special monitoring histograms to file dummy implementation here --------------—

void	WriteStateToFile () const
	write options and weights to file note that each one text file for the main configuration information and one ROOT file for ROOT objects are created

Public Member Functions inherited from TMVA::IMethod
	IMethod ()

virtual	~IMethod ()

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

virtual void	ParseOptions ()
	options parser

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.

TClass *	IsA () const override

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	Streamer (TBuffer &) override
	Stream an object of class 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.

Public Member Functions inherited from TMVA::IFitterTarget
	IFitterTarget ()
	constructor

virtual	~IFitterTarget ()

virtual void	ProgressNotifier (TString, TString)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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::MethodBase
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::IMethod
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.

Static Public Member Functions inherited from TMVA::IFitterTarget
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Protected Member Functions
void	GetHelpMessage () const
	get help message text

void	MakeClassSpecific (std::ostream &, const TString &) const
	write FDA-specific classifier response

Protected Member Functions inherited from TMVA::MethodBase
virtual std::vector< Double_t >	GetDataMvaValues (DataSet *data=nullptr, Long64_t firstEvt=0, Long64_t lastEvt=-1, Bool_t logProgress=false)
	get all the MVA values for the events of the given Data type

const TString &	GetInternalVarName (Int_t ivar) const

virtual std::vector< Double_t >	GetMvaValues (Long64_t firstEvt=0, Long64_t lastEvt=-1, Bool_t logProgress=false)
	get all the MVA values for the events of the current Data type

const TString &	GetOriginalVarName (Int_t ivar) const

const TString &	GetWeightFileDir () const

Bool_t	HasTrainingTree () const

Bool_t	Help () const

Bool_t	IgnoreEventsWithNegWeightsInTraining () const

Bool_t	IsConstructedFromWeightFile () const

Bool_t	IsNormalised () const

virtual void	MakeClassSpecificHeader (std::ostream &, const TString &="") const

void	NoErrorCalc (Double_t const err, Double_t const errUpper)

void	SetNormalised (Bool_t norm)

void	SetWeightFileDir (TString fileDir)
	set directory of weight file

void	SetWeightFileName (TString)
	set the weight file name (depreciated)

void	Statistics (Types::ETreeType treeType, const TString &theVarName, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &, Double_t &)
	calculates rms,mean, xmin, xmax of the event variable this can be either done for the variables as they are or for normalised variables (in the range of 0-1) if "norm" is set to kTRUE

Bool_t	TxtWeightsOnly () const

Bool_t	Verbose () const

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 Member Functions
void	CalculateMulticlassValues (const TMVA::Event *&evt, std::vector< Double_t > &parameters, std::vector< Float_t > &values)
	calculate the values for multiclass

void	ClearAll ()
	delete and clear all class members

void	CreateFormula ()
	translate formula string into TFormula, and parameter string into par ranges

void	DeclareOptions ()
	define the options (their key words) that can be set in the option string

Double_t	InterpretFormula (const Event *, std::vector< Double_t >::iterator begin, std::vector< Double_t >::iterator end)
	formula interpretation

void	PrintResults (const TString &, std::vector< Double_t > &, const Double_t) const
	display fit parameters check maximum length of variable name

void	ProcessOptions ()
	the option string is decoded, for available options see "DeclareOptions"

Private Attributes
std::vector< Double_t >	fBestPars
	the pars that optimise (minimise) the estimator

TString	fConverger
	fit method uses fConverger as intermediate step to converge into local minimas

IFitterTarget *	fConvergerFitter
	intermediate fitter

TString	fFitMethod
	estimator optimisation method

FitterBase *	fFitter
	the fitter used in the training

TFormula *	fFormula
	the discrimination function

TString	fFormulaStringP
	string with function

TString	fFormulaStringT
	string with function

UInt_t	fNPars
	number of parameters

Int_t	fOutputDimensions
	number of output values

std::vector< Interval * >	fParRange
	ranges of parameters

TString	fParRangeStringP
	string with ranges of parameters

TString	fParRangeStringT
	string with ranges of parameters

Double_t	fSumOfWeights
	sum of weights

Double_t	fSumOfWeightsBkg
	sum of weights (background)

Double_t	fSumOfWeightsSig
	sum of weights (signal)

Additional Inherited Members
Public Types inherited from TMVA::MethodBase
enum	EWeightFileType { kROOT =0 , kTEXT }

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

Public Attributes inherited from TMVA::MethodBase
Bool_t	fSetupCompleted

TrainingHistory	fTrainHistory

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Attributes inherited from TMVA::MethodBase
Types::EAnalysisType	fAnalysisType

UInt_t	fBackgroundClass

bool	fExitFromTraining = false

std::vector< TString > *	fInputVars

IPythonInteractive *	fInteractive = nullptr
	temporary dataset used when evaluating on a different data (used by MethodCategory::GetMvaValues)

UInt_t	fIPyCurrentIter = 0

UInt_t	fIPyMaxIter = 0

std::vector< Float_t > *	fMulticlassReturnVal

Int_t	fNbins

Int_t	fNbinsH

Int_t	fNbinsMVAoutput

Ranking *	fRanking

std::vector< Float_t > *	fRegressionReturnVal

Results *	fResults

UInt_t	fSignalClass

DataSet *	fTmpData = nullptr
	temporary event when testing on a different DataSet than the own one

const Event *	fTmpEvent

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

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TMVA/MethodFDA.h>

Inheritance diagram for TMVA::MethodFDA:

[legend]

Constructor & Destructor Documentation

◆ MethodFDA() [1/2]

TMVA::MethodFDA::MethodFDA	(	const TString &	jobName,
		const TString &	methodTitle,
		DataSetInfo &	theData,
		const TString &	theOption = `""`
	)

standard constructor

Definition at line 86 of file MethodFDA.cxx.

◆ MethodFDA() [2/2]

TMVA::MethodFDA::MethodFDA	(	DataSetInfo &	theData,
		const TString &	theWeightFile
	)

constructor from weight file

Definition at line 106 of file MethodFDA.cxx.

◆ ~MethodFDA()

TMVA::MethodFDA::~MethodFDA ( void )

virtual

destructor

Definition at line 326 of file MethodFDA.cxx.

Member Function Documentation

◆ AddWeightsXMLTo()

void TMVA::MethodFDA::AddWeightsXMLTo ( void * parent ) const

virtual

create XML description for LD classification and regression (for arbitrary number of output classes/targets)

Implements TMVA::MethodBase.

Definition at line 617 of file MethodFDA.cxx.

◆ CalculateMulticlassValues()

void TMVA::MethodFDA::CalculateMulticlassValues	(	const TMVA::Event *&	evt,
		std::vector< Double_t > &	parameters,
		std::vector< Float_t > &	values
	)

private

calculate the values for multiclass

Definition at line 581 of file MethodFDA.cxx.

◆ CheckSetup()

void TMVA::MethodFDA::CheckSetup ( )

inlinevirtual

check may be overridden by derived class (sometimes, eg, fitters are used which can only be implemented during training phase)

Reimplemented from TMVA::MethodBase.

Definition at line 101 of file MethodFDA.h.

◆ Class()

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

static

Returns: TClass describing this class

◆ Class_Name()

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

static

Returns: Name of this class

◆ Class_Version()

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

inlinestaticconstexpr

Returns: Version of this class

Definition at line 154 of file MethodFDA.h.

◆ ClearAll()

void TMVA::MethodFDA::ClearAll ( void )

private

delete and clear all class members

Definition at line 346 of file MethodFDA.cxx.

◆ CreateFormula()

void TMVA::MethodFDA::CreateFormula ( )

private

translate formula string into TFormula, and parameter string into par ranges

Definition at line 183 of file MethodFDA.cxx.

◆ CreateRanking()

const Ranking * TMVA::MethodFDA::CreateRanking ( )

inlinevirtual

Implements TMVA::MethodBase.

Definition at line 96 of file MethodFDA.h.

◆ DeclareOptions()

void TMVA::MethodFDA::DeclareOptions ( )

privatevirtual

define the options (their key words) that can be set in the option string

format of function string:

 "x0*(0)+((1)/x1)**(2)..."

where "[i]" are the parameters, and "xi" the input variables

format of parameter string:

 "(-1.2,3.4);(-2.3,4.55);..."

where the numbers in "(a,b)" correspond to the a=min, b=max parameter ranges; each parameter defined in the function string must have a corresponding range

Implements TMVA::MethodBase.

Definition at line 163 of file MethodFDA.cxx.

◆ DeclFileName()

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

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 154 of file MethodFDA.h.

◆ EstimatorFunction()

Double_t TMVA::MethodFDA::EstimatorFunction ( std::vector< Double_t > & pars )

virtual

compute estimator for given parameter set (to be minimised)

Implements TMVA::IFitterTarget.

Definition at line 435 of file MethodFDA.cxx.

◆ GetHelpMessage()

void TMVA::MethodFDA::GetHelpMessage ( ) const

protectedvirtual

get help message text

typical length of text line: "|--------------------------------------------------------------|"

Implements TMVA::IMethod.

Definition at line 719 of file MethodFDA.cxx.

◆ GetMulticlassValues()

const std::vector< Float_t > & TMVA::MethodFDA::GetMulticlassValues ( )

virtual

Reimplemented from TMVA::MethodBase.

Definition at line 553 of file MethodFDA.cxx.

◆ GetMvaValue()

Double_t TMVA::MethodFDA::GetMvaValue	(	Double_t *	err = `nullptr`,
		Double_t *	errUpper = `nullptr`
	)

virtual

returns MVA value for given event

Implements TMVA::MethodBase.

Definition at line 518 of file MethodFDA.cxx.

◆ GetRegressionValues()

const std::vector< Float_t > & TMVA::MethodFDA::GetRegressionValues ( )

virtual

Reimplemented from TMVA::MethodBase.

Definition at line 530 of file MethodFDA.cxx.

◆ HasAnalysisType()

Bool_t TMVA::MethodFDA::HasAnalysisType	(	Types::EAnalysisType	type,
		UInt_t	numberClasses,
		UInt_t	numberTargets
	)

virtual

FDA can handle classification with 2 classes and regression with one regression-target.

Implements TMVA::IMethod.

Definition at line 334 of file MethodFDA.cxx.

◆ Init()

void TMVA::MethodFDA::Init ( void )

virtual

default initialisation

Implements TMVA::MethodBase.

Definition at line 124 of file MethodFDA.cxx.

◆ InterpretFormula()

Double_t TMVA::MethodFDA::InterpretFormula	(	const Event *	event,
		std::vector< Double_t >::iterator	begin,
		std::vector< Double_t >::iterator	end
	)

private

formula interpretation

Definition at line 499 of file MethodFDA.cxx.

◆ IsA()

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

inlinevirtual

Returns: TClass describing current object

Reimplemented from TMVA::MethodBase.

Definition at line 154 of file MethodFDA.h.

◆ MakeClassSpecific()

void TMVA::MethodFDA::MakeClassSpecific	(	std::ostream &	fout,
		const TString &	className
	)		const

protectedvirtual

write FDA-specific classifier response

Reimplemented from TMVA::MethodBase.

Definition at line 674 of file MethodFDA.cxx.

◆ PrintResults()

void TMVA::MethodFDA::PrintResults	(	const TString &	fitter,
		std::vector< Double_t > &	pars,
		const Double_t	estimator
	)		const

private

display fit parameters check maximum length of variable name

Definition at line 421 of file MethodFDA.cxx.

◆ ProcessOptions()

void TMVA::MethodFDA::ProcessOptions ( )

privatevirtual

the option string is decoded, for available options see "DeclareOptions"

Implements TMVA::MethodBase.

Definition at line 240 of file MethodFDA.cxx.

◆ ReadWeightsFromStream() [1/3]

virtual void TMVA::MethodBase::ReadWeightsFromStream ( std::istream & )

virtual

Implements TMVA::MethodBase.

◆ ReadWeightsFromStream() [2/3]

void TMVA::MethodFDA::ReadWeightsFromStream ( std::istream & i )

virtual

read back the training results from a file (stream)

Implements TMVA::MethodBase.

Definition at line 602 of file MethodFDA.cxx.

◆ ReadWeightsFromStream() [3/3]

virtual void TMVA::MethodBase::ReadWeightsFromStream ( TFile & )

inlinevirtual

Reimplemented from TMVA::MethodBase.

Definition at line 266 of file MethodBase.h.

◆ ReadWeightsFromXML()

void TMVA::MethodFDA::ReadWeightsFromXML ( void * wghtnode )

virtual

read coefficients from xml weight file

Implements TMVA::MethodBase.

Definition at line 635 of file MethodFDA.cxx.

◆ Streamer()

virtual void TMVA::MethodFDA::Streamer ( TBuffer & )

virtual

Reimplemented from TMVA::MethodBase.

◆ StreamerNVirtual()

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

inline

Definition at line 154 of file MethodFDA.h.

◆ Train()

void TMVA::MethodFDA::Train ( void )

virtual

FDA training.

Implements TMVA::MethodBase.

Definition at line 363 of file MethodFDA.cxx.

Member Data Documentation

◆ fBestPars

std::vector<Double_t> TMVA::MethodFDA::fBestPars

private

the pars that optimise (minimise) the estimator

Definition at line 139 of file MethodFDA.h.

◆ fConverger

TString TMVA::MethodFDA::fConverger

private

fit method uses fConverger as intermediate step to converge into local minimas

Definition at line 141 of file MethodFDA.h.

◆ fConvergerFitter

IFitterTarget* TMVA::MethodFDA::fConvergerFitter

private

intermediate fitter

Definition at line 143 of file MethodFDA.h.

◆ fFitMethod

TString TMVA::MethodFDA::fFitMethod

private

estimator optimisation method

Definition at line 140 of file MethodFDA.h.

◆ fFitter

FitterBase* TMVA::MethodFDA::fFitter

private

the fitter used in the training

Definition at line 142 of file MethodFDA.h.

◆ fFormula

TFormula* TMVA::MethodFDA::fFormula

private

the discrimination function

Definition at line 136 of file MethodFDA.h.

◆ fFormulaStringP

TString TMVA::MethodFDA::fFormulaStringP

private

string with function

Definition at line 131 of file MethodFDA.h.

◆ fFormulaStringT

TString TMVA::MethodFDA::fFormulaStringT

private

string with function

Definition at line 133 of file MethodFDA.h.

◆ fNPars

UInt_t TMVA::MethodFDA::fNPars

private

number of parameters

Definition at line 137 of file MethodFDA.h.

◆ fOutputDimensions

Int_t TMVA::MethodFDA::fOutputDimensions

private

number of output values

Definition at line 152 of file MethodFDA.h.

◆ fParRange

std::vector<Interval*> TMVA::MethodFDA::fParRange

private

ranges of parameters

Definition at line 138 of file MethodFDA.h.

◆ fParRangeStringP

TString TMVA::MethodFDA::fParRangeStringP

private

string with ranges of parameters

Definition at line 132 of file MethodFDA.h.

◆ fParRangeStringT

TString TMVA::MethodFDA::fParRangeStringT

private

string with ranges of parameters

Definition at line 134 of file MethodFDA.h.

◆ fSumOfWeights

Double_t TMVA::MethodFDA::fSumOfWeights

private

sum of weights

Definition at line 149 of file MethodFDA.h.

◆ fSumOfWeightsBkg

Double_t TMVA::MethodFDA::fSumOfWeightsBkg

private

sum of weights (background)

Definition at line 148 of file MethodFDA.h.

◆ fSumOfWeightsSig

Double_t TMVA::MethodFDA::fSumOfWeightsSig

private

sum of weights (signal)

Definition at line 147 of file MethodFDA.h.

Libraries for TMVA::MethodFDA:

[legend]

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ MethodFDA() [1/2]

◆ MethodFDA() [2/2]

◆ ~MethodFDA()

Member Function Documentation

◆ AddWeightsXMLTo()

◆ CalculateMulticlassValues()

◆ CheckSetup()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ ClearAll()

◆ CreateFormula()

◆ CreateRanking()

◆ DeclareOptions()

◆ DeclFileName()

◆ EstimatorFunction()

◆ GetHelpMessage()

◆ GetMulticlassValues()

◆ GetMvaValue()

◆ GetRegressionValues()

◆ HasAnalysisType()

◆ Init()

◆ InterpretFormula()

◆ IsA()

◆ MakeClassSpecific()

◆ PrintResults()

◆ ProcessOptions()

◆ ReadWeightsFromStream() [1/3]

◆ ReadWeightsFromStream() [2/3]

◆ ReadWeightsFromStream() [3/3]

◆ ReadWeightsFromXML()

◆ Streamer()

◆ StreamerNVirtual()

◆ Train()

Member Data Documentation

◆ fBestPars

◆ fConverger

◆ fConvergerFitter

◆ fFitMethod

◆ fFitter

◆ fFormula

◆ fFormulaStringP

◆ fFormulaStringT

◆ fNPars

◆ fOutputDimensions

◆ fParRange

◆ fParRangeStringP

◆ fParRangeStringT

◆ fSumOfWeights

◆ fSumOfWeightsBkg

◆ fSumOfWeightsSig