This PDEFoam variant stores in every cell the average target fTarget (see the Constructor) as well as the statistical error on the target fTarget.

It therefore acts as a target estimator. It should be booked together with the PDEFoamTargetDensity density estimator, which returns the target fTarget density at a given phase space point during the foam build-up.

Definition at line 40 of file PDEFoamTarget.h.

Public Member Functions
	PDEFoamTarget ()
	Default constructor for streamer, user should not use it.

	PDEFoamTarget (const TString &, UInt_t)
	User constructor.

virtual	~PDEFoamTarget ()

virtual void	FillFoamCells (const Event *ev, Float_t wt)
	This function fills an event into the discriminant PDEFoam.

virtual void	Finalize ()
	Calculate average cell target in every cell and save them to the cell.

virtual Float_t	GetCellValue (const PDEFoamCell *cell, ECellValue cv)
	Returns the cell value of 'cell' corresponding to the given option 'cv'.

virtual std::vector< Float_t >	GetCellValue (const std::map< Int_t, Float_t > &xvec, ECellValue cv)
	This function finds all cells, which corresponds to the given (incomplete) untransformed event vector 'xvec' and returns the cell values, according to the parameter 'cv'.

virtual Float_t	GetCellValue (const std::vector< Float_t > &xvec, ECellValue cv, PDEFoamKernelBase *)
	This function finds the cell, which corresponds to the given untransformed event vector 'xvec' and return its value, which is given by the parameter 'cv'.

virtual Float_t	GetCellValue (const std::vector< Float_t > &xvec, ECellValue cv, PDEFoamKernelBase *)
	This function finds the cell, which corresponds to the given untransformed event vector 'xvec' and return its value, which is given by the parameter 'cv'.

Public Member Functions inherited from TMVA::PDEFoam
	PDEFoam ()
	Default constructor for streamer, user should not use it.

	PDEFoam (const TString &)
	User constructor, to be employed by the user.

virtual	~PDEFoam ()
	Default destructor.

void	AddVariableName (const char *s)

void	AddVariableName (TObjString *s)

void	CheckAll (Int_t)
	User utility, miscellaneous and debug.

void	Create ()
	Basic initialization of FOAM invoked by the user.

void	DeleteBinarySearchTree ()
	Delete the foam's density estimator, which contains the binary search tree.

TH1D *	Draw1Dim (ECellValue cell_value, Int_t nbin, PDEFoamKernelBase *kernel=NULL)
	Draws 1-dimensional foam (= histogram)

void	FillBinarySearchTree (const Event *ev)
	Insert event to internal foam's density estimator PDEFoamDensityBase.

TString	GetFoamName () const

UInt_t	GetMaxDepth () const

UInt_t	GetNActiveCells () const

UInt_t	GetNCells () const

UInt_t	GetNInActiveCells () const

UInt_t	GetNmin ()

PDEFoamCell *	GetRootCell () const

Int_t	GetTotDim () const

TObjString *	GetVariableName (Int_t idx)

Double_t	GetXmax (Int_t idim) const

Double_t	GetXmin (Int_t idim) const

void	Initialize ()

MsgLogger &	Log () const

void	PrintCell (Long_t iCell=0)
	Prints geometry of and elements of 'iCell', as well as relations to parent and daughter cells.

void	PrintCells ()
	Prints geometry of ALL cells of the FOAM.

virtual TH2D *	Project2 (Int_t idim1, Int_t idim2, ECellValue cell_value=kValue, PDEFoamKernelBase *kernel=NULL, UInt_t nbin=50)
	Project foam variable idim1 and variable idim2 to histogram.

void	ResetCellElements ()
	Remove the cell elements from all cells.

void	RootPlot2dim (const TString &filename, TString opt, Bool_t createCanvas=kTRUE, Bool_t colors=kTRUE)
	Debugging tool which plots the cells of a 2-dimensional PDEFoam as rectangles in C++ format readable for ROOT.

