ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
TMVA::PDEFoam Class Reference

Definition at line 104 of file PDEFoam.h.

Public Member Functions

 PDEFoam ()
 Default constructor for streamer, user should not use it. More...
 
 PDEFoam (const TString &)
 User constructor, to be employed by the user. More...
 
virtual ~PDEFoam ()
 Default destructor. More...
 
void Initialize ()
 
void FillBinarySearchTree (const Event *ev)
 Insert event to internal foam's density estimator PDEFoamDensityBase. More...
 
void Create ()
 Basic initialization of FOAM invoked by the user. More...
 
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'. More...
 
void ResetCellElements ()
 Remove the cell elements from all cells. More...
 
virtual void Finalize ()
 
void SetDim (Int_t kDim)
 Sets dimension of cubical space. More...
 
void SetnCells (Long_t nCells)
 
void SetnSampl (Long_t nSampl)
 
void SetnBin (Int_t nBin)
 
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. More...
 
void SetDensity (PDEFoamDensityBase *dens)
 
Int_t GetTotDim () const
 
TString GetFoamName () const
 
UInt_t GetNActiveCells () const
 
UInt_t GetNInActiveCells () const
 
UInt_t GetNCells () const
 
PDEFoamCellGetRootCell () const
 
void SetNmin (UInt_t val)
 
UInt_t GetNmin ()
 
void SetMaxDepth (UInt_t maxdepth)
 
UInt_t GetMaxDepth () const
 
void SetXmin (Int_t idim, Double_t wmin)
 set lower foam bound in dimension idim More...
 
void SetXmax (Int_t idim, Double_t wmax)
 set upper foam bound in dimension idim More...
 
Double_t GetXmin (Int_t idim) const
 
Double_t GetXmax (Int_t idim) const
 
void AddVariableName (const char *s)
 
void AddVariableName (TObjString *s)
 
TObjStringGetVariableName (Int_t idx)
 
void DeleteBinarySearchTree ()
 Delete the foam's density estimator, which contains the binary search tree. More...
 
Float_t VarTransform (Int_t idim, Float_t x) const
 
std::vector< Float_tVarTransform (const std::vector< Float_t > &invec) const
 
Float_t VarTransformInvers (Int_t idim, Float_t x) const
 
std::vector< Float_tVarTransformInvers (const std::vector< Float_t > &invec) const
 
void CheckAll (Int_t)
 User utility, miscellaneous and debug. More...
 
void PrintCell (Long_t iCell=0)
 Prints geometry of and elements of 'iCell', as well as relations to parent and daughter cells. More...
 
void PrintCells ()
 Prints geometry of ALL cells of the FOAM. More...
 
MsgLoggerLog () const
 
virtual TH2DProject2 (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. More...
 
TH1DDraw1Dim (ECellValue cell_value, Int_t nbin, PDEFoamKernelBase *kernel=NULL)
 Draws 1-dimensional foam (= histogram) More...
 
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. More...
 
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'. More...
 
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'. More...
 
virtual Float_t GetCellValue (const PDEFoamCell *cell, ECellValue cv)
 Returns the cell value of 'cell' corresponding to the given option 'cv'. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
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. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
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). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

void OutputGrow (Bool_t finished=false)
 message logger More...
 
void InitCells ()
 Internal subprogram used by Create. More...
 
Int_t CellFill (Int_t, PDEFoamCell *)
 Internal subprogram used by Create. More...
 
virtual void Explore (PDEFoamCell *Cell)
 Internal subprogram used by Create. More...
 
void Varedu (Double_t[], Int_t &, Double_t &, Double_t &)
 Internal subrogram used by Create. More...
 
void MakeAlpha ()
 Internal subrogram used by Create. More...
 
void Grow ()
 Internal subrogram used by Create. More...
 
Long_t PeekMax ()
 Internal subprogram used by Create. More...
 
Int_t Divide (PDEFoamCell *)
 Internal subrogram used by Create. More...
 
Double_t Eval (Double_t *xRand, Double_t &event_density)
 Internal subprogram. More...
 
Double_t GetCellElement (const PDEFoamCell *cell, UInt_t i) const
 Returns cell element i of cell 'cell'. More...
 
void SetCellElement (PDEFoamCell *cell, UInt_t i, Double_t value)
 Set cell element i of cell to value. More...
 
virtual Bool_t CellValueIsUndefined (PDEFoamCell *)
 Returns true, if the value of the given cell is undefined. More...
 
PDEFoamCellFindCell (const std::vector< Float_t > &) const
 Find cell that contains 'xvec' (in foam coordinates [0,1]). More...
 
