Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TMVA::PDEFoam Class Reference

Implementation of PDEFoam.

The PDEFoam method is an extension of the PDERS method, which uses self-adapting binning to divide the multi-dimensional phase space in a finite number of hyper-rectangles (boxes).

For a given number of boxes, the binning algorithm adjusts the size and position of the boxes inside the multidimensional phase space, minimizing the variance of the signal and background densities inside the boxes. The binned density information is stored in binary trees, allowing for a very fast and memory-efficient classification of events.

The implementation of the PDEFoam is based on the monte-carlo integration package TFoam included in the analysis package ROOT.

The class TMVA::PDEFoam defines the default interface for the PDEFoam variants:

Per default PDEFoam stores in the cells the number of events (event weights) and therefore acts as an event density estimator. However, the above listed derived classes override this behaviour to implement certain PDEFoam variations.

In order to use PDEFoam the user has to set the density estimator of the type TMVA::PDEFoamDensityBase, which is used to during the foam build-up. The default PDEFoam should be used with PDEFoamEventDensity.

Definition at line 79 of file PDEFoam.h.

Public Member Functions

 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.
 
TH1DDraw1Dim (ECellValue cell_value, Int_t nbin, PDEFoamKernelBase *kernel=nullptr)
 Draws 1-dimensional foam (= histogram)
 
void FillBinarySearchTree (const Event *ev)
 Insert event to internal foam's density estimator PDEFoamDensityBase.
 
virtual void FillFoamCells (const Event *ev, Float_t wt)
 This function fills a weight 'wt' into the PDEFoam cell, which corresponds to the given event 'ev'.
 
