Logo ROOT  
Reference Guide
Event.h
Go to the documentation of this file.
1// @(#)root/tmva $Id$
2// Author: Andreas Hoecker, Peter Speckmayer, Joerg Stelzer, Helge Voss, Jan Therhaag
3
4/**********************************************************************************
5 * Project: TMVA - a Root-integrated toolkit for multivariate data analysis *
6 * Package: TMVA *
7 * Class : Event *
8 * Web : http://tmva.sourceforge.net *
9 * *
10 * Description: *
11 * Event container *
12 * *
13 * Authors (alphabetical): *
14 * Andreas Hoecker <Andreas.Hocker@cern.ch> - CERN, Switzerland *
15 * Joerg Stelzer <Joerg.Stelzer@cern.ch> - CERN, Switzerland *
16 * Peter Speckmayer <Peter.Speckmayer@cern.ch> - CERN, Switzerland *
17 * Jan Therhaag <Jan.Therhaag@cern.ch> - U of Bonn, Germany *
18 * Helge Voss <Helge.Voss@cern.ch> - MPI-K Heidelberg, Germany *
19 * *
20 * Copyright (c) 2005-2011: *
21 * CERN, Switzerland *
22 * U. of Victoria, Canada *
23 * MPI-K Heidelberg, Germany *
24 * U. of Bonn, Germany *
25 * *
26 * Redistribution and use in source and binary forms, with or without *
27 * modification, are permitted according to the terms listed in LICENSE *
28 * (http://mva.sourceforge.net/license.txt) *
29 **********************************************************************************/
30
31#ifndef ROOT_TMVA_Event
32#define ROOT_TMVA_Event
33
34#include <iosfwd>
35#include <vector>
36
37#include "Rtypes.h"
38#include "TMVA/Types.h"
39
40#include "TObject.h"
41
42
43class TCut;
44
45namespace TMVA {
46
47 class Event;
48
49 std::ostream& operator<<( std::ostream& os, const Event& event );
50
51 class Event:public TObject {
52
53 friend std::ostream& operator<<( std::ostream& os, const Event& event );
54
55 public:
56
57 // constructors
58 Event();
59 Event( const Event& );
60 explicit Event( const std::vector<Float_t>& values,
61 const std::vector<Float_t>& targetValues,
62 const std::vector<Float_t>& spectatorValues,
63 UInt_t theClass = 0, Double_t weight = 1.0, Double_t boostweight = 1.0 );
64 explicit Event( const std::vector<Float_t>& values,
65 const std::vector<Float_t>& targetValues,
66 UInt_t theClass = 0, Double_t weight = 1.0, Double_t boostweight = 1.0 );
67 explicit Event( const std::vector<Float_t>&,
68 UInt_t theClass, Double_t weight = 1.0, Double_t boostweight = 1.0 );
69 explicit Event( const std::vector<Float_t*>*&, UInt_t nvar );
70
71 ~Event();
72
73 // operators
74 // NOTE: Because we do not want to change the behaviour of the Event class
75 // as a public interface, we use the explicit default assignment operator,
76 // which is similar to the implicit one but silences gcc9 warnings.
77 Event& operator=( const Event& ) = default;
78
79 // accessors
80 Bool_t IsDynamic() const {return fDynamic; }
81
82 // Double_t GetWeight() const { return fWeight*fBoostWeight; }
83 Double_t GetWeight() const;
86 UInt_t GetClass() const { return fClass; }
87
88 UInt_t GetNVariables() const;
89 UInt_t GetNTargets() const;
90 UInt_t GetNSpectators() const;
91
92 Float_t GetValue( UInt_t ivar) const;
93 Float_t GetValueFast(UInt_t ivar) const { return fDynamic ? *(*fValuesDynamic)[ivar] : fValues[ivar]; }
94 std::vector<Float_t>& GetValues()
95 {
96 //For a detailed explanation, please see the heading "Avoid Duplication in const and Non-const Member Function," on p. 23, in Item 3 "Use const whenever possible," in Effective C++, 3d ed by Scott Meyers, ISBN-13: 9780321334879.
97 // http://stackoverflow.com/questions/123758/how-do-i-remove-code-duplication-between-similar-const-and-non-const-member-func
98 return const_cast<std::vector<Float_t>&>( static_cast<const Event&>(*this).GetValues() );
99 }
100 const std::vector<Float_t>& GetValues() const;
101
102 Float_t GetTarget( UInt_t itgt ) const { return fTargets.at(itgt); }
103 std::vector<Float_t>& GetTargets() { return fTargets; }
104 const std::vector<Float_t>& GetTargets() const { return fTargets; }
105
106 Float_t GetSpectator( UInt_t ivar) const;
107 std::vector<Float_t>& GetSpectators() { return fSpectators; }
108 const std::vector<Float_t>& GetSpectators() const { return fSpectators; }
109
110 void SetWeight ( Double_t w ) { fWeight=w; }
113 void SetClass ( UInt_t t ) { fClass=t; }
114 void SetVal ( UInt_t ivar, Float_t val );
115 void SetTarget ( UInt_t itgt, Float_t value );
116 void SetSpectator ( UInt_t ivar, Float_t value );
117 void SetVariableArrangement( std::vector<UInt_t>* const m ) const;
118
119 void SetDoNotBoost () const { fDoNotBoost = kTRUE; }
120 static void ClearDynamicVariables() {}
121
122 void CopyVarValues( const Event& other );
123 using TObject::Print;
124 void Print ( std::ostream & o ) const;
125
126 static void SetIsTraining(Bool_t);
128
129 private:
130
131 static Bool_t fgIsTraining; // mark if we are in an actual training or "evaluation/testing" phase --> ignoreNegWeights only in actual training !
133
134
135 mutable std::vector<Float_t> fValues; // the event values ; mutable, to be able to copy the dynamic values in there
136
137 mutable std::vector<Float_t> fValuesRearranged; // the event values ; mutable, to be able to copy the dynamic values in there
138 mutable std::vector<Float_t*> *fValuesDynamic; //! the event values
139 std::vector<Float_t> fTargets; // target values for regression
140 mutable std::vector<Float_t> fSpectators; // "visisting" variables not used in MVAs ; mutable, to be able to copy the dynamic values in there
141 mutable std::vector<UInt_t> fVariableArrangement; // needed for MethodCategories, where we can train on other than the main variables
142
143 UInt_t fClass; // class number
144 Double_t fWeight; // event weight (product of global and individual weights)
145 mutable Double_t fBoostWeight; // internal weight to be set by boosting algorithm
146 Bool_t fDynamic; // is set when the dynamic values are taken
147 mutable Bool_t fDoNotBoost; // mark event as not to be boosted (used to compensate for events with negative event weights
148 public:
149
150 ClassDef(Event,1);
151
152 };
153}
154
155#endif
unsigned int UInt_t
Definition: RtypesCore.h:46
const Bool_t kFALSE
Definition: RtypesCore.h:101
bool Bool_t
Definition: RtypesCore.h:63
double Double_t
Definition: RtypesCore.h:59
float Float_t
Definition: RtypesCore.h:57
const Bool_t kTRUE
Definition: RtypesCore.h:100
#define ClassDef(name, id)
Definition: Rtypes.h:325
A specialized string object used for TTree selections.
Definition: TCut.h:25
std::vector< Float_t > fValues
Definition: Event.h:135
void ScaleBoostWeight(Double_t s) const
Definition: Event.h:112
static Bool_t fgIsTraining
Definition: Event.h:131
Double_t fWeight
Definition: Event.h:144
void SetBoostWeight(Double_t w) const
Definition: Event.h:111
Float_t GetValue(UInt_t ivar) const
return value of i'th variable
Definition: Event.cxx:236
void SetTarget(UInt_t itgt, Float_t value)
set the target value (dimension itgt) to value
Definition: Event.cxx:359
std::vector< Float_t > fTargets
the event values
Definition: Event.h:139
Double_t fBoostWeight
Definition: Event.h:145
std::vector< Float_t > & GetTargets()
Definition: Event.h:103
static void ClearDynamicVariables()
Definition: Event.h:120
Bool_t fDynamic
Definition: Event.h:146
std::vector< Float_t > fSpectators
Definition: Event.h:140
UInt_t GetNSpectators() const
accessor to the number of spectators
Definition: Event.cxx:327
std::vector< UInt_t > fVariableArrangement
Definition: Event.h:141
void SetWeight(Double_t w)
Definition: Event.h:110
Double_t GetOriginalWeight() const
Definition: Event.h:84
~Event()
Event destructor.
Definition: Event.cxx:184
std::vector< Float_t > & GetSpectators()
Definition: Event.h:107
std::vector< Float_t * > * fValuesDynamic
Definition: Event.h:138
void SetDoNotBoost() const
Definition: Event.h:119
Event()
copy constructor
Definition: Event.cxx:48
UInt_t GetNVariables() const
accessor to the number of variables
Definition: Event.cxx:308
Event & operator=(const Event &)=default
void CopyVarValues(const Event &other)
copies only the variable values
Definition: Event.cxx:203
const std::vector< Float_t > & GetSpectators() const
Definition: Event.h:108
UInt_t GetNTargets() const
accessor to the number of targets
Definition: Event.cxx:319
static Bool_t fgIgnoreNegWeightsInTraining
Definition: Event.h:132
const std::vector< Float_t > & GetTargets() const
Definition: Event.h:104
Double_t GetWeight() const
return the event weight - depending on whether the flag IgnoreNegWeightsInTraining is or not.
Definition: Event.cxx:381
void SetVal(UInt_t ivar, Float_t val)
set variable ivar to val
Definition: Event.cxx:340
friend std::ostream & operator<<(std::ostream &os, const Event &event)
static void SetIsTraining(Bool_t)
when this static function is called, it sets the flag whether events with negative event weight shoul...
Definition: Event.cxx:391
void SetVariableArrangement(std::vector< UInt_t > *const m) const
set the variable arrangement
Definition: Event.cxx:191
Float_t GetSpectator(UInt_t ivar) const
return spectator content
Definition: Event.cxx:261
Bool_t IsDynamic() const
Definition: Event.h:80
UInt_t GetClass() const
Definition: Event.h:86
void SetClass(UInt_t t)
Definition: Event.h:113
Double_t GetBoostWeight() const
Definition: Event.h:85
void SetSpectator(UInt_t ivar, Float_t value)
set spectator value (dimension ivar) to value
Definition: Event.cxx:368
Float_t GetValueFast(UInt_t ivar) const
Definition: Event.h:93
Bool_t fDoNotBoost
Definition: Event.h:147
std::vector< Float_t > fValuesRearranged
Definition: Event.h:137
std::vector< Float_t > & GetValues()
Definition: Event.h:94
Float_t GetTarget(UInt_t itgt) const
Definition: Event.h:102
static void SetIgnoreNegWeightsInTraining(Bool_t)
when this static function is called, it sets the flag whether events with negative event weight shoul...
Definition: Event.cxx:400
void Print(std::ostream &o) const
print method
Definition: Event.cxx:351
UInt_t fClass
Definition: Event.h:143
Mother of all ROOT objects.
Definition: TObject.h:37
virtual void Print(Option_t *option="") const
This method must be overridden when a class wants to print itself.
Definition: TObject.cxx:552
static constexpr double s
create variable transformations
std::ostream & operator<<(std::ostream &os, const BinaryTree &tree)
Short_t Max(Short_t a, Short_t b)
Definition: TMathBase.h:208
auto * m
Definition: textangle.C:8