shark::NormalizeComponentsWhitening Class Reference

Train a linear model to whiten the data. More...

#include <shark/Algorithms/Trainers/NormalizeComponentsWhitening.h>

+ Inheritance diagram for shark::NormalizeComponentsWhitening:

Public Member Functions

SHARK_EXPORT_SYMBOL NormalizeComponentsWhitening (double targetVariance=1.0)
 
SHARK_EXPORT_SYMBOL std::string name () const
 From INameable: return the class name. More...
 
SHARK_EXPORT_SYMBOL void train (ModelType &model, UnlabeledData< RealVector > const &input)
 
- Public Member Functions inherited from shark::AbstractUnsupervisedTrainer< LinearModel< RealVector > >
virtual void train (ModelType &model, const UnlabeledData< InputType > &inputset)=0
 Core of the Trainer interface. More...
 
- Public Member Functions inherited from shark::INameable
virtual ~INameable ()
 
- Public Member Functions inherited from shark::ISerializable
virtual ~ISerializable ()
 Virtual d'tor. More...
 
virtual void read (InArchive &archive)
 Read the component from the supplied archive. More...
 
virtual void write (OutArchive &archive) const
 Write the component to the supplied archive. More...
 
void load (InArchive &archive, unsigned int version)
 Versioned loading of components, calls read(...). More...
 
void save (OutArchive &archive, unsigned int version) const
 Versioned storing of components, calls write(...). More...
 
 BOOST_SERIALIZATION_SPLIT_MEMBER ()
 

Additional Inherited Members

- Public Types inherited from shark::AbstractUnsupervisedTrainer< LinearModel< RealVector > >
typedef LinearModel< RealVector > ModelType
 
typedef LinearModel< RealVector > ::InputType InputType
 

Detailed Description

Train a linear model to whiten the data.

computes a linear model that normlizes the data to be 0 mean, a given target variance and covariance 0. By default the trainer makes the data unit variance, but the target variance can be changed as well.

Definition at line 51 of file NormalizeComponentsWhitening.h.

Constructor & Destructor Documentation

◆ NormalizeComponentsWhitening()

SHARK_EXPORT_SYMBOL shark::NormalizeComponentsWhitening::NormalizeComponentsWhitening ( double  targetVariance = 1.0)

Member Function Documentation

◆ name()

SHARK_EXPORT_SYMBOL std::string shark::NormalizeComponentsWhitening::name ( ) const
virtual

From INameable: return the class name.

Reimplemented from shark::INameable.

◆ train()

SHARK_EXPORT_SYMBOL void shark::NormalizeComponentsWhitening::train ( ModelType model,
UnlabeledData< RealVector > const &  input 
)

Referenced by main().


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