ROOT  6.06/09
Reference Guide
Public Member Functions | Private Member Functions | Private Attributes | List of all members
TMVA::VariablePCATransform Class Reference

Definition at line 50 of file VariablePCATransform.h.

Public Member Functions

 VariablePCATransform (DataSetInfo &dsi)
 
virtual ~VariablePCATransform (void)
 destructor More...
 
void Initialize ()
 initialization of the transformation. More...
 
Bool_t PrepareTransformation (const std::vector< Event * > &)
 calculate the principal components using the ROOT class TPrincipal and the normalization More...
 
virtual const EventTransform (const Event *const, Int_t cls) const
 apply the principal component analysis More...
 
virtual const EventInverseTransform (const Event *const, Int_t cls) const
 apply the principal component analysis TODO: implementation of inverse transformation Log() << kFATAL << "Inverse transformation for PCA transformation not yet implemented. Hence, this transformation cannot be applied together with regression. Please contact the authors if necessary." << Endl; More...
 
void WriteTransformationToStream (std::ostream &) const
 write mean values to stream More...
 
void ReadTransformationFromStream (std::istream &, const TString &)
 Read mean values from input stream. More...
 
virtual void AttachXMLTo (void *parent)
 create XML description of PCA transformation More...
 
virtual void ReadFromXML (void *trfnode)
 Read the transformation matrices from the xml node. More...
 
virtual void MakeFunction (std::ostream &fout, const TString &fncName, Int_t part, UInt_t trCounter, Int_t cls)
 creates C++ code fragment of the PCA transform for inclusion in standalone C++ class More...
 
- Public Member Functions inherited from TMVA::VariableTransformBase
 VariableTransformBase (DataSetInfo &dsi, Types::EVariableTransform tf, const TString &trfName)
 
virtual ~VariableTransformBase (void)
 
void SetEnabled (Bool_t e)
 
void SetNormalise (Bool_t n)
 
Bool_t IsEnabled () const
 
Bool_t IsCreated () const
 
Bool_t IsNormalised () const
 
virtual void SelectInput (const TString &inputVariables, Bool_t putIntoVariables=kFALSE)
 select the variables/targets/spectators which serve as input to the transformation More...
 
virtual Bool_t GetInput (const Event *event, std::vector< Float_t > &input, std::vector< Char_t > &mask, Bool_t backTransform=kFALSE) const
 select the values from the event More...
 
virtual void SetOutput (Event *event, std::vector< Float_t > &output, std::vector< Char_t > &mask, const Event *oldEvent=0, Bool_t backTransform=kFALSE) const
 select the values from the event More...
 
virtual void CountVariableTypes (UInt_t &nvars, UInt_t &ntgts, UInt_t &nspcts) const
 count variables, targets and spectators More...
 
void ToggleInputSortOrder (Bool_t sortOrder)
 
void SetOutputDataSetInfo (DataSetInfo *outputDsi)
 
void SetUseSignalTransform (Bool_t e=kTRUE)
 
Bool_t UseSignalTransform () const
 
virtual const char * GetName () const
 Returns name of object. More...
 
TString GetShortName () const
 
Types::EVariableTransform GetVariableTransform () const
 
virtual std::vector< TString > * GetTransformationStrings (Int_t cls) const
 TODO –> adapt to variable,target,spectator selection default transformation output –> only indicate that transformation occurred. More...
 
virtual void PrintTransformation (std::ostream &)
 
const std::vector< TMVA::VariableInfo > & Variables () const
 
const std::vector< TMVA::VariableInfo > & Targets () const
 
const std::vector< TMVA::VariableInfo > & Spectators () const
 
MsgLoggerLog () const
 
void SetTMVAVersion (TMVAVersion_t v)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsSortable () const
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
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). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Private Member Functions

void CalculatePrincipalComponents (const std::vector< Event * > &)
 calculate the principal components for the signal and the background data it uses the MakePrincipal method of ROOT's TPrincipal class More...
 
void X2P (std::vector< Float_t > &, const std::vector< Float_t > &, Int_t cls) const
 Calculate the principal components from the original data vector x, and return it in p (function extracted from TPrincipal::X2P) It's the users responsibility to make sure that both x and p are of the right size (i.e., memory must be allocated for p) More...
 
void P2X (std::vector< Float_t > &, const std::vector< Float_t > &, Int_t cls) const
 Perform the back-transformation from the principal components pc, and return x It's the users responsibility to make sure that both x and pc are of the right size (i.e., memory must be allocated for p) More...
 

Private Attributes

std::vector< TVectorD * > fMeanValues
 
std::vector< TMatrixD * > fEigenVectors
 

Additional Inherited Members

- Public Types inherited from TMVA::VariableTransformBase
typedef std::vector< std::pair< Char_t, UInt_t > > VectorOfCharAndInt
 
typedef VectorOfCharAndInt::iterator ItVarTypeIdx
 
typedef VectorOfCharAndInt::const_iterator ItVarTypeIdxConst
 
- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TMVA::VariableTransformBase
void CalcNorm (const std::vector< const Event * > &)
 TODO –> adapt to variable,target,spectator selection method to calculate minimum, maximum, mean, and RMS for all variables used in the MVA. More...
 