void	SetDensity (PDEFoamDensityBase *dens)

void	SetDim (Int_t kDim)
	Sets dimension of cubical space.

void	SetEvPerBin (Int_t EvPerBin)

void	SetInhiDiv (Int_t, Int_t)
	This can be called before Create, after setting kDim It defines which variables are excluded in the process of the cell division.

void	SetMaxDepth (UInt_t maxdepth)

void	SetnBin (Int_t nBin)

void	SetnCells (Long_t nCells)

void	SetNmin (UInt_t val)

void	SetnSampl (Long_t nSampl)

void	SetXmax (Int_t idim, Double_t wmax)
	set upper foam bound in dimension idim

void	SetXmin (Int_t idim, Double_t wmin)
	set lower foam bound in dimension idim

std::vector< Float_t >	VarTransform (const std::vector< Float_t > &invec) const

Float_t	VarTransform (Int_t idim, Float_t x) const

std::vector< Float_t >	VarTransformInvers (const std::vector< Float_t > &invec) const

Float_t	VarTransformInvers (Int_t idim, Float_t x) const

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	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

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 for instance with: `gROOT->SetSelectedPad(gPad)`.

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=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	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 const char *	GetName () const
	Returns 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 const char *	GetTitle () const
	Returns title of object.

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.

virtual ULong_t	Hash () const
	Return hash value for this object.

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)

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

virtual Bool_t	IsSortable () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

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.

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)
	Operator delete [].

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 void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

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.

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=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Protected Member Functions
	PDEFoamTarget (const PDEFoamTarget &)
	Copy Constructor NOT IMPLEMENTED (NEVER USED)

Bool_t	CellValueIsUndefined (PDEFoamCell *cell)
	Returns true, if the target error equals -1, as set in Finalize() in case of no events in the cell.

Float_t	GetAverageNeighborsValue (std::vector< Float_t > &, ECellValue)
	This function returns the average value 'cv' of only nearest neighbor cells.

Protected Member Functions inherited from TMVA::PDEFoam
	PDEFoam (const PDEFoam &)
	Copy Constructor NOT IMPLEMENTED (NEVER USED)

Int_t	CellFill (Int_t, PDEFoamCell *)
	Internal subprogram used by Create.

Int_t	Divide (PDEFoamCell *)
	Internal subprogram used by Create.

Double_t	Eval (Double_t *xRand, Double_t &event_density)
	Internal subprogram.

virtual void	Explore (PDEFoamCell *Cell)
	Internal subprogram used by Create.

PDEFoamCell *	FindCell (const std::vector< Float_t > &) const
	Find cell that contains 'xvec' (in foam coordinates [0,1]).

std::vector< TMVA::PDEFoamCell * >	FindCells (const std::map< Int_t, Float_t > &) const
	Find all cells, that contain the coordinates specified in txvec.

void	FindCells (const std::map< Int_t, Float_t > &, PDEFoamCell , std::vector< PDEFoamCell > &) const
	This is a helper function for std::vector<PDEFoamCell> FindCells(...) and a generalisation of PDEFoamCell FindCell().

std::vector< TMVA::PDEFoamCell * >	FindCells (const std::vector< Float_t > &) const
	Find all cells, that contain txvec.

Double_t	GetCellElement (const PDEFoamCell *cell, UInt_t i) const
	Returns cell element i of cell 'cell'.

PDEFoamDensityBase *	GetDistr () const

void	Grow ()
	Internal subprogram used by Create.

void	InitCells ()
	Internal subprogram used by Create.

void	MakeAlpha ()
	Internal subprogram used by Create.

void	OutputGrow (Bool_t finished=false)
	message logger

Long_t	PeekMax ()
	Internal subprogram used by Create.

void	SetCellElement (PDEFoamCell *cell, UInt_t i, Double_t value)
	Set cell element i of cell to value.

