C:/Users/albertlr/projects/TarzaNN/TarzaNN/FeaturePlaneFHM.h

Go to the documentation of this file.

/* The Fixation History Map (FHM) Feature Plane is a specialized feature plane 
which is used to keep track of multiple fixation points incoming from a smaller 
window, to update those points over spatial translation of the window such that
the incoming window will always stay positioned in the centre of the FHM plane, 
and to decay the stored fixation points through time.
Author: Calden Wloka
*/

#ifndef FEATUREPLANEFHM_H_INCLUDED
#define FEATUREPLANEFHM_H_INCLUDED

#include "FeaturePlane.h"

class FeaturePlaneFHM : public FeaturePlane {
        friend class FeaturePlaneFactory;

protected:
        //constructor that takes in the standard feature plane parameters. decayRate will be set to a default value
        FeaturePlaneFHM(Network* net, int l, QString* n, int w, int h, int angles, int speeds, int alpha, int speed, bool isWTA, bool visible, Neuron* neuron, NotifyStrategyAbstract* notify);

        //constructor which specifies the decayRate to a user-defined value, so long as that value is greater than 0 and less than or equal to 1.
        FeaturePlaneFHM(Network* net, int l, QString* n, int w, int h, int angles, int speeds, int alpha, int speed, bool isWTA, bool visible, Neuron* neuron, NotifyStrategyAbstract* notify, int decayRate);

        //constructor which takes in a value for the size of the memory field separate from the w and h values, but does not specify the decay rate
        FeaturePlaneFHM(Network* net, int l, QString* n, int w, int h, int memW, int memH, int angles, int speeds, int alpha, int speed, bool isWTA, bool visible, Neuron* neuron, NotifyStrategyAbstract* notify);

        //constructor which specifies the decayRate to a user-defined value, so long as that value is greater than 0 and less than or equal to 1. Also takes in a value for the size of the memory field separate from the w and h values
        FeaturePlaneFHM(Network* net, int l, QString* n, int w, int h, int memW, int memH, int angles, int speeds, int alpha, int speed, bool isWTA, bool visible, Neuron* neuron, NotifyStrategyAbstract* notify, int decayRate);

        // Fixation History Map Parameters
        int decayRate;          // the number of time steps it takes for a previous fixation to return to 0
        int xTrans;                     // translation in the x dimension
        int yTrans;                     // translation in the y dimension
        int memW;                       // width of the memory plane, default to the size of the the visual field
        int memH;                       // height of the memory plane, default to the size of the the visual field
        Matrix* memoryActivation;               // hidden storage of fixation history which can take a custom size
        int xMem;                       // x-offset between the top corner of the visual field and the edge of the memory map
        int yMem;                       // y-offset between the top corner of the visual field and the edge of the memory map

        // initialize the memory map, which stores fixations outside of the visual field
        void initMemory(int memW, int memH, int decayRate);

        // overload the sumActivations functions such that it does not replace previous values, but
        // rather translates and reduces the previous values to keep it centered with foveation.
        void sumActivations(MatrixVector regularActivations, MatrixVector nonFourierActivations, Matrix* totalActivation);      
        void _sumActivations(MatrixVector activations, Matrix* totalActivation);

        //destructor
        ~FeaturePlaneFHM();
};
#endif //FEATUREPLANEFHM_H_INCLUDED