std::vector< TMVA::PDEFoamCell * > FindCells (const std::vector< Float_t > &) const
 Find all cells, that contain txvec. More...
 
std::vector< TMVA::PDEFoamCell * > FindCells (const std::map< Int_t, Float_t > &) const
 Find all cells, that contain the coordinates specified in txvec. More...
 
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(). More...
 
PDEFoamDensityBaseGetDistr () const
 
template<typename T >
Sqr (T x) const
 
 PDEFoam (const PDEFoam &)
 Copy Constructor NOT IMPLEMENTED (NEVER USED) More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

TString fName
 
Int_t fDim
 
Int_t fNCells
 
Int_t fNBin
 
Int_t fNSampl
 
Int_t fEvPerBin
 
Int_tfMaskDiv
 
Int_tfInhiDiv
 [fDim] Dynamic Mask for cell division More...
 
Int_t fNoAct
 [fDim] Flags for inhibiting cell division More...
 
Int_t fLastCe
 
PDEFoamCell ** fCells
 
TObjArrayfHistEdg
 
Double_tfRvec
 
TRandom3fPseRan
 
Double_tfAlpha
 
EFoamType fFoamType
 
Double_tfXmin
 
Double_tfXmax
 
UInt_t fNElements
 
UInt_t fNmin
 
UInt_t fMaxDepth
 
Float_t fVolFrac
 
Bool_t fFillFoamWithOrigWeights
 
EDTSeparation fDTSeparation
 
Bool_t fPeekMax
 
PDEFoamDensityBasefDistr
 
TimerfTimer
 distribution of training events More...
 
TObjArrayfVariableNames
 timer for graphical output More...
 
MsgLoggerfLogger
 

Friends

class PDEFoamKernelBase
 
class PDEFoamKernelTrivial
 
class PDEFoamKernelLinN
 
class PDEFoamKernelGauss
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TMVA/PDEFoam.h>

+ Inheritance diagram for TMVA::PDEFoam:
+ Collaboration diagram for TMVA::PDEFoam:

Constructor & Destructor Documentation

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

Copy Constructor NOT IMPLEMENTED (NEVER USED)

Definition at line 219 of file PDEFoam.cxx.

TMVA::PDEFoam::PDEFoam ( )

Default constructor for streamer, user should not use it.

Definition at line 113 of file PDEFoam.cxx.

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

User constructor, to be employed by the user.

Definition at line 152 of file PDEFoam.cxx.

TMVA::PDEFoam::~PDEFoam ( )
virtual

Default destructor.

Definition at line 194 of file PDEFoam.cxx.

Member Function Documentation

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

Definition at line 242 of file PDEFoam.h.

Referenced by AddVariableName().

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

Definition at line 243 of file PDEFoam.h.

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 399 of file PDEFoam.cxx.

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 1000 of file PDEFoam.cxx.

Referenced by TMVA::PDEFoamKernelGauss::Estimate(), TMVA::PDEFoamKernelLinN::GetAverageNeighborsValue(), TMVA::PDEFoamKernelGauss::GetAverageNeighborsValue(), and TMVA::PDEFoamKernelLinN::WeightLinNeighbors().

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

User utility, miscellaneous and debug.

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

Definition at line 832 of file PDEFoam.cxx.

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 302 of file PDEFoam.cxx.

void TMVA::PDEFoam::DeleteBinarySearchTree ( )

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

Definition at line 1676 of file PDEFoam.cxx.

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

Internal subrogram 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 724 of file PDEFoam.cxx.

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

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 1228 of file PDEFoam.cxx.

Referenced by TMVA::Plot1DimFoams().

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

Internal subprogram.

Evaluates (training) distribution.

Definition at line 757 of file PDEFoam.cxx.

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 withing PeekMax() to avoid splitting cells which contain less than fNmin events.

Reimplemented in TMVA::PDEFoamDecisionTree.

Definition at line 444 of file PDEFoam.cxx.

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

Insert event to internal foam's density estimator PDEFoamDensityBase.

Definition at line 1667 of file PDEFoam.cxx.

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::PDEFoamTarget, TMVA::PDEFoamDiscriminant, and TMVA::PDEFoamEvent.

Definition at line 965 of file PDEFoam.cxx.

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

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

Definition at line 209 of file PDEFoam.h.

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 1090 of file PDEFoam.cxx.

