Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
TMVA::SeparationBase Class Referenceabstract
TMVA

An interface to calculate the "SeparationGain" for different separation criteria used in various training algorithms.

There are two things: the Separation Index, and the Separation Gain Separation Index: Measure of the "purity" of a sample. If all elements (events) in the sample belong to the same class (e.g. signal or background), than the separation index is 0 (meaning 100% purity (or 0% purity as it is symmetric. The index becomes maximal, for perfectly mixed samples eg. purity=50% , N_signal = N_bkg

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

Definition at line 82 of file SeparationBase.h.

Public Member Functions

 SeparationBase ()
 Constructor.
 
 SeparationBase (const SeparationBase &s)
 Copy constructor.
 
virtual ~SeparationBase ()
 
const TString & GetName ()
 
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.
 
virtual Double_t GetSeparationIndex (const Double_t s, const Double_t b)=0
 
virtual TClass * IsA () const
 
virtual void Streamer (TBuffer &)
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 

Static Public Member Functions

static TClass * Class ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 

Protected Attributes

TString fName
 
Double_t fPrecisionCut
 

#include <TMVA/SeparationBase.h>

Inheritance diagram for TMVA::SeparationBase:
[legend]

Constructor & Destructor Documentation

◆ SeparationBase() [1/2]

TMVA::SeparationBase::SeparationBase ( )

Constructor.

Definition at line 76 of file SeparationBase.cxx.

◆ SeparationBase() [2/2]

TMVA::SeparationBase::SeparationBase ( const SeparationBase &  s)

Copy constructor.

Definition at line 86 of file SeparationBase.cxx.

◆ ~SeparationBase()

virtual TMVA::SeparationBase::~SeparationBase ( )
inlinevirtual

Definition at line 93 of file SeparationBase.h.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 112 of file SeparationBase.h.

◆ DeclFileName()

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

Definition at line 112 of file SeparationBase.h.

◆ GetName()

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

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

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 101 of file SeparationBase.cxx.

◆ GetSeparationIndex()

virtual Double_t TMVA::SeparationBase::GetSeparationIndex ( const Double_t  s,
const Double_t  b 
)
pure virtual

Implemented in TMVA::CrossEntropy, TMVA::GiniIndex, TMVA::GiniIndexWithLaplace, TMVA::MisClassificationError, and TMVA::SdivSqrtSplusB.

◆ IsA()

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

Reimplemented in TMVA::CrossEntropy, TMVA::GiniIndex, TMVA::GiniIndexWithLaplace, TMVA::MisClassificationError, and TMVA::SdivSqrtSplusB.

Definition at line 112 of file SeparationBase.h.

◆ Streamer()

virtual void TMVA::SeparationBase::Streamer ( TBuffer &  )
virtual

Reimplemented in TMVA::CrossEntropy, TMVA::GiniIndex, TMVA::GiniIndexWithLaplace, TMVA::MisClassificationError, and TMVA::SdivSqrtSplusB.

◆ StreamerNVirtual()

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

Definition at line 112 of file SeparationBase.h.

Member Data Documentation

◆ fName

TString TMVA::SeparationBase::fName
protected

Definition at line 108 of file SeparationBase.h.

◆ fPrecisionCut

Double_t TMVA::SeparationBase::fPrecisionCut
protected

Definition at line 110 of file SeparationBase.h.

Libraries for TMVA::SeparationBase:
[legend]
The documentation for this class was generated from the following files: