Logo ROOT   6.12/07
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 "ThreadLocalStorage.h"
39 #include "TMVA/Types.h"
40 
41 #include "TObject.h"
42 
43 
44 class TCut;
45 
46 namespace TMVA {
47 
48  class Event;
49 
50  std::ostream& operator<<( std::ostream& os, const Event& event );
51 
52  class Event:public TObject {
53 
54  friend std::ostream& operator<<( std::ostream& os, const Event& event );
55 
56  public:
57 
58  // constructors
59  Event();
60  Event( const Event& );
61  explicit Event( const std::vector<Float_t>& values,
62  const std::vector<Float_t>& targetValues,
63  const std::vector<Float_t>& spectatorValues,
64  UInt_t theClass = 0, Double_t weight = 1.0, Double_t boostweight = 1.0 );
65  explicit Event( const std::vector<Float_t>& values,
66  const std::vector<Float_t>& targetValues,
67  UInt_t theClass = 0, Double_t weight = 1.0, Double_t boostweight = 1.0 );
68  explicit Event( const std::vector<Float_t>&,
69  UInt_t theClass, Double_t weight = 1.0, Double_t boostweight = 1.0 );
70  explicit Event( const std::vector<Float_t*>*&, UInt_t nvar );
71 
72  ~Event();
73 
74  // accessors
75  Bool_t IsDynamic() const {return fDynamic; }
76 
77  // Double_t GetWeight() const { return fWeight*fBoostWeight; }
78  Double_t GetWeight() const;
79  Double_t GetOriginalWeight() const { return fWeight; }
81  UInt_t GetClass() const { return fClass; }
82 
83  UInt_t GetNVariables() const;
84  UInt_t GetNTargets() const;
85  UInt_t GetNSpectators() const;
86 
87  Float_t GetValue( UInt_t ivar) const;
88  Float_t GetValueFast(UInt_t ivar) const { return fDynamic ? *(*fValuesDynamic)[ivar] : fValues[ivar]; }
89  std::vector<Float_t>& GetValues()
90  {
91  //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.
92  // http://stackoverflow.com/questions/123758/how-do-i-remove-code-duplication-between-similar-const-and-non-const-member-func
93  return const_cast<std::vector<Float_t>&>( static_cast<const Event&>(*this).GetValues() );
94  }
95  const std::vector<Float_t>& GetValues() const;
96 
97  Float_t GetTarget( UInt_t itgt ) const { return fTargets.at(itgt); }
98  std::vector<Float_t>& GetTargets() { return fTargets; }
99  const std::vector<Float_t>& GetTargets() const { return fTargets; }
100 
101  Float_t GetSpectator( UInt_t ivar) const;
102  std::vector<Float_t>& GetSpectators() { return fSpectators; }
103  const std::vector<Float_t>& GetSpectators() const { return fSpectators; }
104 
105  void SetWeight ( Double_t w ) { fWeight=w; }
108  void SetClass ( UInt_t t ) { fClass=t; }
109  void SetVal ( UInt_t ivar, Float_t val );
110  void SetTarget ( UInt_t itgt, Float_t value );
111  void SetSpectator ( UInt_t ivar, Float_t value );
112  void SetVariableArrangement( std::vector<UInt_t>* const m ) const;
113 
114  void SetDoNotBoost () const { fDoNotBoost = kTRUE; }
115  static void ClearDynamicVariables() {}
116 
117  void CopyVarValues( const Event& other );
118  using TObject::Print;
119  void Print ( std::ostream & o ) const;
120 
121  static void SetIsTraining(Bool_t);
123 
124  private:
125 
126  static Bool_t fgIsTraining; // mark if we are in an actual training or "evaluation/testing" phase --> ignoreNegWeights only in actual training !
128 
129 
130  mutable std::vector<Float_t> fValues; // the event values ; mutable, to be able to copy the dynamic values in there
131 
132  mutable std::vector<Float_t> fValuesRearranged; // the event values ; mutable, to be able to copy the dynamic values in there
133  mutable std::vector<Float_t*> *fValuesDynamic; //! the event values
134  std::vector<Float_t> fTargets; // target values for regression
135  mutable std::vector<Float_t> fSpectators; // "visisting" variables not used in MVAs ; mutable, to be able to copy the dynamic values in there
136  mutable std::vector<UInt_t> fVariableArrangement; // needed for MethodCategories, where we can train on other than the main variables
137 
138  UInt_t fClass; // class number
139  Double_t fWeight; // event weight (product of global and individual weights)
140  mutable Double_t fBoostWeight; // internal weight to be set by boosting algorithm
141  Bool_t fDynamic; // is set when the dynamic values are taken
142  mutable Bool_t fDoNotBoost; // mark event as not to be boosted (used to compensate for events with negative event weights
143  public:
144 
145  ClassDef(Event,1);
146 
147  };
148 }
149 
150 #endif
Float_t GetValueFast(UInt_t ivar) const
Definition: Event.h:88
Bool_t fDoNotBoost
Definition: Event.h:142
void SetDoNotBoost() const
Definition: Event.h:114
void SetClass(UInt_t t)
Definition: Event.h:108
UInt_t fClass
Definition: Event.h:138
auto * m
Definition: textangle.C:8
float Float_t
Definition: RtypesCore.h:53
std::vector< Float_t > fValues
Definition: Event.h:130
std::vector< Float_t * > * fValuesDynamic
Definition: Event.h:133
static void ClearDynamicVariables()
Definition: Event.h:115
std::vector< Float_t > fSpectators
Definition: Event.h:135
bool Bool_t
Definition: RtypesCore.h:59
static Bool_t fgIgnoreNegWeightsInTraining
Definition: Event.h:127
Double_t fBoostWeight
Definition: Event.h:140
virtual void Print(Option_t *option="") const
This method must be overridden when a class wants to print itself.
Definition: TObject.cxx:550
Event()
copy constructor
Definition: Event.cxx:49
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:392
#define ClassDef(name, id)
Definition: Rtypes.h:320
UInt_t GetClass() const
Definition: Event.h:81
void SetVariableArrangement(std::vector< UInt_t > *const m) const
set the variable arrangement
Definition: Event.cxx:192
Double_t fWeight
Definition: Event.h:139
void SetVal(UInt_t ivar, Float_t val)
set variable ivar to val
Definition: Event.cxx:341
Double_t GetWeight() const
return the event weight - depending on whether the flag IgnoreNegWeightsInTraining is or not...
Definition: Event.cxx:382
UInt_t GetNTargets() const
accessor to the number of targets
Definition: Event.cxx:320
std::vector< UInt_t > fVariableArrangement
Definition: Event.h:136
std::vector< Float_t > & GetTargets()
Definition: Event.h:98
A specialized string object used for TTree selections.
Definition: TCut.h:25
Bool_t fDynamic
Definition: Event.h:141
Double_t GetBoostWeight() const
Definition: Event.h:80
Float_t GetTarget(UInt_t itgt) const
Definition: Event.h:97
std::vector< Float_t > fTargets
the event values
Definition: Event.h:134
void SetSpectator(UInt_t ivar, Float_t value)
set spectator value (dimension ivar) to value
Definition: Event.cxx:369
const std::vector< Float_t > & GetTargets() const
Definition: Event.h:99
UInt_t GetNSpectators() const
accessor to the number of spectators
Definition: Event.cxx:328
static Bool_t fgIsTraining
Definition: Event.h:126
std::vector< Float_t > & GetSpectators()
Definition: Event.h:102
unsigned int UInt_t
Definition: RtypesCore.h:42
std::ostream & operator<<(std::ostream &os, const BinaryTree &tree)
void ScaleBoostWeight(Double_t s) const
Definition: Event.h:107
void SetTarget(UInt_t itgt, Float_t value)
set the target value (dimension itgt) to value
Definition: Event.cxx:360
void Print(std::ostream &o) const
print method
Definition: Event.cxx:352
UInt_t GetNVariables() const
accessor to the number of variables
Definition: Event.cxx:309
const Bool_t kFALSE
Definition: RtypesCore.h:88
Float_t GetValue(UInt_t ivar) const
return value of i&#39;th variable
Definition: Event.cxx:237
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:401
double Double_t
Definition: RtypesCore.h:55
void SetBoostWeight(Double_t w) const
Definition: Event.h:106
void CopyVarValues(const Event &other)
copies only the variable values
Definition: Event.cxx:204
static constexpr double s
std::vector< Float_t > fValuesRearranged
Definition: Event.h:132
const std::vector< Float_t > & GetSpectators() const
Definition: Event.h:103
void SetWeight(Double_t w)
Definition: Event.h:105
friend std::ostream & operator<<(std::ostream &os, const Event &event)
Mother of all ROOT objects.
Definition: TObject.h:37
~Event()
Event destructor.
Definition: Event.cxx:185
Abstract ClassifierFactory template that handles arbitrary types.
std::vector< Float_t > & GetValues()
Definition: Event.h:89
Short_t Max(Short_t a, Short_t b)
Definition: TMathBase.h:200
Double_t GetOriginalWeight() const
Definition: Event.h:79
Float_t GetSpectator(UInt_t ivar) const
return spectator content
Definition: Event.cxx:262
const Bool_t kTRUE
Definition: RtypesCore.h:87
Bool_t IsDynamic() const
Definition: Event.h:75