view CalciumSignalAnalyser.h @ 1:26c75dbfe61c

Update of the documentation and Readme file

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
 Header file for the Calcium Signal Analyser Vamp Plugin
 
 Description: Detects and characterises the transients in noisy signals.
 
 Authors: Mathieu Barthet.
 Based on the QM Vamp note onset detector plugin by Christian Landone, 
 Chris Duxbury, and Juan Pablo Bello.
 
 Version: 1
 
 Centre for Digital Music, Queen Mary, University of London.
 All rights reserved.
 
*/

#ifndef _CALCIUM_SIGNAL_ANALSYER_PLUGIN_H_
#define _CALCIUM_SIGNAL_ANALSYER_PLUGIN_H_

#include <vamp-sdk/Plugin.h>

using std::vector;

class CalciumSignalAnalyser : public Vamp::Plugin
{
public:
    CalciumSignalAnalyser(float inputSampleRate);
    virtual ~CalciumSignalAnalyser();

    bool initialise(size_t channels, size_t stepSize, size_t blockSize);
    void reset();

    InputDomain getInputDomain() const { return TimeDomain; } //input data are passed to the plugin in the time domain
	
    std::string getIdentifier() const;
    std::string getName() const;
    std::string getDescription() const;
    std::string getMaker() const;
    int getPluginVersion() const;
    std::string getCopyright() const;

    ParameterList getParameterDescriptors() const;
    float getParameter(std::string) const;
    void setParameter(std::string, float);

    ProgramList getPrograms() const;
    std::string getCurrentProgram() const;
    void selectProgram(std::string program);

    size_t getPreferredStepSize() const;
    size_t getPreferredBlockSize() const;
	size_t getMinChannelCount() const;
    size_t getMaxChannelCount() const;
	
    OutputList getOutputDescriptors() const;

    FeatureSet process(const float *const *inputBuffers,
                       Vamp::RealTime timestamp);

    FeatureSet getRemainingFeatures();

protected:
    
	float m_inputSampleRate;
	size_t m_blockSize;
	size_t m_stepSize;
	
	vector<float> data;
	vector<Vamp::RealTime> time;
	
    float m_sensitivity;
	float m_delta;
	
	int processcounter;
};

#endif