void SetCreated (Bool_t c=kTRUE)
 
void SetNVariables (UInt_t i)
 
void SetName (const TString &c)
 
UInt_t GetNVariables () const
 
UInt_t GetNTargets () const
 
UInt_t GetNSpectators () const
 
std::vector< TMVA::VariableInfo > & Variables ()
 
std::vector< TMVA::VariableInfo > & Targets ()
 
std::vector< TMVA::VariableInfo > & Spectators ()
 
Int_t GetNClasses () const
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
- Protected Attributes inherited from TMVA::VariableTransformBase
DataSetInfofDsi
 
DataSetInfofDsiOutput
 
EventfTransformedEvent
 
EventfBackTransformedEvent
 
VectorOfCharAndInt fGet
 
VectorOfCharAndInt fPut
 
TMVAVersion_t fTMVAVersion
 
MsgLoggerfLogger
 

#include <TMVA/VariablePCATransform.h>

+ Inheritance diagram for TMVA::VariablePCATransform:
+ Collaboration diagram for TMVA::VariablePCATransform:

Constructor & Destructor Documentation

TMVA::VariablePCATransform::VariablePCATransform ( DataSetInfo dsi)
TMVA::VariablePCATransform::~VariablePCATransform ( void  )
virtual

destructor

Definition at line 61 of file VariablePCATransform.cxx.

Member Function Documentation

void TMVA::VariablePCATransform::AttachXMLTo ( void parent)
virtual

create XML description of PCA transformation

Implements TMVA::VariableTransformBase.

Definition at line 338 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::CalculatePrincipalComponents ( const std::vector< Event * > &  events)
private

calculate the principal components for the signal and the background data it uses the MakePrincipal method of ROOT's TPrincipal class

Definition at line 200 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::Initialize ( )
virtual

initialization of the transformation.

Has to be called in the preparation and not in the constructor, since the number of classes it not known at construction, but only after the creation of the DataSet which might be later.

Implements TMVA::VariableTransformBase.

Definition at line 75 of file VariablePCATransform.cxx.

const TMVA::Event * TMVA::VariablePCATransform::InverseTransform ( const Event * const  ev,
Int_t  cls 
) const
virtual

apply the principal component analysis TODO: implementation of inverse transformation Log() << kFATAL << "Inverse transformation for PCA transformation not yet implemented. Hence, this transformation cannot be applied together with regression. Please contact the authors if necessary." << Endl;

Implements TMVA::VariableTransformBase.

Definition at line 170 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::MakeFunction ( std::ostream &  fout,
const TString fncName,
Int_t  part,
UInt_t  trCounter,
Int_t  cls 
)
virtual

creates C++ code fragment of the PCA transform for inclusion in standalone C++ class

Implements TMVA::VariableTransformBase.

Definition at line 523 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::P2X ( std::vector< Float_t > &  x,
const std::vector< Float_t > &  pc,
Int_t  cls 
) const
private

Perform the back-transformation from the principal components pc, and return x It's the users responsibility to make sure that both x and pc are of the right size (i.e., memory must be allocated for p)

Definition at line 291 of file VariablePCATransform.cxx.

Bool_t TMVA::VariablePCATransform::PrepareTransformation ( const std::vector< Event * > &  events)
virtual

calculate the principal components using the ROOT class TPrincipal and the normalization

Implements TMVA::VariableTransformBase.

Definition at line 83 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::ReadFromXML ( void trfnode)
virtual

Read the transformation matrices from the xml node.

Implements TMVA::VariableTransformBase.

Definition at line 376 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::ReadTransformationFromStream ( std::istream &  istr,
const TString classname 
)
virtual

Read mean values from input stream.

Implements TMVA::VariableTransformBase.

Definition at line 442 of file VariablePCATransform.cxx.

const TMVA::Event * TMVA::VariablePCATransform::Transform ( const Event * const  ev,
Int_t  cls 
) const
virtual

apply the principal component analysis

Implements TMVA::VariableTransformBase.

Definition at line 121 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::WriteTransformationToStream ( std::ostream &  o) const
virtual

write mean values to stream

Implements TMVA::VariableTransformBase.

Definition at line 307 of file VariablePCATransform.cxx.

void TMVA::VariablePCATransform::X2P ( std::vector< Float_t > &  pc,
const std::vector< Float_t > &  x,
Int_t  cls 
) const
private

Calculate the principal components from the original data vector x, and return it in p (function extracted from TPrincipal::X2P) It's the users responsibility to make sure that both x and p are of the right size (i.e., memory must be allocated for p)

Definition at line 272 of file VariablePCATransform.cxx.

Member Data Documentation

std::vector<TMatrixD*> TMVA::VariablePCATransform::fEigenVectors
private

Definition at line 80 of file VariablePCATransform.h.

Referenced by ~VariablePCATransform().

std::vector<TVectorD*> TMVA::VariablePCATransform::fMeanValues
private

Definition at line 79 of file VariablePCATransform.h.

Referenced by ~VariablePCATransform().


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