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

Class for type info of MVA input variable.

Definition at line 47 of file VariableInfo.h.

Public Member Functions

 VariableInfo ()
 default constructor
 
 VariableInfo (const TString &expression, const TString &title, const TString &unit, Int_t varCounter, char varType='F', void *external=nullptr, Double_t min=0, Double_t max=0, Bool_t normalized=kTRUE)
 constructor
 
 VariableInfo (const VariableInfo &other)
 copy constructor
 
 ~VariableInfo ()
 
void AddToXML (void *varnode)
 write class to XML
 
const TStringGetExpression () const
 
void * GetExternalLink () const
 
const TStringGetInternalName () const
 
const TStringGetLabel () const
 
Double_t GetMax () const
 
Double_t GetMean () const
 
Double_t GetMin () const
 
Double_t GetRMS () const
 
const TStringGetUnit () const
 
Double_t GetVariance () const
 
char GetVarType () const
 
virtual TClassIsA () const
 
VariableInfooperator= (const TMVA::VariableInfo &rhs)
 comparison operator
 
void ReadFromStream (std::istream &istr)
 read VariableInfo from stream
 
void ReadFromXML (void *varnode)
 read VariableInfo from stream
 
void ResetMinMax ()
 
void SetExternalLink (void *p)
 
void SetInternalName (const char *name)
 
void SetMax (Double_t v)
 
void SetMean (Double_t v)
 
void SetMin (Double_t v)
 
void SetRMS (Double_t v)
 
void SetVariance (Double_t v)
 
virtual void Streamer (TBuffer &)
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void WriteToStream (std::ostream &o) const
 write VariableInfo to stream
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- 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 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 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 UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
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
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
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 (the base implementation is no-op).
 
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, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
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 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 TNamed
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.
 

Private Member Functions

void SetExpression (const TString &s)
 
void SetInternalVarName (const TString &s)
 
void SetLabel (const TString &s)
 
void SetUnit (const TString &s)
 
void SetVarType (char c)
 

Private Attributes

TString fExpression
 original variable expression (can be a formula)
 
void * fExternalData
 ! if the variable content is linked to an external pointer
 
TString fExternalDataType
 type of external variable (int, long, double, float) - to be done JS
 
TString fInternalName
 internal variable name (needs to be regular expression)
 
TString fLabel
 variable label, set by "mylabel := var1 + var2", this is a shortcut
 
Bool_t fNormalized
 variable gets normalized
 
TString fUnit
 unit for axis labels in plots; set by third string in AddVariable
 
Int_t fVarCounter
 dummy variable
 
Char_t fVarType
 the variable type to be used internally ('F'-default or 'I')
 
Double_t fXmaxNorm
 maximum value for correlated/decorrelated/PCA variable
 
Double_t fXmeanNorm
 mean value for correlated/decorrelated/PCA variable
 
Double_t fXminNorm
 minimum value for correlated/decorrelated/PCA variable
 
Double_t fXrmsNorm
 rms value for correlated/decorrelated/PCA variable
 
Double_t fXvarianceNorm
 variance value for correlated/decorrelated/PCA variable
 

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 )) }
 
- 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 inherited from TNamed
TString fName
 
TString fTitle
 

#include <TMVA/VariableInfo.h>

Inheritance diagram for TMVA::VariableInfo:
[legend]

Constructor & Destructor Documentation

◆ VariableInfo() [1/3]

TMVA::VariableInfo::VariableInfo ( const TString expression,
const TString title,
const TString unit,
Int_t  varCounter,
char  varType = 'F',
void *  external = nullptr,
Double_t  min = 0,
Double_t  max = 0,
Bool_t  normalized = kTRUE 
)

constructor

Definition at line 48 of file VariableInfo.cxx.

◆ VariableInfo() [2/3]

TMVA::VariableInfo::VariableInfo ( )

default constructor

Definition at line 87 of file VariableInfo.cxx.

◆ VariableInfo() [3/3]