template<typename T >
T	Sqr (T x) const

void	Varedu (Double_t[], Int_t &, Double_t &, Double_t &)
	Internal subprogram used by Create.

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

Protected Attributes
UInt_t	fTarget

Protected Attributes inherited from TMVA::PDEFoam
Double_t *	fAlpha

PDEFoamCell **	fCells

Int_t	fDim

PDEFoamDensityBase *	fDistr

EDTSeparation	fDTSeparation

Int_t	fEvPerBin

Bool_t	fFillFoamWithOrigWeights

EFoamType	fFoamType

TObjArray *	fHistEdg

Int_t *	fInhiDiv
	[fDim] Dynamic Mask for cell division

Int_t	fLastCe

MsgLogger *	fLogger

Int_t *	fMaskDiv

UInt_t	fMaxDepth

TString	fName

Int_t	fNBin

Int_t	fNCells

UInt_t	fNElements

UInt_t	fNmin

Int_t	fNoAct
	[fDim] Flags for inhibiting cell division

Int_t	fNSampl

Bool_t	fPeekMax

TRandom3 *	fPseRan

Double_t *	fRvec

Timer *	fTimer
	distribution of training events

TObjArray *	fVariableNames
	timer for graphical output

Float_t	fVolFrac

Double_t *	fXmax

Double_t *	fXmin

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Static Public Member Functions inherited from TObject
static Long_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 Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

#include <TMVA/PDEFoamTarget.h>

Inheritance diagram for TMVA::PDEFoamTarget:

[legend]

Constructor & Destructor Documentation

◆ PDEFoamTarget() [1/3]

TMVA::PDEFoamTarget::PDEFoamTarget ( const PDEFoamTarget & from )

protected

Copy Constructor NOT IMPLEMENTED (NEVER USED)

Definition at line 81 of file PDEFoamTarget.cxx.

◆ PDEFoamTarget() [2/3]

TMVA::PDEFoamTarget::PDEFoamTarget ( )

Default constructor for streamer, user should not use it.

Definition at line 57 of file PDEFoamTarget.cxx.

◆ PDEFoamTarget() [3/3]

TMVA::PDEFoamTarget::PDEFoamTarget	(	const TString &	name,
		UInt_t	target
	)

User constructor.

Parameters:

name - name of PDEFoam object
target - target number to range-search for

Definition at line 72 of file PDEFoamTarget.cxx.

◆ ~PDEFoamTarget()

virtual TMVA::PDEFoamTarget::~PDEFoamTarget ( )

inlinevirtual

Definition at line 59 of file PDEFoamTarget.h.

Member Function Documentation

◆ CellValueIsUndefined()

Bool_t TMVA::PDEFoamTarget::CellValueIsUndefined ( PDEFoamCell * cell )

protectedvirtual

Returns true, if the target error equals -1, as set in Finalize() in case of no events in the cell.

Reimplemented from TMVA::PDEFoam.

Definition at line 136 of file PDEFoamTarget.cxx.

◆ FillFoamCells()

void TMVA::PDEFoamTarget::FillFoamCells	(	const Event *	ev,
		Float_t	wt
	)

virtual

This function fills an event into the discriminant PDEFoam.

The weight 'wt' is filled into cell element 0 if the event is of class 'fTarget', and filled into cell element 1 otherwise.

Reimplemented from TMVA::PDEFoam.

Definition at line 93 of file PDEFoamTarget.cxx.

◆ Finalize()

void TMVA::PDEFoamTarget::Finalize ( )

virtual

Calculate average cell target in every cell and save them to the cell.

Cell element 0 will contain the average target and cell element 1 will contain the error on the target.

Reimplemented from TMVA::PDEFoam.

Definition at line 112 of file PDEFoamTarget.cxx.

◆ GetAverageNeighborsValue()

