Derivative.h

Go to the documentation of this file.

#ifndef GRT_DERIVATIVE_HEADER
#define GRT_DERIVATIVE_HEADER

#include "../CoreModules/PreProcessing.h"
#include "MovingAverageFilter.h"

GRT_BEGIN_NAMESPACE

class GRT_API Derivative : public PreProcessing{
public:
    enum DerivativeOrders{FIRST_DERIVATIVE=1,SECOND_DERIVATIVE};
    
    Derivative(const UINT derivativeOrder=FIRST_DERIVATIVE,const Float delta = 1,const UINT numDimensions = 1,const bool filterData = true,const UINT filterSize = 3);
    
    Derivative(const Derivative &rhs);
    
    virtual ~Derivative();
    
    Derivative& operator=(const Derivative &rhs);
    
    virtual bool deepCopyFrom(const PreProcessing *preProcessing);
    
    virtual bool process(const VectorFloat &inputVector);
    
    virtual bool reset();
    
    virtual bool save(std::fstream &file) const;
    
    virtual bool load(std::fstream &file);
    
    bool init(const UINT derivativeOrder,const Float delta,const UINT numDimensions,const bool filterData,const UINT filterSize);
    
    Float computeDerivative(const Float x);
    
    VectorFloat computeDerivative(const VectorFloat &x);
    
    bool setDerivativeOrder(const UINT derivativeOrder);
    
    bool setFilterSize(const UINT filterSize);
    
    bool setDelta(const Float delta);
    
    bool enableFiltering(const bool filterData);
    
    UINT getFilterSize() const;
    
    Float getDerivative(const UINT derivativeOrder = FIRST_DERIVATIVE) const;
    
    VectorFloat getDerivatives(const UINT derivativeOrder = FIRST_DERIVATIVE) const;

    static std::string getId();
    
    //Tell the compiler we are using the following functions from the MLBase class to stop hidden virtual function warnings
    using MLBase::save;
    using MLBase::load;
    using MLBase::train;
    using MLBase::train_;
    using MLBase::predict;
    using MLBase::predict_;
    
protected:
    UINT derivativeOrder;                   
    UINT filterSize;                        
    Float delta;                           
    bool filterData;                        
    MovingAverageFilter filter;             
    VectorFloat yy;                        
    VectorFloat yyy;                       
    
private:
    static const std::string id;   
    static RegisterPreProcessingModule< Derivative > registerModule;
    
};

GRT_END_NAMESPACE

#endif //GRT_DERIVATIVE_HEADER