spike_monitor_core.h

Go to the documentation of this file.

/* * Copyright (c) 2016 Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
*
* 3. The names of its contributors may not be used to endorse or promote
*    products derived from this software without specific prior written
*    permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* *********************************************************************************************** *
* CARLsim
* created by: (MDR) Micah Richert, (JN) Jayram M. Nageswaran
* maintained by:
* (MA) Mike Avery <averym@uci.edu>
* (MB) Michael Beyeler <mbeyeler@uci.edu>,
* (KDC) Kristofor Carlson <kdcarlso@uci.edu>
* (TSC) Ting-Shuo Chou <tingshuc@uci.edu>
* (HK) Hirak J Kashyap <kashyaph@uci.edu>
*
* CARLsim v1.0: JM, MDR
* CARLsim v2.0/v2.1/v2.2: JM, MDR, MA, MB, KDC
* CARLsim3: MB, KDC, TSC
* CARLsim4: TSC, HK
* CARLsim5: HK, JX, KC
* CARLsim6: LN, JX, KC, KW
*
* CARLsim available from http://socsci.uci.edu/~jkrichma/CARLsim/
* Ver 12/31/2016
*/

#ifndef _SPIKE_MON_CORE_H_
#define _SPIKE_MON_CORE_H_


#include <carlsim_datastructures.h> // SpikeMonMode
#include <stdio.h>                  // FILE
#include <vector>                   // std::vector

class SNN; // forward declaration of SNN class


/*
 * \brief SpikeMonitor private core implementation
 *
 * Naming convention for methods:
 * - getPop*:       a population metric (single value) that applies to the entire group; e.g., getPopMeanFiringRate.
 * - getNeuron*:    a neuron metric (single value), about a specific neuron (requires neurId); e.g., getNeuronNumSpikes.
 * - getAll*:       a metric (vector) that is based on all neurons in the group; e.g. getAllFiringRates.
 * - getNum*:       a number metric, returns an int
 * - getPercent*:   a percentage metric, returns a float
 * - get*:          all the others
 */
class SpikeMonitorCore {
public:
    SpikeMonitorCore(SNN* snn, int monitorId, int grpId);

    ~SpikeMonitorCore();


    // +++++ PUBLIC METHODS: +++++++++++++++++++++++++++++++++++++++++++++++//

    std::vector<float> getAllFiringRates();

    std::vector<float> getAllFiringRatesSorted();

    int getGrpId() { return grpId_; }

    int getGrpNumNeurons() { return nNeurons_; }

    float getMaxFiringRate();

    float getMinFiringRate();

    SpikeMonMode getMode() { return mode_; }

    int getMonitorId() { return monitorId_; }

    float getNeuronMeanFiringRate(int neurId);

    int getNeuronNumSpikes(int neurId);

    int getNumNeuronsWithFiringRate(float min, float max);

    int getNumSilentNeurons();

    float getPercentNeuronsWithFiringRate(float min, float max);

    float getPercentSilentNeurons();

    bool getPersistentData() { return persistentData_; }

    float getPopMeanFiringRate();

    int getPopNumSpikes();

    float getPopStdFiringRate();

    long int getRecordingTotalTime() { return totalTime_; }

    long int getRecordingStartTime() { return startTime_; }

    long int getRecordingLastStartTime() { return startTimeLast_; }

    long int getRecordingStopTime() { return stopTime_; }

    std::vector<std::vector<int> > getSpikeVector2D();

    bool isRecording() { return recordSet_; }

    void print(bool printSpikeTimes);

    void pushAER(int time, int neurId);

    void setMode(SpikeMonMode mode) { mode_ = mode; }

    void setPersistentData(bool persistentData) { persistentData_ = persistentData; }

    void startRecording();

    void stopRecording();


    // +++++ PUBLIC METHODS THAT SHOULD NOT BE EXPOSED TO INTERFACE +++++++++//

    void clear();

    FILE* getSpikeFileId() { return spikeFileId_; }

    void setSpikeFileId(FILE* spikeFileId);

    long int getLastUpdated() { return spkMonLastUpdated_; }

    void setLastUpdated(long int lastUpdate) { spkMonLastUpdated_ = lastUpdate; }

    bool isBufferBig();

    long int getBufferSize();

    long int getAccumTime();

private:
    void init();

    void calculateFiringRates();

    void sortFiringRates();

    void writeSpikeFileHeader();

    bool needToCalculateFiringRates_;

    bool needToSortFiringRates_;

    bool needToWriteFileHeader_;

    SNN* snn_;  
    int monitorId_; 
    int grpId_;     
    int nNeurons_;  

    FILE* spikeFileId_; 
    int spikeFileSignature_; 
    float spikeFileVersion_; 

    std::vector<std::vector<int> > spkVector_;

    std::vector<float> firingRates_;
    std::vector<float> firingRatesSorted_;

    bool recordSet_;            
    long int startTime_;        
    long int startTimeLast_;    
    long int stopTime_;         
    long int totalTime_;        
    long int accumTime_;

    long int spkMonLastUpdated_;

    bool persistentData_;

    bool userHasBeenWarned_;
    SpikeMonMode mode_;

    // file pointers for error logging
    const FILE* fpInf_;
    const FILE* fpErr_;
    const FILE* fpDeb_;
    const FILE* fpLog_;
};


#endif