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

Linear interpolation class.

Definition at line 48 of file VariablePCATransform.h.

Public Member Functions

 VariablePCATransform (DataSetInfo &dsi)
 constructor
 
virtual ~VariablePCATransform (void)
 destructor
 
virtual void AttachXMLTo (void *parent)
 create XML description of PCA transformation
 
void Initialize ()
 initialization of the transformation.
 
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;
 
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
 
Bool_t PrepareTransformation (const std::vector< Event * > &)
 calculate the principal components using the ROOT class TPrincipal and the normalization
 
virtual void ReadFromXML (void *trfnode)
 Read the transformation matrices from the xml node.
 
void ReadTransformationFromStream (std::istream &, const TString &)
 Read mean values from input stream.
 
virtual const EventTransform (const Event *const, Int_t cls) const
 apply the principal component analysis
 
void WriteTransformationToStream (std::ostream &) const
 write mean values to stream
 
- Public Member Functions inherited from TMVA::VariableTransformBase
 VariableTransformBase (DataSetInfo &dsi, Types::EVariableTransform tf, const TString &trfName)
 standard constructor
 
virtual ~VariableTransformBase (void)
 
virtual void CountVariableTypes (UInt_t &nvars, UInt_t &ntgts, UInt_t &nspcts) const
 count variables, targets and spectators
 
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
 
virtual const char * GetName () const
 Returns name of object.
 
TString GetShortName () 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.
 
Types::EVariableTransform GetVariableTransform () const
 
Bool_t IsCreated () const
 
Bool_t IsEnabled () const
 
Bool_t IsNormalised () const
 
MsgLoggerLog () const
 
virtual void PrintTransformation (std::ostream &)
 
virtual void SelectInput (const TString &inputVariables, Bool_t putIntoVariables=kFALSE)
 select the variables/targets/spectators which serve as input to the transformation
 
void SetEnabled (Bool_t e)
 
void SetNormalise (Bool_t n)
 
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
 
void SetOutputDataSetInfo (DataSetInfo *outputDsi)
 
void SetTMVAVersion (TMVAVersion_t v)
 
void SetUseSignalTransform (Bool_t e=kTRUE)
 
const std::vector< TMVA::VariableInfo > & Spectators () const
 
const std::vector< TMVA::VariableInfo > & Targets () const
 
void ToggleInputSortOrder (Bool_t sortOrder)
 
Bool_t UseSignalTransform () const
 
const std::vector< TMVA::VariableInfo > & Variables () const
 
- 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 for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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 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.
 
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)
 Operator delete [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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 void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
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.
 
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

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

Private Attributes

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

Additional Inherited Members

- Public Types inherited from TMVA::VariableTransformBase
typedef VectorOfCharAndInt::iterator ItVarTypeIdx
 
typedef VectorOfCharAndInt::const_iterator ItVarTypeIdxConst
 
typedef std::vector< std::pair< Char_t, UInt_t > > VectorOfCharAndInt
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) ,
  kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
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.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(3) }
 
- 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.
 
Int_t GetNClasses () const
 
UInt_t GetNSpectators () const
 
UInt_t GetNTargets () const
 
UInt_t GetNVariables () const
 
void SetCreated (Bool_t c=kTRUE)
 
void SetName (const TString &c)
 
void SetNVariables (UInt_t i)
 
std::vector< TMVA::VariableInfo > & Spectators ()
 
std::vector< TMVA::VariableInfo > & Targets ()
 
std::vector< TMVA::VariableInfo > & Variables ()
 
- 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 TMVA::VariableTransformBase
EventfBackTransformedEvent
 
DataSetInfofDsi
 
DataSetInfofDsiOutput
 
VectorOfCharAndInt fGet
 
MsgLoggerfLogger
 
VectorOfCharAndInt fPut
 
TMVAVersion_t fTMVAVersion
 
EventfTransformedEvent
 

#include <TMVA/VariablePCATransform.h>

Inheritance diagram for TMVA::VariablePCATransform:
[legend]

Constructor & Destructor Documentation

◆ VariablePCATransform()

TMVA::VariablePCATransform::VariablePCATransform ( DataSetInfo dsi)

constructor

Definition at line 59 of file VariablePCATransform.cxx.

◆ ~VariablePCATransform()

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

destructor

Definition at line 67 of file VariablePCATransform.cxx.

Member Function Documentation

◆ AttachXMLTo()

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

create XML description of PCA transformation

Implements TMVA::VariableTransformBase.

Definition at line 346 of file VariablePCATransform.cxx.

◆ CalculatePrincipalComponents()

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 206 of file VariablePCATransform.cxx.

◆ Initialize()

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 81 of file VariablePCATransform.cxx.

◆ InverseTransform()

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 176 of file VariablePCATransform.cxx.

◆ MakeFunction()

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 531 of file VariablePCATransform.cxx.

◆ P2X()

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 299 of file VariablePCATransform.cxx.

◆ PrepareTransformation()

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 89 of file VariablePCATransform.cxx.

◆ ReadFromXML()

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

Read the transformation matrices from the xml node.

Implements TMVA::VariableTransformBase.

Definition at line 384 of file VariablePCATransform.cxx.

◆ ReadTransformationFromStream()

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

Read mean values from input stream.

Implements TMVA::VariableTransformBase.

Definition at line 450 of file VariablePCATransform.cxx.

◆ Transform()

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 127 of file VariablePCATransform.cxx.

◆ WriteTransformationToStream()

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

write mean values to stream

Implements TMVA::VariableTransformBase.

Definition at line 315 of file VariablePCATransform.cxx.

◆ X2P()

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 280 of file VariablePCATransform.cxx.

Member Data Documentation

◆ fEigenVectors

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

Definition at line 78 of file VariablePCATransform.h.

◆ fMeanValues

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

Definition at line 77 of file VariablePCATransform.h.

Libraries for TMVA::VariablePCATransform:

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