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

Definition at line 51 of file Event.h.

Public Member Functions

 Event ()
 copy constructor
 
 Event (const Event &)
 copy constructor
 
 Event (const std::vector< Float_t * > *&, UInt_t nvar)
 constructor for single events
 
 Event (const std::vector< Float_t > &, UInt_t theClass, Double_t weight=1.0, Double_t boostweight=1.0)
 constructor
 
 Event (const std::vector< Float_t > &values, const std::vector< Float_t > &targetValues, const std::vector< Float_t > &spectatorValues, UInt_t theClass=0, Double_t weight=1.0, Double_t boostweight=1.0)
 constructor
 
 Event (const std::vector< Float_t > &values, const std::vector< Float_t > &targetValues, UInt_t theClass=0, Double_t weight=1.0, Double_t boostweight=1.0)
 constructor
 
 ~Event ()
 Event destructor.
 
void CopyVarValues (const Event &other)
 copies only the variable values
 
Double_t GetBoostWeight () const
 
UInt_t GetClass () const
 
UInt_t GetNSpectators () const
 accessor to the number of spectators
 
UInt_t GetNTargets () const
 accessor to the number of targets
 
UInt_t GetNVariables () const
 accessor to the number of variables
 
Double_t GetOriginalWeight () const
 
Float_t GetSpectator (UInt_t ivar) const
 return spectator content
 
std::vector< Float_t > & GetSpectators ()
 
const std::vector< Float_t > & GetSpectators () const
 
Float_t GetTarget (UInt_t itgt) const
 
std::vector< Float_t > & GetTargets ()
 
const std::vector< Float_t > & GetTargets () const
 
Float_t GetValue (UInt_t ivar) const
 return value of i'th variable
 
Float_t GetValueFast (UInt_t ivar) const
 
std::vector< Float_t > & GetValues ()
 
const std::vector< Float_t > & GetValues () const
 return value vector
 
Double_t GetWeight () const
 return the event weight - depending on whether the flag IgnoreNegWeightsInTraining is or not.
 
virtual TClassIsA () const
 
Bool_t IsDynamic () const
 
Eventoperator= (const Event &)=default
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
void Print (std::ostream &o) const
 print method
 
void ScaleBoostWeight (Double_t s) const
 
void SetBoostWeight (Double_t w) const
 
void SetClass (UInt_t t)
 
void SetDoNotBoost () const
 
void SetSpectator (UInt_t ivar, Float_t value)
 set spectator value (dimension ivar) to value
 
void SetSpectatorTypes (const std::vector< char > &types)
 
void SetTarget (UInt_t itgt, Float_t value)
 set the target value (dimension itgt) to value
 
void SetVal (UInt_t ivar, Float_t val)
 set variable ivar to val
 
void SetVariableArrangement (std::vector< UInt_t > *const m) const
 set the variable arrangement
 
void SetWeight (Double_t w)
 
virtual void Streamer (TBuffer &)
 Stream an object of class 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 Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
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 const char * GetName () const
 Returns 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 const char * GetTitle () const
 Returns title of object.
 
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.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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
 
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.
 
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 void ClearDynamicVariables ()
 
static const char * DeclFileName ()
 
static void SetIgnoreNegWeightsInTraining (Bool_t)
 when this static function is called, it sets the flag whether events with negative event weight should be ignored in the training, or not.
 
static void SetIsTraining (Bool_t)
 when this static function is called, it sets the flag whether events with negative event weight should be ignored in the training, or not.
 
- 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 Attributes

Double_t fBoostWeight
 internal weight to be set by boosting algorithm
 
UInt_t fClass
 class number
 