Float_t TMVA::PDEFoamTarget::GetAverageNeighborsValue	(	std::vector< Float_t > &	txvec,
		ECellValue	cv
	)

protected

This function returns the average value 'cv' of only nearest neighbor cells.

It is used in cases, where empty cells shall not be evaluated.

Parameters:

txvec - event vector, transformed into foam coordinates [0, 1]
cv - cell value, see definition of ECellValue

Definition at line 175 of file PDEFoamTarget.cxx.

◆ GetCellValue() [1/4]

Float_t TMVA::PDEFoam::GetCellValue	(	const PDEFoamCell *	cell,
		ECellValue	cv
	)

virtual

Returns the cell value of 'cell' corresponding to the given option 'cv'.

This function should be overridden by the subclass in order to specify which cell elements to return for a given cell value 'cv'. By default kValue returns cell element 0, and kValueError returns cell element 1.

Reimplemented from TMVA::PDEFoam.

Definition at line 264 of file PDEFoam.cxx.

◆ GetCellValue() [2/4]

std::vector< Float_t > TMVA::PDEFoam::GetCellValue	(	const std::map< Int_t, Float_t > &	xvec,
		ECellValue	cv
	)

virtual

This function finds all cells, which corresponds to the given (incomplete) untransformed event vector 'xvec' and returns the cell values, according to the parameter 'cv'.

Parameters:

xvec - map for the untransformed vector. The key (Int_t) is the dimension, and the value (Float_t) is the event coordinate. Note that not all coordinates have to be specified.
cv - cell values to return

Return:

cell values from all cells that were found

Reimplemented from TMVA::PDEFoam.

Definition at line 261 of file PDEFoam.cxx.

◆ GetCellValue() [3/4]

Float_t TMVA::PDEFoamTarget::GetCellValue	(	const std::vector< Float_t > &	xvec,
		ECellValue	cv,
		PDEFoamKernelBase *	kernel
	)

virtual

This function finds the cell, which corresponds to the given untransformed event vector 'xvec' and return its value, which is given by the parameter 'cv'.

If cv == kValue, it is checked wether the cell value is undefined. If this is the case, then the mean of the neighbor's target values is returned, using GetAverageNeighborsValue().

Reimplemented from TMVA::PDEFoam.

Definition at line 150 of file PDEFoamTarget.cxx.

◆ GetCellValue() [4/4]

Float_t TMVA::PDEFoam::GetCellValue	(	const std::vector< Float_t > &	xvec,
		ECellValue	cv,
		PDEFoamKernelBase *	kernel
	)

virtual

This function finds the cell, which corresponds to the given untransformed event vector 'xvec' and return its value, which is given by the parameter 'cv'.

If kernel != NULL, then PDEFoamKernelBase::Estimate() is called on the transformed event variables.

Parameters:

xvec - event vector (untransformed, [fXmin,fXmax])
cv - the cell value to return
kernel - PDEFoam kernel estimator. If NULL is given, than the pure cell value is returned

Return:

The cell value, corresponding to 'xvec', estimated by the given kernel.

Reimplemented from TMVA::PDEFoam.

Definition at line 258 of file PDEFoam.cxx.

Member Data Documentation

◆ fTarget

UInt_t TMVA::PDEFoamTarget::fTarget

protected

Definition at line 44 of file PDEFoamTarget.h.

Libraries for TMVA::PDEFoamTarget:

[legend]

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ PDEFoamTarget() [1/3]

◆ PDEFoamTarget() [2/3]

◆ PDEFoamTarget() [3/3]

◆ ~PDEFoamTarget()

Member Function Documentation

◆ CellValueIsUndefined()

◆ FillFoamCells()

◆ Finalize()

◆ GetAverageNeighborsValue()

◆ GetCellValue() [1/4]

◆ GetCellValue() [2/4]

◆ GetCellValue() [3/4]

◆ GetCellValue() [4/4]

Member Data Documentation

◆ fTarget