Referenced by TMVA::PDEFoamKernelTrivial::Estimate(), TMVA::PDEFoamKernelLinN::GetAverageNeighborsValue(), TMVA::PDEFoamKernelGauss::GetAverageNeighborsValue(), and TMVA::PDEFoamKernelLinN::WeightLinNeighbors().

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 1175 of file PDEFoam.cxx.

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 1206 of file PDEFoam.cxx.

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 1128 of file PDEFoam.cxx.

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 1426 of file PDEFoam.cxx.

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::PDEFoamTarget.

Definition at line 1026 of file PDEFoam.cxx.

Referenced by TMVA::PDEFoamKernelTrivial::Estimate(), TMVA::PDEFoamKernelGauss::Estimate(), TMVA::PDEFoamKernelLinN::GetAverageNeighborsValue(), TMVA::PDEFoamKernelGauss::GetAverageNeighborsValue(), and TMVA::PDEFoamKernelLinN::WeightLinNeighbors().

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.

Definition at line 1053 of file PDEFoam.cxx.

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.

Definition at line 1366 of file PDEFoam.cxx.

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

Definition at line 183 of file PDEFoam.h.

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

Definition at line 223 of file PDEFoam.h.

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

Definition at line 233 of file PDEFoam.h.

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

Definition at line 224 of file PDEFoam.h.

Referenced by GetNInActiveCells().

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

Definition at line 226 of file PDEFoam.h.

Referenced by GetNInActiveCells().

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

Definition at line 225 of file PDEFoam.h.

UInt_t TMVA::PDEFoam::GetNmin ( )
inline

Definition at line 231 of file PDEFoam.h.

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

Definition at line 227 of file PDEFoam.h.

Referenced by TMVA::PlotCellTree().

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

Definition at line 244 of file PDEFoam.h.

Referenced by TMVA::Plot1DimFoams(), and TMVA::PlotNDimFoams().

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

Definition at line 239 of file PDEFoam.h.

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

Definition at line 238 of file PDEFoam.h.

void TMVA::PDEFoam::Grow ( )
protected

Internal subrogram 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 777 of file PDEFoam.cxx.

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 366 of file PDEFoam.cxx.

void TMVA::PDEFoam::Initialize ( )
inline

Definition at line 198 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

MsgLogger& TMVA::PDEFoam::Log ( ) const
inline
void TMVA::PDEFoam::MakeAlpha ( )
protected

Internal subrogram used by Create.

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

Definition at line 647 of file PDEFoam.cxx.

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

message logger

Overridden function of PDEFoam to avoid native foam output.

Draw TMVA-process bar instead.

Definition at line 1470 of file PDEFoam.cxx.

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 661 of file PDEFoam.cxx.

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 905 of file PDEFoam.cxx.

void TMVA::PDEFoam::PrintCells ( void  )

Prints geometry of ALL cells of the FOAM.

Definition at line 952 of file PDEFoam.cxx.

