---

statisticsoutput.h

/***************************************************************************
                          statisticsoutput.h  -  description
                             -------------------
    begin                : Wed Oct 24 2001
    copyright            : (C) 2001 by Matt Grover
    email                : mpgrover@sourceforge.net
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef STATISTICSOUTPUT_H
#define STATISTICSOUTPUT_H

using namespace std;
#include <amygdala/types.h>
#if GCC_VERSION >= 30000
    #include <ext/hash_map>
#else
    #include <hash_map>
#endif
#include <vector>
#include <set>
#include <string>
#include <amygdala/spikeoutput.h>

#include <stdio.h>

class StatisticsOutput : public SpikeOutput  {
public: 
    StatisticsOutput();
    virtual ~StatisticsOutput();
    
    virtual void OutputEvent(AmIdInt neuronId, AmTimeInt eventTime);
    
    virtual void OutputCache() {};
    
    void SetStepSize(AmTimeInt step);
    
    AmTimeInt GetStepSize() const { return stepSize; }
    
    void ClearHistory();
    
    vector<unsigned int>& Histogram();
    
    vector<unsigned int>& Histogram(AmIdInt neuronId);
    
    vector<unsigned int> Histogram(AmTimeInt start, AmTimeInt end);
    
    vector<unsigned int> Histogram(AmIdInt neuronId, AmTimeInt start, AmTimeInt end);
    
    float PeakSpikeRate();
    
    float PeakSpikeRate(AmIdInt neuronId);
    
    AmTimeInt PeakRateTime();
    
    AmTimeInt PeakRateTime(AmIdInt neuronId);
    
    AmIdInt PeakNeuron();
    
    AmIdInt MostActiveNeuron();
    
    unsigned int TotalOutputSpikes();
    
    unsigned int TotalOutputSpikes(AmIdInt neuronId);
    
    float MeanSpikeRate();
    
    float MeanSpikeRate(AmIdInt neuronId);

    void LogSpikeTimes(string filename, AmTimeInt start=0, AmTimeInt end=~0);
    void AddTrace(AmIdInt nId);
  void CloseLog();

protected:  // protected methods
    void Log(AmIdInt neuronId, AmTimeInt eventTime);
    
protected:
    hash_map< AmIdInt, vector<AmTimeInt> > outputHistory;  // hash_map<nId, spikeTime>

    hash_map< AmIdInt, vector<unsigned int> > histogram;
    vector<unsigned int> combinedHistogram;

    AmIdInt maxPeakId;  // The neuron with the highest peak activity
    AmTimeInt maxPeakTime;  // Time of peak activity of maxPeakId

    AmIdInt mostActiveId;   // The neuron with the highest number of spikes
    unsigned int mostActiveCount;   // Number of times mostActiveId spiked

    float combinedPeakRate;
    AmTimeInt combinedPeakTime;
    float meanRate;
    unsigned int totalSpikeCount;

    AmTimeInt stepSize;
    AmTimeInt beginTime;
    AmTimeInt calcTime;
    AmTimeInt lastCalcTime;
    set <AmIdInt> traceNeurons;
    bool logging;
    AmTimeInt logStart;
    AmTimeInt logEnd;
    FILE *logFd;

};

#endif

---