Logo ROOT   master
Reference Guide
TMVA::PDEFoamMultiTarget Class Reference

This PDEFoam variant is used to estimate multiple targets by creating an event density foam (PDEFoamEvent), which has dimension:

dimension = number of variables + number targets

This PDEFoam variant stores in every cell the sum of event weights and the sum of the squared event weights. During evaluation for a given event, which has only variables and no targets (number of event variables is smaller than the foam dimension), the targets are estimated by finding all cells, which correspond to this event and calculate the Mean (or Mpv, depending on the ETargetSelection) cell center weighted by the event density in the cell.

This PDEFoam variant should be booked together with the PDEFoamEventDensity density estimator, which returns the event weight density at a given phase space point during the foam build-up.

Definition at line 43 of file PDEFoamMultiTarget.h.

Public Member Functions

 PDEFoamMultiTarget ()
 Default constructor for streamer, user should not use it. More...
 
 PDEFoamMultiTarget (const TString &, ETargetSelection)
 User constructor. More...
 
virtual ~PDEFoamMultiTarget ()
 
virtual std::vector< Float_tGetCellValue (const std::map< Int_t, Float_t > &, ECellValue)
 This function is overridden from PDFEFoam. More...
 
virtual Float_t GetCellValue (const PDEFoamCell *cell, ECellValue cv)
 Returns the cell value of 'cell' corresponding to the given option '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 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...
 
- Public Member Functions inherited from TMVA::PDEFoamEvent
 PDEFoamEvent ()
 Default constructor for streamer, user should not use it. More...
 
 PDEFoamEvent (const TString &)
 
virtual ~PDEFoamEvent ()
 
virtual void FillFoamCells (const Event *ev, Float_t wt)
 This function fills an event weight 'wt' into the PDEFoam. More...
 
- Public Member Functions inherited from TMVA::PDEFoam
 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 AddVariableName (const char *s)
 
void AddVariableName (TObjString *s)
 
void CheckAll (Int_t)
 User utility, miscellaneous and debug. More...
 
void Create ()
 Basic initialization of FOAM invoked by the user. More...
 
void DeleteBinarySearchTree ()
 Delete the foam's density estimator, which contains the binary search tree. More...
 
TH1DDraw1Dim (ECellValue cell_value, Int_t nbin, PDEFoamKernelBase *kernel=NULL)
 Draws 1-dimensional foam (= histogram) More...
 
void FillBinarySearchTree (const Event *ev)
 Insert event to internal foam's density estimator PDEFoamDensityBase. More...
 
virtual void Finalize ()
 
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 Float_t GetCellValue (const PDEFoamCell *cell, ECellValue cv)
 Returns the cell value of 'cell' corresponding to the given option 'cv'. More...
 
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 ()
 
MsgLoggerLog () const
 
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...
 
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...
 
void ResetCellElements ()
 Remove the cell elements from all cells. 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...
 
void SetDensity (PDEFoamDensityBase *dens)
 
void SetDim (Int_t kDim)
 Sets dimension of cubical space. More...
 
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 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 More...
 
void SetXmin (Int_t idim, Double_t wmin)
 set lower foam bound in dimension idim 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
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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...
 
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. 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 selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. 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 void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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 const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. 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...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. 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...
 
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). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. 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...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. 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...
 
void ResetBit (UInt_t f)
 
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...
 
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)
 
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 SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. 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...
 

Protected Member Functions

 PDEFoamMultiTarget (const PDEFoamMultiTarget &)
 Copy Constructor NOT IMPLEMENTED (NEVER USED) More...
 
virtual void CalculateMean (std::map< Int_t, Float_t > &, const std::vector< PDEFoamCell *> &)
 This function calculates the mean target value from a given number of cells. More...
 
virtual void CalculateMpv (std::map< Int_t, Float_t > &, const std::vector< PDEFoamCell *> &)
 This function calculates the most probable target value from a given number of cells. More...
 
- Protected Member Functions inherited from TMVA::PDEFoamEvent
 PDEFoamEvent (const PDEFoamEvent &)
 Copy Constructor NOT IMPLEMENTED (NEVER USED) More...
 
- Protected Member Functions inherited from TMVA::PDEFoam
 PDEFoam (const PDEFoam &)
 Copy Constructor NOT IMPLEMENTED (NEVER USED) More...
 
Int_t CellFill (Int_t, PDEFoamCell *)
 Internal subprogram used by Create. More...
 
virtual Bool_t CellValueIsUndefined (PDEFoamCell *)
 Returns true, if the value of the given cell is undefined. More...
 
Int_t Divide (PDEFoamCell *)
 Internal subprogram used by Create. More...
 
Double_t Eval (Double_t *xRand, Double_t &event_density)
 Internal subprogram. More...
 
virtual void Explore (PDEFoamCell *Cell)
 Internal subprogram used by Create. 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...
 
Double_t GetCellElement (const PDEFoamCell *cell, UInt_t i) const
 Returns cell element i of cell 'cell'. More...
 
PDEFoamDensityBaseGetDistr () const
 
void Grow ()
 Internal subprogram used by Create. More...
 
void InitCells ()
 Internal subprogram used by Create. More...
 
void MakeAlpha ()
 Internal subprogram used by Create. More...
 
void OutputGrow (Bool_t finished=false)
 message logger More...
 
Long_t PeekMax ()
 Internal subprogram used by Create. More...
 
void SetCellElement (PDEFoamCell *cell, UInt_t i, Double_t value)
 Set cell element i of cell to value. More...
 
template<typename T >
Sqr (T x) const
 
void Varedu (Double_t [], Int_t &, Double_t &, Double_t &)
 Internal subprogram used by Create. More...
 
- 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). More...
 
void MakeZombie ()
 

Protected Attributes

ETargetSelection fTargetSelection
 
- Protected Attributes inherited from TMVA::PDEFoam
Double_tfAlpha
 
PDEFoamCell ** fCells
 
Int_t fDim
 
PDEFoamDensityBasefDistr
 
EDTSeparation fDTSeparation
 
Int_t fEvPerBin
 
Bool_t fFillFoamWithOrigWeights
 
EFoamType fFoamType
 
TObjArrayfHistEdg
 
Int_tfInhiDiv
 [fDim] Dynamic Mask for cell division More...
 
Int_t fLastCe
 
MsgLoggerfLogger
 
Int_tfMaskDiv
 
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 More...
 
Int_t fNSampl
 
Bool_t fPeekMax
 
TRandom3fPseRan
 
Double_tfRvec
 
TimerfTimer
 distribution of training events More...
 
TObjArrayfVariableNames
 timer for graphical output More...
 
Float_t fVolFrac
 
Double_tfXmax
 
Double_tfXmin
 

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. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TMVA/PDEFoamMultiTarget.h>

Inheritance diagram for TMVA::PDEFoamMultiTarget:
[legend]

Constructor & Destructor Documentation

◆ PDEFoamMultiTarget() [1/3]

TMVA::PDEFoamMultiTarget::PDEFoamMultiTarget ( const PDEFoamMultiTarget from)
protected

Copy Constructor NOT IMPLEMENTED (NEVER USED)

Definition at line 104 of file PDEFoamMultiTarget.cxx.

◆ PDEFoamMultiTarget() [2/3]

TMVA::PDEFoamMultiTarget::PDEFoamMultiTarget ( )

Default constructor for streamer, user should not use it.

Definition at line 68 of file PDEFoamMultiTarget.cxx.

◆ PDEFoamMultiTarget() [3/3]

TMVA::PDEFoamMultiTarget::PDEFoamMultiTarget ( const TString name,
ETargetSelection  ts 
)

User constructor.

Parameters:

  • name - name of PDEFoam object
  • ts - target selection method used in GetCellValue(const std::map<Int_t, Float_t>& xvec, ECellValue) Candidates are: TMVA::kMean, TMVA::kMpv
    • TMVA::kMean - The function GetCellValue() finds all cells which contain a given event vector 'xvec' and returns the mean target (for every target variable in the foam).
    • TMVA::kMpv - The function GetCellValue() finds all cells which contain a given event vector 'xvec' and returns the most probable target (for every target variable in the foam), that is the target value which corresponds to the cell with the largest event density.

Definition at line 95 of file PDEFoamMultiTarget.cxx.

◆ ~PDEFoamMultiTarget()

virtual TMVA::PDEFoamMultiTarget::~PDEFoamMultiTarget ( )
inlinevirtual

Definition at line 57 of file PDEFoamMultiTarget.h.

Member Function Documentation

◆ CalculateMean()

void TMVA::PDEFoamMultiTarget::CalculateMean ( std::map< Int_t, Float_t > &  target,
const std::vector< PDEFoamCell *> &  cells 
)
protectedvirtual

This function calculates the mean target value from a given number of cells.

As weight the event density of the cell is used.

Parameters:

  • target - map of targets, where the key is the dimension and the value is the target value. It is assumed that this map is initialized such that there is a map entry for every target with all target values set to zero.
  • cells - vector of PDEFoam cells to pick the most probable target from

Definition at line 248 of file PDEFoamMultiTarget.cxx.

◆ CalculateMpv()

void TMVA::PDEFoamMultiTarget::CalculateMpv ( std::map< Int_t, Float_t > &  target,
const std::vector< PDEFoamCell *> &  cells 
)
protectedvirtual

This function calculates the most probable target value from a given number of cells.

The most probable target is defined to be the coordinates of the cell which has the biggest event density.

Parameters:

  • target - map of targets, where the key is the dimension and the value is the target value. It is assumed that this map is initialized such that there is a map entry for every target.
  • cells - vector of PDEFoam cells to pick the most probable target from

Definition at line 202 of file PDEFoamMultiTarget.cxx.

◆ GetCellValue() [1/4]

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

This function is overridden from PDFEFoam.

It returns all regression targets (in order), given an untransformed event vector 'xvec'. The key of 'xvec' is the dimension and the value (Float_t) is the coordinate.

Note: number of foam dimensions = number of variables + number of targets

Parameters:

  • xvec - map of event variables (no targets!)
  • cv - cell value to return (ignored!)

Return: Targets, ordered by missing dimensions in 'xvec'. The size of the returned vector = foam dimension - size of xvec.

Reimplemented from TMVA::PDEFoam.

Definition at line 128 of file PDEFoamMultiTarget.cxx.

◆ GetCellValue() [2/4]

Float_t TMVA::PDEFoam::GetCellValue

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.

Definition at line 1017 of file PDEFoam.cxx.

◆ GetCellValue() [3/4]

std::vector< Float_t > TMVA::PDEFoam::GetCellValue

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

Definition at line 1044 of file PDEFoam.cxx.

◆ GetCellValue() [4/4]

Float_t TMVA::PDEFoam::GetCellValue

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

Member Data Documentation

◆ fTargetSelection

ETargetSelection TMVA::PDEFoamMultiTarget::fTargetSelection
protected

Definition at line 47 of file PDEFoamMultiTarget.h.

Libraries for TMVA::PDEFoamMultiTarget:
[legend]

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