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

Implementation of the GiniIndex With Laplace correction as separation criterion.

Large Gini Indices (maximum 0.5) mean , that the sample is well mixed (same amount of signal and bkg) bkg.

Small Indices mean, well separated.

General definition:

\[Gini(Sample M) = 1 - (\frac{c(1)}{N})^2 - (\frac{c(2)}{N})^2 .... - (\frac{c(k)}{N})^2 \]

Where:

\( M \) is a sample of whatever \( N \) elements (events) that belong to \( K \) different classes.

\( c(k) \) is the number of elements that belong to class \( k \) for just Signal and Background classes this boils down to:

The Laplace's correction to the probability distribution would turn the \( \frac{c(1)}{N} \) into \( \frac{(c(1)+1)}{(N+2)} \) using this the simple Gini Index for two classes

\[Gini(Sample) = \frac{2sb}{(s+b)^2} \]

turns into

\[GiniLaplace(Sample) = \frac{2(sb+s+b+1)}{(s+b+2)^2} \]

Definition at line 59 of file GiniIndexWithLaplace.h.

Public Member Functions

 GiniIndexWithLaplace ()
 GiniIndexWithLaplace (const GiniIndexWithLaplace &g)
virtual ~GiniIndexWithLaplace ()
const TStringGetName ()
virtual Double_t GetSeparationGain (const Double_t nSelS, const Double_t nSelB, const Double_t nTotS, const Double_t nTotB)
 Separation Gain: the measure of how the quality of separation of the sample increases by splitting the sample e.g.
Double_t GetSeparationIndex (const Double_t s, const Double_t b) override
TClassIsA () const override
void Streamer (TBuffer &) override
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Static Public Member Functions

static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()

Protected Attributes

TString fName
Double_t fPrecisionCut

#include <TMVA/GiniIndexWithLaplace.h>

Inheritance diagram for TMVA::GiniIndexWithLaplace:
TMVA::SeparationBase

Constructor & Destructor Documentation

◆ GiniIndexWithLaplace() [1/2]

TMVA::GiniIndexWithLaplace::GiniIndexWithLaplace ( )
inline

Definition at line 64 of file GiniIndexWithLaplace.h.

◆ GiniIndexWithLaplace() [2/2]

TMVA::GiniIndexWithLaplace::GiniIndexWithLaplace ( const GiniIndexWithLaplace & g)
inline

Definition at line 67 of file GiniIndexWithLaplace.h.

◆ ~GiniIndexWithLaplace()

virtual TMVA::GiniIndexWithLaplace::~GiniIndexWithLaplace ( )
inlinevirtual

Definition at line 70 of file GiniIndexWithLaplace.h.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 77 of file GiniIndexWithLaplace.h.

◆ DeclFileName()

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

Definition at line 77 of file GiniIndexWithLaplace.h.

◆ GetName()

const TString & TMVA::SeparationBase::GetName ( )
inlineinherited

Definition at line 104 of file SeparationBase.h.

◆ GetSeparationGain()

Double_t TMVA::SeparationBase::GetSeparationGain ( const Double_t nSelS,
const Double_t nSelB,
const Double_t nTotS,
const Double_t nTotB )
virtualinherited

Separation Gain: the measure of how the quality of separation of the sample increases by splitting the sample e.g.

into a "left-node" and a "right-node" (N * Index_parent) - (N_left * Index_left) - (N_right * Index_right) this is then the quality criterion which is optimized for when trying to increase the information in the system (making the best selection

Reimplemented in TMVA::SdivSqrtSplusB.

Definition at line 100 of file SeparationBase.cxx.

◆ GetSeparationIndex()

Double_t TMVA::GiniIndexWithLaplace::GetSeparationIndex ( const Double_t s,
const Double_t b )
overridevirtual

Implements TMVA::SeparationBase.

Definition at line 81 of file GiniIndexWithLaplace.cxx.

◆ IsA()

TClass * TMVA::GiniIndexWithLaplace::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TMVA::SeparationBase.

Definition at line 77 of file GiniIndexWithLaplace.h.

◆ Streamer()

void TMVA::GiniIndexWithLaplace::Streamer ( TBuffer & )
overridevirtual

Reimplemented from TMVA::SeparationBase.

◆ StreamerNVirtual()

void TMVA::GiniIndexWithLaplace::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 77 of file GiniIndexWithLaplace.h.

Member Data Documentation

◆ fName

TString TMVA::SeparationBase::fName
protectedinherited

Definition at line 108 of file SeparationBase.h.

◆ fPrecisionCut

Double_t TMVA::SeparationBase::fPrecisionCut
protectedinherited

Definition at line 110 of file SeparationBase.h.


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