Bool_t fDoNotBoost
 mark event as not to be boosted (used to compensate for events with negative event weights
 
Bool_t fDynamic
 is set when the dynamic values are taken
 
std::vector< Float_tfSpectators
 "visiting" variables not used in MVAs ; mutable, to be able to copy the dynamic values in there
 
std::vector< char > fSpectatorTypes
 type of the spectator variable (typically F or I). Used ony for dynamic events
 
std::vector< Float_tfTargets
 target values for regression
 
std::vector< Float_tfValues
 the event values ; mutable, to be able to copy the dynamic values in there
 
std::vector< Float_t * > * fValuesDynamic
 ! the event values
 
std::vector< Float_tfValuesRearranged
 the event values ; mutable, to be able to copy the dynamic values in there
 
std::vector< UInt_tfVariableArrangement
 needed for MethodCategories, where we can train on other than the main variables
 
Double_t fWeight
 event weight (product of global and individual weights)
 

Static Private Attributes

static Bool_t fgIgnoreNegWeightsInTraining = kFALSE
 
static Bool_t fgIsTraining = kFALSE
 

Friends

std::ostream & operator<< (std::ostream &os, const Event &event)
 

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

#include <TMVA/Event.h>

Inheritance diagram for TMVA::Event:
[legend]

Constructor & Destructor Documentation

◆ Event() [1/6]

TMVA::Event::Event ( )

copy constructor

Definition at line 48 of file Event.cxx.

◆ Event() [2/6]

TMVA::Event::Event ( const Event event)

copy constructor

Definition at line 146 of file Event.cxx.

◆ Event() [3/6]

TMVA::Event::Event ( const std::vector< Float_t > &  values,
const std::vector< Float_t > &  targetValues,
const std::vector< Float_t > &  spectatorValues,
UInt_t  theClass = 0,
Double_t  weight = 1.0,
Double_t  boostweight = 1.0 
)
explicit

constructor

Definition at line 86 of file Event.cxx.

◆ Event() [4/6]

TMVA::Event::Event ( const std::vector< Float_t > &  values,
const std::vector< Float_t > &  targetValues,
UInt_t  theClass = 0,
Double_t  weight = 1.0,
Double_t  boostweight = 1.0 
)
explicit

constructor

Definition at line 65 of file Event.cxx.

◆ Event() [5/6]

TMVA::Event::Event ( const std::vector< Float_t > &  ev,
UInt_t  theClass,
Double_t  weight = 1.0,
Double_t  boostweight = 1.0 
)
explicit

constructor

Definition at line 108 of file Event.cxx.

◆ Event() [6/6]

TMVA::Event::Event ( const std::vector< Float_t * > *&  evdyn,
UInt_t  nvar 
)
explicit

constructor for single events

Definition at line 128 of file Event.cxx.

◆ ~Event()

TMVA::Event::~Event ( )

Event destructor.

Definition at line 184 of file Event.cxx.

Member Function Documentation

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 153 of file Event.h.

◆ ClearDynamicVariables()

static void TMVA::Event::ClearDynamicVariables ( )
inlinestatic

Definition at line 122 of file Event.h.

◆ CopyVarValues()

void TMVA::Event::CopyVarValues ( const Event other)

copies only the variable values

Definition at line 203 of file Event.cxx.

◆ DeclFileName()

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

Definition at line 153 of file Event.h.

◆ GetBoostWeight()

Double_t TMVA::Event::GetBoostWeight ( ) const
inline

Definition at line 85 of file Event.h.

◆ GetClass()

UInt_t TMVA::Event::GetClass ( ) const
inline

Definition at line 86 of file Event.h.

◆ GetNSpectators()

UInt_t TMVA::Event::GetNSpectators ( ) const

accessor to the number of spectators

Definition at line 335 of file Event.cxx.

◆ GetNTargets()

UInt_t TMVA::Event::GetNTargets ( ) const

accessor to the number of targets

Definition at line 327 of file Event.cxx.

◆ GetNVariables()

UInt_t TMVA::Event::GetNVariables ( ) const

accessor to the number of variables

Definition at line 316 of file Event.cxx.

◆ GetOriginalWeight()

Double_t TMVA::Event::GetOriginalWeight ( ) const
inline

Definition at line 84 of file Event.h.

◆ GetSpectator()

Float_t TMVA::Event::GetSpectator ( UInt_t  ivar) const

return spectator content

Definition at line 261 of file Event.cxx.

◆ GetSpectators() [1/2]

std::vector< Float_t > & TMVA::Event::GetSpectators ( )
inline

Definition at line 107 of file Event.h.

◆ GetSpectators() [2/2]

const std::vector< Float_t > & TMVA::Event::GetSpectators ( ) const
inline

Definition at line 108 of file Event.h.

◆ GetTarget()

Float_t TMVA::Event::GetTarget ( UInt_t  itgt) const
inline

Definition at line 102 of file Event.h.

◆ GetTargets() [1/2]

std::vector< Float_t > & TMVA::Event::GetTargets ( )
inline

Definition at line 103 of file Event.h.

◆ GetTargets() [2/2]

const std::vector< Float_t > & TMVA::Event::GetTargets ( ) const
inline

Definition at line 104 of file Event.h.

◆ GetValue()

Float_t TMVA::Event::GetValue ( UInt_t  ivar) const

return value of i'th variable

Definition at line 236 of file Event.cxx.

◆ GetValueFast()

Float_t TMVA::Event::GetValueFast ( UInt_t  ivar) const
inline

Definition at line 93 of file Event.h.

◆ GetValues() [1/2]

std::vector< Float_t > & TMVA::Event::GetValues ( )
inline

Definition at line 94 of file Event.h.

◆ GetValues() [2/2]

const std::vector< Float_t > & TMVA::Event::GetValues ( ) const

return value vector

Definition at line 278 of file Event.cxx.

◆ GetWeight()

Double_t TMVA::Event::GetWeight ( ) const

return the event weight - depending on whether the flag IgnoreNegWeightsInTraining is or not.

If it is set AND it is used for training, then negative event weights are set to zero ! NOTE! For events used in Testing, the ORIGINAL possibly negative event weight is used no matter what

Definition at line 389 of file Event.cxx.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 153 of file Event.h.

◆ IsDynamic()

Bool_t TMVA::Event::IsDynamic ( ) const
inline

Definition at line 80 of file Event.h.

◆ operator=()

Event & TMVA::Event::operator= ( const Event )
default

◆ Print() [1/2]

void TObject::Print ( Option_t option = "") const
virtual

This method must be overridden when a class wants to print itself.

Reimplemented from TObject.

Definition at line 159 of file TObject.cxx.

◆ Print() [2/2]

void TMVA::Event::Print ( std::ostream &  o) const

print method

Definition at line 359 of file Event.cxx.

◆ ScaleBoostWeight()

void TMVA::Event::ScaleBoostWeight ( Double_t  s) const
inline

Definition at line 112 of file Event.h.

◆ SetBoostWeight()

void TMVA::Event::SetBoostWeight ( Double_t  w) const
inline

Definition at line 111 of file Event.h.

◆ SetClass()

void TMVA::Event::SetClass ( UInt_t  t)
inline

Definition at line 113 of file Event.h.

◆ SetDoNotBoost()

void TMVA::Event::SetDoNotBoost ( ) const
inline

Definition at line 121 of file Event.h.

◆ SetIgnoreNegWeightsInTraining()

void TMVA::Event::SetIgnoreNegWeightsInTraining ( Bool_t  b)
static

when this static function is called, it sets the flag whether events with negative event weight should be ignored in the training, or not.

Definition at line 408 of file Event.cxx.

◆ SetIsTraining()

void TMVA::Event::SetIsTraining ( Bool_t  b)
static

when this static function is called, it sets the flag whether events with negative event weight should be ignored in the training, or not.

Definition at line 399 of file Event.cxx.

◆ SetSpectator()

void TMVA::Event::SetSpectator ( UInt_t  ivar,
Float_t  value 
)

set spectator value (dimension ivar) to value

Definition at line 376 of file Event.cxx.

◆ SetSpectatorTypes()

void TMVA::Event::SetSpectatorTypes ( const std::vector< char > &  types)
inline

Definition at line 119 of file Event.h.

◆ SetTarget()

void TMVA::Event::SetTarget ( UInt_t  itgt,
Float_t  value 
)

set the target value (dimension itgt) to value

Definition at line 367 of file Event.cxx.

◆ SetVal()

void TMVA::Event::SetVal ( UInt_t  ivar,
Float_t  val 
)

set variable ivar to val

Definition at line 348 of file Event.cxx.

◆ SetVariableArrangement()

void TMVA::Event::SetVariableArrangement ( std::vector< UInt_t > *const  m) const

set the variable arrangement

Definition at line 191 of file Event.cxx.

◆ SetWeight()

void TMVA::Event::SetWeight ( Double_t  w)
inline

Definition at line 110 of file Event.h.

◆ Streamer()

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

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

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

Definition at line 153 of file Event.h.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const Event event 
)
friend