TMVA::VariableInfo::VariableInfo ( const VariableInfo other)

copy constructor

Definition at line 110 of file VariableInfo.cxx.

◆ ~VariableInfo()

TMVA::VariableInfo::~VariableInfo ( )
inline

Definition at line 56 of file VariableInfo.h.

Member Function Documentation

◆ AddToXML()

void TMVA::VariableInfo::AddToXML ( void *  varnode)

write class to XML

Definition at line 193 of file VariableInfo.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 114 of file VariableInfo.h.

◆ DeclFileName()

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

Definition at line 114 of file VariableInfo.h.

◆ GetExpression()

const TString & TMVA::VariableInfo::GetExpression ( ) const
inline

Definition at line 57 of file VariableInfo.h.

◆ GetExternalLink()

void * TMVA::VariableInfo::GetExternalLink ( ) const
inline

Definition at line 83 of file VariableInfo.h.

◆ GetInternalName()

const TString & TMVA::VariableInfo::GetInternalName ( ) const
inline

Definition at line 58 of file VariableInfo.h.

◆ GetLabel()

const TString & TMVA::VariableInfo::GetLabel ( ) const
inline

Definition at line 59 of file VariableInfo.h.

◆ GetMax()

Double_t TMVA::VariableInfo::GetMax ( ) const
inline

Definition at line 64 of file VariableInfo.h.

◆ GetMean()

Double_t TMVA::VariableInfo::GetMean ( ) const
inline

Definition at line 65 of file VariableInfo.h.

◆ GetMin()

Double_t TMVA::VariableInfo::GetMin ( ) const
inline

Definition at line 63 of file VariableInfo.h.

◆ GetRMS()

Double_t TMVA::VariableInfo::GetRMS ( ) const
inline

Definition at line 66 of file VariableInfo.h.

◆ GetUnit()

const TString & TMVA::VariableInfo::GetUnit ( ) const
inline

Definition at line 60 of file VariableInfo.h.

◆ GetVariance()

Double_t TMVA::VariableInfo::GetVariance ( ) const
inline

Definition at line 67 of file VariableInfo.h.

◆ GetVarType()

char TMVA::VariableInfo::GetVarType ( ) const
inline

Definition at line 61 of file VariableInfo.h.

◆ IsA()

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

Reimplemented from TNamed.

Definition at line 114 of file VariableInfo.h.

◆ operator=()

TMVA::VariableInfo & TMVA::VariableInfo::operator= ( const TMVA::VariableInfo rhs)

comparison operator

Definition at line 131 of file VariableInfo.cxx.

◆ ReadFromStream()

void TMVA::VariableInfo::ReadFromStream ( std::istream &  istr)

read VariableInfo from stream

Definition at line 164 of file VariableInfo.cxx.

◆ ReadFromXML()

void TMVA::VariableInfo::ReadFromXML ( void *  varnode)

read VariableInfo from stream

Definition at line 214 of file VariableInfo.cxx.

◆ ResetMinMax()

void TMVA::VariableInfo::ResetMinMax ( )
inline

Definition at line 77 of file VariableInfo.h.

◆ SetExpression()

void TMVA::VariableInfo::SetExpression ( const TString s)
inlineprivate

Definition at line 91 of file VariableInfo.h.

◆ SetExternalLink()

void TMVA::VariableInfo::SetExternalLink ( void *  p)
inline

Definition at line 75 of file VariableInfo.h.

◆ SetInternalName()

void TMVA::VariableInfo::SetInternalName ( const char *  name)
inline

Definition at line 69 of file VariableInfo.h.

◆ SetInternalVarName()

void TMVA::VariableInfo::SetInternalVarName ( const TString s)
inlineprivate

Definition at line 94 of file VariableInfo.h.

◆ SetLabel()

void TMVA::VariableInfo::SetLabel ( const TString s)
inlineprivate

Definition at line 92 of file VariableInfo.h.

◆ SetMax()

void TMVA::VariableInfo::SetMax ( Double_t  v)
inline