virtual void Finalize ()
 
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_tGetCellValue (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'.
 
TString GetFoamName () const
 
UInt_t GetMaxDepth () const
 
UInt_t GetNActiveCells () const
 
UInt_t GetNCells () const
 
UInt_t GetNInActiveCells () const
 
UInt_t GetNmin ()
 
PDEFoamCellGetRootCell () const
 
Int_t GetTotDim () const
 
TObjStringGetVariableName (Int_t idx)
 
Double_t GetXmax (Int_t idim) const
 
Double_t GetXmin (Int_t idim) const
 
void Initialize ()
 
virtual TClassIsA () const
 
MsgLoggerLog () 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 TH2DProject2 (Int_t idim1, Int_t idim2, ECellValue cell_value=kValue, PDEFoamKernelBase *kernel=nullptr, 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
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
std::vector< Float_tVarTransform (const std::vector< Float_t > &invec) const
 
Float_t VarTransform (Int_t idim, Float_t x) const
 
std::vector< Float_tVarTransformInvers (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 TObjectClone (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 TObjectDrawClone (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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () 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_tGetOption () 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)
 
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
 
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)
 
TObjectoperator= (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.
 
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 TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
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

 PDEFoam (const PDEFoam &)
 Copy Constructor NOT IMPLEMENTED (NEVER USED)
 
Int_t CellFill (Int_t, PDEFoamCell *)
 Internal subprogram used by Create.
 
virtual Bool_t CellValueIsUndefined (PDEFoamCell *)
 Returns true, if the value of the given cell is undefined.
 
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.
 
PDEFoamCellFindCell (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'.
 
PDEFoamDensityBaseGetDistr () 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)
 Overridden function of PDEFoam to avoid native foam output.
 
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 >
Sqr (T x) const
 
void Varedu (Double_t[5], 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

Double_tfAlpha
 [fDim] Internal parameters of the hyperrectangle
 
PDEFoamCell ** fCells
 [fNCells] Array of ALL cells
 
Int_t fDim
 Dimension of the integration/simulation space.
 
PDEFoamDensityBasefDistr
 ! distribution of training events
 
EDTSeparation fDTSeparation
 BACKWARDS COMPATIBILITY: split cells according to decision tree logic.
 
Int_t fEvPerBin
 Maximum number of effective (wt=1) events per bin.
 
Bool_t fFillFoamWithOrigWeights
 BACKWARDS COMPATIBILITY: fill the foam with boost or orig. weights.
 
EFoamType fFoamType
 BACKWARDS COMPATIBILITY: type of foam.
 
TObjArrayfHistEdg
 Histograms of wt, one for each cell edge.
 
Int_tfInhiDiv
 ! [fDim] Flags for inhibiting cell division
 
Int_t fLastCe
 Index of the last cell.
 
MsgLoggerfLogger
 ! message logger
 
Int_tfMaskDiv
 ! [fDim] Dynamic Mask for cell division
 
UInt_t fMaxDepth
 maximum depth of cell tree
 
TString fName
 Name of a given instance of the FOAM class.
 
Int_t fNBin
 No. of bins in the edge histogram for cell MC exploration.
 
Int_t fNCells
 Maximum number of cells.
 
UInt_t fNElements
 BACKWARDS COMPATIBILITY: number of variables in every cell.
 
UInt_t fNmin
 minimal number of events in cell to split cell
 
Int_t fNoAct
 Number of active cells.
 
Int_t fNSampl
 No. of MC events, when dividing (exploring) cell.
 
Bool_t fPeekMax
 BACKWARDS COMPATIBILITY: peek up cell with max. driver integral for split.
 
TRandom3fPseRan
 Pointer to user-defined generator of pseudorandom numbers.
 
Double_tfRvec
 [fDim] random number vector from r.n. generator fDim+1 maximum elements
 
TimerfTimer
 ! timer for graphical output
 
TObjArrayfVariableNames
 collection of all variable names
 
Float_t fVolFrac
 BACKWARDS COMPATIBILITY: volume fraction (with respect to total phase space.
 
Double_tfXmax
 [fDim] maximum for variable transform
 
Double_tfXmin
 [fDim] minimum for variable transform
 

Friends

class PDEFoamKernelBase
 
class PDEFoamKernelGauss
 
class PDEFoamKernelLinN
 
class PDEFoamKernelTrivial
 

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

#include <TMVA/PDEFoam.h>

Inheritance diagram for TMVA::PDEFoam:
[legend]

Constructor & Destructor Documentation

◆ PDEFoam() [1/3]

TMVA::PDEFoam::PDEFoam ( const PDEFoam from)
protected

Copy Constructor NOT IMPLEMENTED (NEVER USED)

Definition at line 209 of file PDEFoam.cxx.

◆ PDEFoam() [2/3]

TMVA::PDEFoam::PDEFoam ( )

Default constructor for streamer, user should not use it.

Definition at line 103 of file PDEFoam.cxx.

◆ PDEFoam() [3/3]

TMVA::PDEFoam::PDEFoam ( const TString name)

User constructor, to be employed by the user.

Definition at line 142 of file PDEFoam.cxx.

◆ ~PDEFoam()

TMVA::PDEFoam::~PDEFoam ( )
virtual

Default destructor.

Definition at line 184 of file PDEFoam.cxx.

Member Function Documentation

◆ AddVariableName() [1/2]

void TMVA::PDEFoam::AddVariableName ( const char *  s)
inline

Definition at line 217 of file PDEFoam.h.

◆ AddVariableName() [2/2]

void TMVA::PDEFoam::AddVariableName ( TObjString s)
inline

Definition at line 218 of file PDEFoam.h.

◆ CellFill()

Int_t TMVA::PDEFoam::CellFill ( Int_t  status,
PDEFoamCell parent 
)
protected

Internal subprogram used by Create.

It initializes content of the newly allocated active cell.

Definition at line 389 of file PDEFoam.cxx.

◆ CellValueIsUndefined()

Bool_t TMVA::PDEFoam::CellValueIsUndefined ( PDEFoamCell )
protectedvirtual

Returns true, if the value of the given cell is undefined.

Default value: kFALSE. This function can be overridden by sub-classes.

Reimplemented in TMVA::PDEFoamTarget.

Definition at line 991 of file PDEFoam.cxx.

◆ CheckAll()

void TMVA::PDEFoam::CheckAll ( Int_t  level)

User utility, miscellaneous and debug.

Checks all pointers in the tree of cells. This is useful auto-diagnostic. level=0, no printout, failures causes STOP level=1, printout, failures lead to WARNINGS only

Definition at line 823 of file PDEFoam.cxx.

◆ Class()

static TClass * TMVA::PDEFoam::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TMVA::PDEFoam::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::PDEFoam::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 273 of file PDEFoam.h.

◆ Create()

void TMVA::PDEFoam::Create ( )

Basic initialization of FOAM invoked by the user.

IMPORTANT: Random number generator and the distribution object has to be provided using SetPseRan and SetRho prior to invoking this initializator!

After the foam is grown, space for 2 variables is reserved in every cell. They are used for filling the foam cells.

Definition at line 292 of file PDEFoam.cxx.

◆ DeclFileName()

static const char * TMVA::PDEFoam::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 273 of file PDEFoam.h.

◆ DeleteBinarySearchTree()

void TMVA::PDEFoam::DeleteBinarySearchTree ( )

Delete the foam's density estimator, which contains the binary search tree.

Definition at line 1667 of file PDEFoam.cxx.

◆ Divide()

Int_t TMVA::PDEFoam::Divide ( PDEFoamCell cell)
protected

Internal subprogram used by Create.

It divides cell iCell into two daughter cells. The iCell is retained and tagged as inactive, daughter cells are appended at the end of the buffer. New vertex is added to list of vertices. List of active cells is updated, iCell removed, two daughters added and their properties set with help of MC sampling (PDEFoam_Explore) Returns Code RC=-1 of buffer limit is reached, fLastCe=fnBuf.

Definition at line 715 of file PDEFoam.cxx.

◆ Draw1Dim()

TH1D * TMVA::PDEFoam::Draw1Dim ( ECellValue  cell_value,
Int_t  nbin,
PDEFoamKernelBase kernel = nullptr 
)

Draws 1-dimensional foam (= histogram)

Parameters:

  • cell_value - the cell value to draw
  • nbin - number of bins of result histogram
  • kernel - a PDEFoam kernel.

Definition at line 1219 of file PDEFoam.cxx.

◆ Eval()

Double_t TMVA::PDEFoam::Eval ( Double_t xRand,
Double_t event_density 
)
protected

Internal subprogram.

Evaluates (training) distribution.

Definition at line 748 of file PDEFoam.cxx.

◆ Explore()

void TMVA::PDEFoam::Explore ( PDEFoamCell cell)
protectedvirtual

Internal subprogram used by Create.

It explores newly defined cell with help of special short MC sampling. As a result, estimates of kTRUE and drive volume is defined/determined Average and dispersion of the weight distribution will is found along each edge and the best edge (minimum dispersion, best maximum weight) is memorized for future use. The optimal division point for eventual future cell division is determined/recorded. Recorded are also minimum and maximum weight etc. The volume estimate in all (inactive) parent cells is updated. Note that links to parents and initial volume = 1/2 parent has to be already defined prior to calling this routine.

If fNmin > 0 then the total number of (training) events found in the cell during the exploration is stored in the cell. This information is used within PeekMax() to avoid splitting cells which contain less than fNmin events.

Reimplemented in TMVA::PDEFoamDecisionTree.

Definition at line 434 of file PDEFoam.cxx.

◆ FillBinarySearchTree()

void TMVA::PDEFoam::FillBinarySearchTree ( const Event ev)

Insert event to internal foam's density estimator PDEFoamDensityBase.

Definition at line 1658 of file PDEFoam.cxx.

◆ FillFoamCells()

void TMVA::PDEFoam::FillFoamCells ( const Event ev,
Float_t  wt 
)
virtual

This function fills a weight 'wt' into the PDEFoam cell, which corresponds to the given event 'ev'.

Per default cell element 0 is filled with the weight 'wt', and cell element 1 is filled with the squared weight. This function can be overridden by a subclass in order to change the values stored in the foam cells.

Reimplemented in TMVA::PDEFoamDiscriminant, TMVA::PDEFoamEvent, and TMVA::PDEFoamTarget.

Definition at line 956 of file PDEFoam.cxx.

◆ Finalize()

virtual void TMVA::PDEFoam::Finalize ( )
inlinevirtual

Reimplemented in TMVA::PDEFoamDiscriminant, and TMVA::PDEFoamTarget.

Definition at line 184 of file PDEFoam.h.

◆ FindCell()

TMVA::PDEFoamCell * TMVA::PDEFoam::FindCell ( const std::vector< Float_t > &  xvec) const
protected

Find cell that contains 'xvec' (in foam coordinates [0,1]).

Loop to find cell that contains 'xvec' starting at root cell, and traversing binary tree to find the cell quickly. Note, that if 'xvec' lies outside the foam, the cell which is nearest to 'xvec' is returned. (The returned pointer should never be NULL.)

Parameters:

  • xvec - event vector (in foam coordinates [0,1])

Return:

PDEFoam cell corresponding to 'xvec'

Definition at line 1081 of file PDEFoam.cxx.

◆ FindCells() [1/3]

std::vector< TMVA::PDEFoamCell * > TMVA::PDEFoam::FindCells ( const std::map< Int_t, Float_t > &  txvec) const
protected

Find all cells, that contain the coordinates specified in txvec.

The key in 'txvec' is the dimension, and the corresponding value is the coordinate. Note, that not all coordinates have to be specified in txvec.

Parameters:

  • txvec - map of coordinates (transformed into foam coordinates [0,1])

Return value:

  • vector of cells, that fit txvec

Definition at line 1197 of file PDEFoam.cxx.

◆ FindCells() [2/3]

void TMVA::PDEFoam::FindCells ( const std::map< Int_t, Float_t > &  txvec,
PDEFoamCell cell,
std::vector< PDEFoamCell * > &  cells 
) const
protected

This is a helper function for std::vector<PDEFoamCell*> FindCells(...) and a generalisation of PDEFoamCell* FindCell().

It saves in 'cells' all cells, which contain the coordinates specifies in 'txvec'. Note, that not all coordinates have to be specified in 'txvec'.

Parameters:

  • txvec - event vector in foam coordinates [0,1]. The key is the dimension and the value is the event coordinate. Note, that not all coordinates have to be specified.
  • cell - cell to start searching with (usually root cell fCells[0])
  • cells - list of cells that were found

Definition at line 1119 of file PDEFoam.cxx.

◆ FindCells() [3/3]

std::vector< TMVA::PDEFoamCell * > TMVA::PDEFoam::FindCells ( const std::vector< Float_t > &  txvec) const
protected

Find all cells, that contain txvec.

This function can be used, when the dimension of the foam is greater than the dimension of txvec. E.g. this is the case for multi-target regression.

Parameters:

  • txvec - event vector of variables, transformed into foam coordinates [0,1]. The size of txvec can be smaller than the dimension of the foam.

Return value:

  • vector of cells, that fit txvec

Definition at line 1166 of file PDEFoam.cxx.

◆ GetCellElement()

Double_t TMVA::PDEFoam::GetCellElement ( const PDEFoamCell cell,
UInt_t  i 
) const
protected

Returns cell element i of cell 'cell'.

If the cell has no elements or the index 'i' is out of range, than 0 is returned.

Definition at line 1417 of file PDEFoam.cxx.

◆ GetCellValue() [1/3]

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 in TMVA::PDEFoamMultiTarget, and TMVA::PDEFoamTarget.

Definition at line 1357 of file PDEFoam.cxx.

◆ GetCellValue() [2/3]

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 in TMVA::PDEFoamMultiTarget, TMVA::PDEFoamMultiTarget, and TMVA::PDEFoamTarget.

Definition at line 1044 of file PDEFoam.cxx.

◆ GetCellValue() [3/3]

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 in TMVA::PDEFoamMultiTarget, TMVA::PDEFoamTarget, and TMVA::PDEFoamTarget.

Definition at line 1017 of file PDEFoam.cxx.

◆ GetDistr()

PDEFoamDensityBase * TMVA::PDEFoam::GetDistr ( ) const
inlineprotected

Definition at line 158 of file PDEFoam.h.

◆ GetFoamName()

TString TMVA::PDEFoam::GetFoamName ( ) const
inline

Definition at line 198 of file PDEFoam.h.

◆ GetMaxDepth()

UInt_t TMVA::PDEFoam::GetMaxDepth ( ) const
inline

Definition at line 208 of file PDEFoam.h.

◆ GetNActiveCells()

UInt_t TMVA::PDEFoam::GetNActiveCells ( ) const
inline

Definition at line 199 of file PDEFoam.h.

◆ GetNCells()

UInt_t TMVA::PDEFoam::GetNCells ( ) const
inline

Definition at line 201 of file PDEFoam.h.

◆ GetNInActiveCells()

UInt_t TMVA::PDEFoam::GetNInActiveCells ( ) const
inline

Definition at line 200 of file PDEFoam.h.

◆ GetNmin()

UInt_t TMVA::PDEFoam::GetNmin ( )
inline

Definition at line 206 of file PDEFoam.h.

◆ GetRootCell()

PDEFoamCell * TMVA::PDEFoam::GetRootCell ( ) const
inline

Definition at line 202 of file PDEFoam.h.

◆ GetTotDim()

Int_t TMVA::PDEFoam::GetTotDim ( ) const
inline

Definition at line 197 of file PDEFoam.h.

◆ GetVariableName()

TObjString * TMVA::PDEFoam::GetVariableName ( Int_t  idx)
inline

Definition at line 219 of file PDEFoam.h.

◆ GetXmax()

Double_t TMVA::PDEFoam::GetXmax ( Int_t  idim) const
inline

Definition at line 214 of file PDEFoam.h.

◆ GetXmin()

Double_t TMVA::PDEFoam::GetXmin ( Int_t  idim) const
inline

Definition at line 213 of file PDEFoam.h.

◆ Grow()

void TMVA::PDEFoam::Grow ( )
protected

Internal subprogram used by Create.

It grow new cells by the binary division process. This function is overridden by the PDEFoam class to stop the foam buildup process if one of the cut conditions stop the cell split.

Definition at line 768 of file PDEFoam.cxx.

◆ InitCells()

void TMVA::PDEFoam::InitCells ( )
protected

Internal subprogram used by Create.

It initializes "root part" of the FOAM of the tree of cells.

Definition at line 356 of file PDEFoam.cxx.

◆ Initialize()

void TMVA::PDEFoam::Initialize ( )
inline

Definition at line 173 of file PDEFoam.h.

◆ IsA()

virtual TClass * TMVA::PDEFoam::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Reimplemented in TMVA::PDEFoamDecisionTree, TMVA::PDEFoamDiscriminant, TMVA::PDEFoamEvent, TMVA::PDEFoamMultiTarget, and TMVA::PDEFoamTarget.

Definition at line 273 of file PDEFoam.h.

◆ Log()

MsgLogger & TMVA::PDEFoam::Log ( ) const
inline

Definition at line 240 of file PDEFoam.h.

◆ MakeAlpha()

void TMVA::PDEFoam::MakeAlpha ( )
protected

Internal subprogram used by Create.

Provides random vector Alpha 0< Alpha(i) < 1

Definition at line 638 of file PDEFoam.cxx.

◆ OutputGrow()

void TMVA::PDEFoam::OutputGrow ( Bool_t  finished = false)
protected

Overridden function of PDEFoam to avoid native foam output.

Draw TMVA-process bar instead.

Definition at line 1461 of file PDEFoam.cxx.

◆ PeekMax()

Long_t TMVA::PDEFoam::PeekMax ( )
protected

Internal subprogram used by Create.

It finds cell with maximal driver integral for the purpose of the division. This function is overridden by the PDEFoam Class to apply cuts on the number of events in the cell (fNmin) and the cell tree depth (GetMaxDepth() > 0) during cell buildup.

Definition at line 652 of file PDEFoam.cxx.

◆ PrintCell()

void TMVA::PDEFoam::PrintCell ( Long_t  iCell = 0)

Prints geometry of and elements of 'iCell', as well as relations to parent and daughter cells.

Definition at line 896 of file PDEFoam.cxx.

◆ PrintCells()

void TMVA::PDEFoam::PrintCells ( void  )

Prints geometry of ALL cells of the FOAM.

Definition at line 943 of file PDEFoam.cxx.

◆ Project2()

TH2D * TMVA::PDEFoam::Project2 ( Int_t  idim1,
Int_t  idim2,
ECellValue  cell_value = kValue,
PDEFoamKernelBase kernel = nullptr,
UInt_t  nbin = 50 
)
virtual

Project foam variable idim1 and variable idim2 to histogram.

Parameters:

  • idim1, idim2 - dimensions to project to
  • cell_value - the cell value to draw
  • kernel - a PDEFoam kernel (optional). If NULL is given, the kernel is ignored and the pure cell values are plotted.
  • nbin - number of bins in x and y direction of result histogram (optional, default is 50).

Returns: a 2-dimensional histogram

Reimplemented in TMVA::PDEFoamDiscriminant.

Definition at line 1271 of file PDEFoam.cxx.

◆ ResetCellElements()

void TMVA::PDEFoam::ResetCellElements ( )

Remove the cell elements from all cells.

Definition at line 972 of file PDEFoam.cxx.

◆ RootPlot2dim()

void TMVA::PDEFoam::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.

Parameters:

  • filename - filename of output root macro
  • opt - cell_value, rms, rms_ov_mean If cell_value is set, the following values will be filled into the result histogram:
    • number of events - in case of classification with 2 separate foams or multi-target regression
    • discriminator - in case of classification with one unified foam
    • target - in case of mono-target regression If none of {cell_value, rms, rms_ov_mean} is given, the cells will not be filled. If 'opt' contains the string 'cellnumber', the index of each cell is draw in addition.
  • createCanvas - whether to create a new canvas or not
  • colors - whether to fill cells with colors or shades of grey

Example:

The following commands load a mono-target regression foam from file 'foam.root' and create a ROOT macro 'output.C', which draws all PDEFoam cells with little boxes. The latter are filled with colors according to the target value stored in the cell. Also the cell number is drawn.

TFile file("foam.root"); TMVA::PDEFoam foam = (TMVA::PDEFoam) gDirectory->Get("MonoTargetRegressionFoam"); foam->RootPlot2dim("output.C","cell_value,cellnumber"); gROOT->Macro("output.C");

Definition at line 1512 of file PDEFoam.cxx.

◆ SetCellElement()

void TMVA::PDEFoam::SetCellElement ( PDEFoamCell cell,
UInt_t  i,
Double_t  value 
)
protected

Set cell element i of cell to value.

If the cell element i does not exist, it is created.

Definition at line 1433 of file PDEFoam.cxx.

◆ SetDensity()

void TMVA::PDEFoam::SetDensity ( PDEFoamDensityBase dens)
inline

Definition at line 194 of file PDEFoam.h.

◆ SetDim()

void TMVA::PDEFoam::SetDim ( Int_t  kDim)

Sets dimension of cubical space.

Definition at line 250 of file PDEFoam.cxx.

◆ SetEvPerBin()

void TMVA::PDEFoam::SetEvPerBin ( Int_t  EvPerBin)
inline

Definition at line 192 of file PDEFoam.h.

◆ SetInhiDiv()

void TMVA::PDEFoam::SetInhiDiv ( Int_t  iDim,
Int_t  inhiDiv 
)

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

For example 'FoamX->SetInhiDiv(1, 1);' inhibits division of y-variable.

Definition at line 803 of file PDEFoam.cxx.

◆ SetMaxDepth()

void TMVA::PDEFoam::SetMaxDepth ( UInt_t  maxdepth)
inline

Definition at line 207 of file PDEFoam.h.

◆ SetnBin()

void TMVA::PDEFoam::SetnBin ( Int_t  nBin)
inline

Definition at line 191 of file PDEFoam.h.

◆ SetnCells()

void TMVA::PDEFoam::SetnCells ( Long_t  nCells)
inline

Definition at line 189 of file PDEFoam.h.

◆ SetNmin()

void TMVA::PDEFoam::SetNmin ( UInt_t  val)
inline

Definition at line 205 of file PDEFoam.h.

◆ SetnSampl()

void TMVA::PDEFoam::SetnSampl ( Long_t  nSampl)
inline

Definition at line 190 of file PDEFoam.h.

◆ SetXmax()

void TMVA::PDEFoam::SetXmax ( Int_t  idim,
Double_t  wmax 
)

set upper foam bound in dimension idim

Definition at line 276 of file PDEFoam.cxx.

◆ SetXmin()

void TMVA::PDEFoam::SetXmin ( Int_t  idim,
Double_t  wmin 
)

set lower foam bound in dimension idim

Definition at line 265 of file PDEFoam.cxx.

◆ Sqr()

template<typename T >
T TMVA::PDEFoam::Sqr ( x) const
inlineprotected

Definition at line 161 of file PDEFoam.h.

◆ Streamer()

virtual void TMVA::PDEFoam::Streamer ( TBuffer R__b)
virtual

◆ StreamerNVirtual()

void TMVA::PDEFoam::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 273 of file PDEFoam.h.

◆ Varedu()

void TMVA::PDEFoam::Varedu ( Double_t  ceSum[5],
Int_t kBest,
Double_t xBest,
Double_t yBest 
)
protected

Internal subprogram used by Create.

In determines the best edge candidate and the position of the cell division plane in case of the variance reduction for future cell division, using results of the MC exploration run stored in fHistEdg

Definition at line 570 of file PDEFoam.cxx.

◆ VarTransform() [1/2]

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

Definition at line 288 of file PDEFoam.h.

◆ VarTransform() [2/2]

Float_t TMVA::PDEFoam::VarTransform ( Int_t  idim,
Float_t  x 
) const
inline

Definition at line 281 of file PDEFoam.h.

◆ VarTransformInvers() [1/2]

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

Definition at line 305 of file PDEFoam.h.

◆ VarTransformInvers() [2/2]

Float_t TMVA::PDEFoam::VarTransformInvers ( Int_t  idim,
Float_t  x 
) const
inline

Definition at line 298 of file PDEFoam.h.

Friends And Related Symbol Documentation

◆ PDEFoamKernelBase

friend class PDEFoamKernelBase
friend

Definition at line 267 of file PDEFoam.h.

◆ PDEFoamKernelGauss

friend class PDEFoamKernelGauss
friend

Definition at line 270 of file PDEFoam.h.

◆ PDEFoamKernelLinN

friend class PDEFoamKernelLinN
friend

Definition at line 269 of file PDEFoam.h.

◆ PDEFoamKernelTrivial

friend class PDEFoamKernelTrivial
friend

Definition at line 268 of file PDEFoam.h.

Member Data Documentation

◆ fAlpha

Double_t* TMVA::PDEFoam::fAlpha
protected

[fDim] Internal parameters of the hyperrectangle

Definition at line 103 of file PDEFoam.h.

◆ fCells

PDEFoamCell** TMVA::PDEFoam::fCells
protected

[fNCells] Array of ALL cells

Definition at line 96 of file PDEFoam.h.

◆ fDim

Int_t TMVA::PDEFoam::fDim
protected

Dimension of the integration/simulation space.

Definition at line 84 of file PDEFoam.h.

◆ fDistr

PDEFoamDensityBase* TMVA::PDEFoam::fDistr
protected

! distribution of training events

Definition at line 115 of file PDEFoam.h.

◆ fDTSeparation

EDTSeparation TMVA::PDEFoam::fDTSeparation
protected

BACKWARDS COMPATIBILITY: split cells according to decision tree logic.

Definition at line 113 of file PDEFoam.h.

◆ fEvPerBin

Int_t TMVA::PDEFoam::fEvPerBin
protected

Maximum number of effective (wt=1) events per bin.

Definition at line 89 of file PDEFoam.h.

◆ fFillFoamWithOrigWeights

Bool_t TMVA::PDEFoam::fFillFoamWithOrigWeights
protected

BACKWARDS COMPATIBILITY: fill the foam with boost or orig. weights.

Definition at line 112 of file PDEFoam.h.

◆ fFoamType

EFoamType TMVA::PDEFoam::fFoamType
protected

BACKWARDS COMPATIBILITY: type of foam.

Definition at line 105 of file PDEFoam.h.

◆ fHistEdg

TObjArray* TMVA::PDEFoam::fHistEdg
protected

Histograms of wt, one for each cell edge.

Definition at line 98 of file PDEFoam.h.

◆ fInhiDiv

Int_t* TMVA::PDEFoam::fInhiDiv
protected

! [fDim] Flags for inhibiting cell division

Definition at line 92 of file PDEFoam.h.

◆ fLastCe

Int_t TMVA::PDEFoam::fLastCe
protected

Index of the last cell.

Definition at line 95 of file PDEFoam.h.

◆ fLogger

MsgLogger* TMVA::PDEFoam::fLogger
mutableprotected

! message logger

Definition at line 118 of file PDEFoam.h.

◆ fMaskDiv

Int_t* TMVA::PDEFoam::fMaskDiv
protected

! [fDim] Dynamic Mask for cell division

Definition at line 91 of file PDEFoam.h.

◆ fMaxDepth

UInt_t TMVA::PDEFoam::fMaxDepth
protected

maximum depth of cell tree

Definition at line 110 of file PDEFoam.h.

◆ fName

TString TMVA::PDEFoam::fName
protected

Name of a given instance of the FOAM class.

Definition at line 83 of file PDEFoam.h.

◆ fNBin

Int_t TMVA::PDEFoam::fNBin
protected

No. of bins in the edge histogram for cell MC exploration.

Definition at line 87 of file PDEFoam.h.

◆ fNCells

Int_t TMVA::PDEFoam::fNCells
protected

Maximum number of cells.

Definition at line 85 of file PDEFoam.h.

◆ fNElements

UInt_t TMVA::PDEFoam::fNElements
protected

BACKWARDS COMPATIBILITY: number of variables in every cell.

Definition at line 108 of file PDEFoam.h.

◆ fNmin

UInt_t TMVA::PDEFoam::fNmin
protected

minimal number of events in cell to split cell

Definition at line 109 of file PDEFoam.h.

◆ fNoAct

Int_t TMVA::PDEFoam::fNoAct
protected

Number of active cells.

Definition at line 94 of file PDEFoam.h.

◆ fNSampl

Int_t TMVA::PDEFoam::fNSampl
protected

No. of MC events, when dividing (exploring) cell.

Definition at line 88 of file PDEFoam.h.

◆ fPeekMax

Bool_t TMVA::PDEFoam::fPeekMax
protected

BACKWARDS COMPATIBILITY: peek up cell with max. driver integral for split.

Definition at line 114 of file PDEFoam.h.

◆ fPseRan

TRandom3* TMVA::PDEFoam::fPseRan
protected

Pointer to user-defined generator of pseudorandom numbers.

Definition at line 101 of file PDEFoam.h.

◆ fRvec

Double_t* TMVA::PDEFoam::fRvec
protected

[fDim] random number vector from r.n. generator fDim+1 maximum elements

Definition at line 99 of file PDEFoam.h.

◆ fTimer

Timer* TMVA::PDEFoam::fTimer
protected

! timer for graphical output

Definition at line 116 of file PDEFoam.h.

◆ fVariableNames

TObjArray* TMVA::PDEFoam::fVariableNames
protected

collection of all variable names

Definition at line 117 of file PDEFoam.h.

◆ fVolFrac

Float_t TMVA::PDEFoam::fVolFrac
protected

BACKWARDS COMPATIBILITY: volume fraction (with respect to total phase space.

Definition at line 111 of file PDEFoam.h.

◆ fXmax

Double_t* TMVA::PDEFoam::fXmax
protected

[fDim] maximum for variable transform

Definition at line 107 of file PDEFoam.h.

◆ fXmin

Double_t* TMVA::PDEFoam::fXmin
protected

[fDim] minimum for variable transform

Definition at line 106 of file PDEFoam.h.

Libraries for TMVA::PDEFoam:

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