CEBL  2.1
Public Member Functions | Protected Attributes
CEBL::Feature Class Reference

#include <Feature.hpp>

Public Member Functions

virtual ~Feature ()
void setSampleRate (int sample_rate)
virtual ublas::matrix< double > use (const ublas::matrix< double > &)=0
virtual void reset ()
virtual bool needsTraining ()
virtual void train ()
virtual bool isTrained ()
- Public Member Functions inherited from CEBL::Plugin
 Plugin ()
virtual ~Plugin ()
void halt ()
 tell classifier to halt
string getName () const
 get the name of the plugin
virtual std::map< std::string,
CEBL::Param
getParamsList ()
 get the parameter list
virtual void setParamsList (std::map< std::string, CEBL::Param > &)
 set the parameter list
virtual map< string,
SerializedObject
save () const
 save plugin to list, and return it
virtual void load (map< string, SerializedObject > objects)
 load plugin from list of objects

Protected Attributes

int sample_rate
- Protected Attributes inherited from CEBL::Plugin
string plugin_name
bool should_halt

Additional Inherited Members

- Protected Member Functions inherited from CEBL::Plugin
void inturruptionPoint ()

Detailed Description

Author:
Jeshua Bratman

Provides interface for feature plugins.

Definition at line 42 of file Feature.hpp.


Constructor & Destructor Documentation

virtual CEBL::Feature::~Feature ( )
inlinevirtual

Definition at line 48 of file Feature.hpp.


Member Function Documentation

virtual bool CEBL::Feature::isTrained ( )
inlinevirtual

Check if feature is trained.

 \return 

Reimplemented in CEBL::PassBand.

Definition at line 85 of file Feature.hpp.

virtual bool CEBL::Feature::needsTraining ( )
inlinevirtual

Does this feature need to be trained before use?.

 \return 

Definition at line 75 of file Feature.hpp.

virtual void CEBL::Feature::reset ( )
inlinevirtual

Called every time a class is selected.

Reimplemented in CEBL::IncrementalSVD, CEBL::Lag, and CEBL::WindowedSVD.

Definition at line 69 of file Feature.hpp.

void CEBL::Feature::setSampleRate ( int  sample_rate)
inline

Called when sample rate changes.

Parameters:
sample_rate

Definition at line 53 of file Feature.hpp.

References sample_rate.

virtual void CEBL::Feature::train ( )
inlinevirtual

If it does need to be trained, override this function.

Reimplemented in CEBL::PassBand.

Definition at line 79 of file Feature.hpp.

virtual ublas::matrix<double> CEBL::Feature::use ( const ublas::matrix< double > &  )
pure virtual

Use feature on data and return new matrix.

 \return 

Implemented in CEBL::PassBand, CEBL::IncrementalSVD, CEBL::Lag, and CEBL::WindowedSVD.


Field Documentation

int CEBL::Feature::sample_rate
protected

Definition at line 45 of file Feature.hpp.

Referenced by setSampleRate().


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