Definition at line 72 of file VariableInfo.h.

◆ SetMean()

void TMVA::VariableInfo::SetMean ( Double_t  v)
inline

Definition at line 73 of file VariableInfo.h.

◆ SetMin()

void TMVA::VariableInfo::SetMin ( Double_t  v)
inline

Definition at line 71 of file VariableInfo.h.

◆ SetRMS()

void TMVA::VariableInfo::SetRMS ( Double_t  v)
inline

Definition at line 74 of file VariableInfo.h.

◆ SetUnit()

void TMVA::VariableInfo::SetUnit ( const TString s)
inlineprivate

Definition at line 93 of file VariableInfo.h.

◆ SetVariance()

void TMVA::VariableInfo::SetVariance ( Double_t  v)
inline

Definition at line 76 of file VariableInfo.h.

◆ SetVarType()

void TMVA::VariableInfo::SetVarType ( char  c)
inlineprivate

Definition at line 95 of file VariableInfo.h.

◆ Streamer()

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

Stream an object of class TObject.

Reimplemented from TNamed.

◆ StreamerNVirtual()

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

Definition at line 114 of file VariableInfo.h.

◆ WriteToStream()

void TMVA::VariableInfo::WriteToStream ( std::ostream &  o) const

write VariableInfo to stream

Definition at line 148 of file VariableInfo.cxx.

Member Data Documentation

◆ fExpression

TString TMVA::VariableInfo::fExpression
private

original variable expression (can be a formula)

Definition at line 97 of file VariableInfo.h.

◆ fExternalData

void* TMVA::VariableInfo::fExternalData
private

! if the variable content is linked to an external pointer

Definition at line 109 of file VariableInfo.h.

◆ fExternalDataType

TString TMVA::VariableInfo::fExternalDataType
private

type of external variable (int, long, double, float) - to be done JS

Definition at line 110 of file VariableInfo.h.

◆ fInternalName

TString TMVA::VariableInfo::fInternalName
private

internal variable name (needs to be regular expression)

Definition at line 98 of file VariableInfo.h.

◆ fLabel

TString TMVA::VariableInfo::fLabel
private

variable label, set by "mylabel := var1 + var2", this is a shortcut

Definition at line 99 of file VariableInfo.h.

◆ fNormalized

Bool_t TMVA::VariableInfo::fNormalized
private

variable gets normalized

Definition at line 108 of file VariableInfo.h.

◆ fUnit

TString TMVA::VariableInfo::fUnit
private

unit for axis labels in plots; set by third string in AddVariable

Definition at line 101 of file VariableInfo.h.

◆ fVarCounter

Int_t TMVA::VariableInfo::fVarCounter
private

dummy variable

Definition at line 111 of file VariableInfo.h.

◆ fVarType

Char_t TMVA::VariableInfo::fVarType
private

the variable type to be used internally ('F'-default or 'I')

Definition at line 102 of file VariableInfo.h.

◆ fXmaxNorm

Double_t TMVA::VariableInfo::fXmaxNorm
private

maximum value for correlated/decorrelated/PCA variable

Definition at line 104 of file VariableInfo.h.

◆ fXmeanNorm

Double_t TMVA::VariableInfo::fXmeanNorm
private

mean value for correlated/decorrelated/PCA variable

Definition at line 105 of file VariableInfo.h.

◆ fXminNorm

Double_t TMVA::VariableInfo::fXminNorm
private

minimum value for correlated/decorrelated/PCA variable

Definition at line 103 of file VariableInfo.h.

◆ fXrmsNorm

Double_t TMVA::VariableInfo::fXrmsNorm
private

rms value for correlated/decorrelated/PCA variable

Definition at line 106 of file VariableInfo.h.

◆ fXvarianceNorm

Double_t TMVA::VariableInfo::fXvarianceNorm
private

variance value for correlated/decorrelated/PCA variable

Definition at line 107 of file VariableInfo.h.

Libraries for TMVA::VariableInfo:

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