visual_stimulus.h

Go to the documentation of this file.

#ifndef _VISUAL_STIMULUS_H_
#define _VISUAL_STIMULUS_H_

#include "carlsim_visual_stimulus_api.h"

#include <string>
class PoissonRate;

    enum stimType_t {
        UNKNOWN_STIM=-1,
        GRATING_STIM=0,
        PLAID_STIM=1,
        DOT_STIM=2,
        BAR_STIM=3,
        PICTURE_STIM=4,
        MOVIE_STIM=5,
        COMPOUND_STIM=6
    };


class CARLSIM_VISUAL_STIMULUS_API VisualStimulus {
public:
    // +++++ PUBLIC METHODS: CONSTRUCTOR / DESTRUCTOR / MEMBERS +++++++++++++++++++++++++++++++++++++++++++++++++++++ //

    VisualStimulus(std::string fileName, bool wrapAroundEOF=true);

    ~VisualStimulus();
    

    // +++++ PUBLIC METHODS: READING FRAMES +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //

    unsigned char* readFrameChar();

    PoissonRate* readFramePoisson(float maxPoisson, float minPoisson=0.0f);

    void rewind();

    void print();


    // +++++ PUBLIC METHODS: GETTERS / SETTERS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ //

    int getWidth();                         
    int getHeight();                        
    int getLength();                        
    int getChannels();                      
    stimType_t getType();                   

    unsigned char* getCurrentFrameChar();   
    PoissonRate* getCurrentFramePoisson();  
    int getCurrentFrameNumber();            


private:
    // This class provides a pImpl for the CARLsim User API.
    // \see https://marcmutz.wordpress.com/translated-articles/pimp-my-pimpl/
    class Impl;
    Impl* _impl;
};

#endif