TH2D * TMVA::PDEFoam::Project2 ( Int_t  idim1,
Int_t  idim2,
ECellValue  cell_value = kValue,
PDEFoamKernelBase kernel = NULL,
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 1280 of file PDEFoam.cxx.

Referenced by TMVA::PlotNDimFoams().

void TMVA::PDEFoam::ResetCellElements ( )

Remove the cell elements from all cells.

Definition at line 981 of file PDEFoam.cxx.

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 ouput 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 1521 of file PDEFoam.cxx.

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 1442 of file PDEFoam.cxx.

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

Definition at line 219 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

Sets dimension of cubical space.

Definition at line 260 of file PDEFoam.cxx.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

Definition at line 217 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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 812 of file PDEFoam.cxx.

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

Definition at line 232 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

Definition at line 216 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

Definition at line 214 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

Definition at line 230 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

Definition at line 215 of file PDEFoam.h.

Referenced by TMVA::MethodPDEFoam::InitFoam().

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

set upper foam bound in dimension idim

Definition at line 286 of file PDEFoam.cxx.

Referenced by TMVA::MethodPDEFoam::SetXminXmax().

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

set lower foam bound in dimension idim

Definition at line 275 of file PDEFoam.cxx.

Referenced by TMVA::MethodPDEFoam::SetXminXmax().

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

Definition at line 186 of file PDEFoam.h.

void TMVA::PDEFoam::Varedu ( Double_t  [],
Int_t ,
Double_t ,
Double_t  
)
protected

Internal subrogram 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 580 of file PDEFoam.cxx.

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

Definition at line 306 of file PDEFoam.h.

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

Definition at line 313 of file PDEFoam.h.

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

Definition at line 323 of file PDEFoam.h.

Referenced by TMVA::DrawCell().

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

Definition at line 330 of file PDEFoam.h.

Friends And Related Function Documentation

friend class PDEFoamKernelBase
friend

Definition at line 292 of file PDEFoam.h.

friend class PDEFoamKernelGauss
friend

Definition at line 295 of file PDEFoam.h.

friend class PDEFoamKernelLinN
friend

Definition at line 294 of file PDEFoam.h.

friend class PDEFoamKernelTrivial
friend

Definition at line 293 of file PDEFoam.h.

Member Data Documentation

Double_t* TMVA::PDEFoam::fAlpha
protected

Definition at line 128 of file PDEFoam.h.

PDEFoamCell** TMVA::PDEFoam::fCells
protected

Definition at line 121 of file PDEFoam.h.

Referenced by TMVA::PDEFoamKernelGauss::Estimate().

Int_t TMVA::PDEFoam::fDim
protected

Definition at line 109 of file PDEFoam.h.

Referenced by GetTotDim().

PDEFoamDensityBase* TMVA::PDEFoam::fDistr
protected

Definition at line 140 of file PDEFoam.h.

Referenced by GetDistr().

EDTSeparation TMVA::PDEFoam::fDTSeparation
protected

Definition at line 138 of file PDEFoam.h.

Int_t TMVA::PDEFoam::fEvPerBin
protected

Definition at line 114 of file PDEFoam.h.

Bool_t TMVA::PDEFoam::fFillFoamWithOrigWeights
protected

Definition at line 137 of file PDEFoam.h.

EFoamType TMVA::PDEFoam::fFoamType
protected

Definition at line 130 of file PDEFoam.h.

TObjArray* TMVA::PDEFoam::fHistEdg
protected

Definition at line 123 of file PDEFoam.h.

Int_t* TMVA::PDEFoam::fInhiDiv
protected

[fDim] Dynamic Mask for cell division

Definition at line 117 of file PDEFoam.h.

Int_t TMVA::PDEFoam::fLastCe
protected

Definition at line 120 of file PDEFoam.h.

Referenced by TMVA::PDEFoamKernelGauss::Estimate().

MsgLogger* TMVA::PDEFoam::fLogger
mutableprotected

Definition at line 143 of file PDEFoam.h.

Referenced by Log().

Int_t* TMVA::PDEFoam::fMaskDiv
protected

Definition at line 116 of file PDEFoam.h.

UInt_t TMVA::PDEFoam::fMaxDepth
protected

Definition at line 135 of file PDEFoam.h.

Referenced by GetMaxDepth().

TString TMVA::PDEFoam::fName
protected

Definition at line 108 of file PDEFoam.h.

Referenced by GetFoamName().

Int_t TMVA::PDEFoam::fNBin
protected

Definition at line 112 of file PDEFoam.h.

Int_t TMVA::PDEFoam::fNCells
protected

Definition at line 110 of file PDEFoam.h.

Referenced by GetNCells().

UInt_t TMVA::PDEFoam::fNElements
protected

Definition at line 133 of file PDEFoam.h.

UInt_t TMVA::PDEFoam::fNmin
protected

Definition at line 134 of file PDEFoam.h.

Referenced by GetNmin().

Int_t TMVA::PDEFoam::fNoAct
protected

[fDim] Flags for inhibiting cell division

Definition at line 119 of file PDEFoam.h.

Referenced by GetNActiveCells().

Int_t TMVA::PDEFoam::fNSampl
protected

Definition at line 113 of file PDEFoam.h.

Bool_t TMVA::PDEFoam::fPeekMax
protected

Definition at line 139 of file PDEFoam.h.

TRandom3* TMVA::PDEFoam::fPseRan
protected

Definition at line 126 of file PDEFoam.h.

Double_t* TMVA::PDEFoam::fRvec
protected

Definition at line 124 of file PDEFoam.h.

Timer* TMVA::PDEFoam::fTimer
protected

distribution of training events

Definition at line 141 of file PDEFoam.h.

TObjArray* TMVA::PDEFoam::fVariableNames
protected

timer for graphical output

Definition at line 142 of file PDEFoam.h.

Referenced by PDEFoam().

Float_t TMVA::PDEFoam::fVolFrac
protected

Definition at line 136 of file PDEFoam.h.

Double_t* TMVA::PDEFoam::fXmax
protected

Definition at line 132 of file PDEFoam.h.

Referenced by VarTransform().

Double_t* TMVA::PDEFoam::fXmin
protected

Definition at line 131 of file PDEFoam.h.

Referenced by VarTransform().


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