Member Data Documentation

◆ fBoostWeight

Double_t TMVA::Event::fBoostWeight
mutableprivate

internal weight to be set by boosting algorithm

Definition at line 148 of file Event.h.

◆ fClass

UInt_t TMVA::Event::fClass
private

class number

Definition at line 146 of file Event.h.

◆ fDoNotBoost

Bool_t TMVA::Event::fDoNotBoost
mutableprivate

mark event as not to be boosted (used to compensate for events with negative event weights

Definition at line 150 of file Event.h.

◆ fDynamic

Bool_t TMVA::Event::fDynamic
private

is set when the dynamic values are taken

Definition at line 149 of file Event.h.

◆ fgIgnoreNegWeightsInTraining

Bool_t TMVA::Event::fgIgnoreNegWeightsInTraining = kFALSE
staticprivate

Definition at line 134 of file Event.h.

◆ fgIsTraining

Bool_t TMVA::Event::fgIsTraining = kFALSE
staticprivate

Definition at line 133 of file Event.h.

◆ fSpectators

std::vector<Float_t> TMVA::Event::fSpectators
mutableprivate

"visiting" variables not used in MVAs ; mutable, to be able to copy the dynamic values in there

Definition at line 142 of file Event.h.

◆ fSpectatorTypes

std::vector<char> TMVA::Event::fSpectatorTypes
private

type of the spectator variable (typically F or I). Used ony for dynamic events

Definition at line 144 of file Event.h.

◆ fTargets

std::vector<Float_t> TMVA::Event::fTargets
private

target values for regression

Definition at line 141 of file Event.h.

◆ fValues

std::vector<Float_t> TMVA::Event::fValues
mutableprivate

the event values ; mutable, to be able to copy the dynamic values in there

Definition at line 137 of file Event.h.

◆ fValuesDynamic

std::vector<Float_t*>* TMVA::Event::fValuesDynamic
mutableprivate

! the event values

Definition at line 140 of file Event.h.

◆ fValuesRearranged

std::vector<Float_t> TMVA::Event::fValuesRearranged
mutableprivate

the event values ; mutable, to be able to copy the dynamic values in there

Definition at line 139 of file Event.h.

◆ fVariableArrangement

std::vector<UInt_t> TMVA::Event::fVariableArrangement
mutableprivate

needed for MethodCategories, where we can train on other than the main variables

Definition at line 143 of file Event.h.

◆ fWeight

Double_t TMVA::Event::fWeight
private

event weight (product of global and individual weights)

Definition at line 147 of file Event.h.

Libraries for TMVA::Event:

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