#include <spike_monitor_core.h>

Public Member Functions
	SpikeMonitorCore (SNN *snn, int monitorId, int grpId)
	constructor (called by CARLsim::setSpikeMonitor) More...

	~SpikeMonitorCore ()
	destructor, cleans up all the memory upon object deletion More...

void	clear ()
	deletes data from the 2D spike vector More...

long int	getAccumTime ()
	returns the total accumulated time More...

std::vector< float >	getAllFiringRates ()
	returns a list of firing rates for all neurons in the group (sorted by neuron ID ascending) More...

std::vector< float >	getAllFiringRatesSorted ()
	returns a list of firing rates for all neurons in the group (sorted by firing rate ascending) More...

long int	getBufferSize ()
	returns the approximate size of the spike vector in bytes More...

int	getGrpId ()
	returns the group ID More...

int	getGrpNumNeurons ()
	returns number of neurons in the group More...

long int	getLastUpdated ()
	returns timestamp of last SpikeMonitor update More...

float	getMaxFiringRate ()
	returns the largest recorded firing rate More...

float	getMinFiringRate ()
	returns the smallest recorded firing rate More...

SpikeMonMode	getMode ()
	returns recording mode More...

int	getMonitorId ()
	returns the SpikeMonitor ID More...

float	getNeuronMeanFiringRate (int neurId)
	returns the recorded mean firing rate for a specific neuron More...

int	getNeuronNumSpikes (int neurId)
	returns the number of recorded spikes of a specific neuron More...

int	getNumNeuronsWithFiringRate (float min, float max)
	returns number of neurons whose firing rate was in [min,max] during recording More...

int	getNumSilentNeurons ()
	returns number of neurons that didn't spike while recording More...

float	getPercentNeuronsWithFiringRate (float min, float max)
	returns percentage of neurons whose firing rate was in [min,max] during recording More...

float	getPercentSilentNeurons ()
	returns percentage of neurons that didn't spike during recording More...

bool	getPersistentData ()
	returns status of PersistentData mode More...

float	getPopMeanFiringRate ()
	returns the recorded mean firing rate of the group More...

int	getPopNumSpikes ()
	returns the total number of recorded spikes in the group More...

float	getPopStdFiringRate ()
	computes the standard deviation of firing rates in the group More...

long int	getRecordingLastStartTime ()
	returns the timestamp of the last startRecording in ms More...

long int	getRecordingStartTime ()
	retunrs the timestamp of the first startRecording in ms More...

long int	getRecordingStopTime ()
	returns the timestamp of stopRecording More...

long int	getRecordingTotalTime ()
	returns the total recorded time in ms More...

FILE *	getSpikeFileId ()
	returns a pointer to the spike file More...

std::vector< std::vector< int > >	getSpikeVector2D ()
	returns the 2D AER vector More...

bool	isBufferBig ()
	returns true if spike buffer is close to maxAllowedBufferSize More...

bool	isRecording ()
	returns recording status More...

void	print (bool printSpikeTimes)
	prints the AER vector in human-readable format More...

void	pushAER (int time, int neurId)
	inserts a (time,neurId) tupel into the 2D spike vector More...

void	setLastUpdated (long int lastUpdate)
	sets timestamp of last SpikeMonitor update More...

void	setMode (SpikeMonMode mode)
	sets recording mode More...

void	setPersistentData (bool persistentData)
	sets status of PersistentData mode More...

void	setSpikeFileId (FILE *spikeFileId)
	sets pointer to spike file More...

void	startRecording ()
	starts recording AER data More...

void	stopRecording ()
	stops recording AER data More...

Detailed Description

Definition at line 73 of file spike_monitor_core.h.

Constructor & Destructor Documentation

◆ SpikeMonitorCore()

SpikeMonitorCore	(	SNN *	snn,
		int	monitorId,
		int	grpId
	)

Definition at line 60 of file spike_monitor_core.cpp.

Here is the call graph for this function:

◆ ~SpikeMonitorCore()

~SpikeMonitorCore ( )

Definition at line 98 of file spike_monitor_core.cpp.

Member Function Documentation

◆ clear()

void clear ( )

Definition at line 107 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccumTime()

long int getAccumTime ( )

Definition at line 485 of file spike_monitor_core.cpp.

Here is the caller graph for this function:

◆ getAllFiringRates()

std::vector< float > getAllFiringRates ( )

Definition at line 165 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllFiringRatesSorted()

std::vector< float > getAllFiringRatesSorted ( )

Definition at line 205 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBufferSize()

long int getBufferSize ( )

Definition at line 459 of file spike_monitor_core.cpp.

Here is the caller graph for this function:

◆ getGrpId()

int getGrpId ( )

inline

Definition at line 91 of file spike_monitor_core.h.

◆ getGrpNumNeurons()

int getGrpNumNeurons ( )

inline

Definition at line 94 of file spike_monitor_core.h.

Here is the call graph for this function:

◆ getLastUpdated()

long int getLastUpdated ( )

inline

Definition at line 187 of file spike_monitor_core.h.

Here is the caller graph for this function:

◆ getMaxFiringRate()

float getMaxFiringRate ( )

Definition at line 174 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMinFiringRate()

float getMinFiringRate ( )

Definition at line 182 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

SpikeMonMode getMode ( )

inline

Definition at line 103 of file spike_monitor_core.h.

Here is the caller graph for this function:

◆ getMonitorId()

int getMonitorId ( )

inline

Definition at line 106 of file spike_monitor_core.h.

Here is the call graph for this function:

◆ getNeuronMeanFiringRate()

float getNeuronMeanFiringRate ( int neurId )

Definition at line 190 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNeuronNumSpikes()

int getNeuronNumSpikes ( int neurId )

Definition at line 197 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumNeuronsWithFiringRate()

int getNumNeuronsWithFiringRate	(	float	min,
		float	max
	)

Definition at line 214 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNumSilentNeurons()

int getNumSilentNeurons ( )

Definition at line 233 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPercentNeuronsWithFiringRate()

float getPercentNeuronsWithFiringRate	(	float	min,
		float	max
	)

Definition at line 240 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPercentSilentNeurons()

float getPercentSilentNeurons ( )

Definition at line 246 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPersistentData()

bool getPersistentData ( )

inline

Definition at line 127 of file spike_monitor_core.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPopMeanFiringRate()

float getPopMeanFiringRate ( )

Definition at line 128 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPopNumSpikes()

int getPopNumSpikes ( )

Definition at line 155 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPopStdFiringRate()

float getPopStdFiringRate ( )

Definition at line 137 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordingLastStartTime()

long int getRecordingLastStartTime ( )

inline

Definition at line 145 of file spike_monitor_core.h.

Here is the caller graph for this function:

◆ getRecordingStartTime()

long int getRecordingStartTime ( )

inline

Definition at line 142 of file spike_monitor_core.h.

Here is the caller graph for this function:

◆ getRecordingStopTime()

long int getRecordingStopTime ( )

inline

Definition at line 148 of file spike_monitor_core.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRecordingTotalTime()

long int getRecordingTotalTime ( )

inline

Definition at line 139 of file spike_monitor_core.h.

Here is the caller graph for this function:

◆ getSpikeFileId()

FILE* getSpikeFileId ( )

inline

Definition at line 181 of file spike_monitor_core.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpikeVector2D()

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

Definition at line 252 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isBufferBig()

bool isBufferBig ( )

Definition at line 469 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRecording()

bool isRecording ( )

inline

Definition at line 154 of file spike_monitor_core.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ print()

void print ( bool printSpikeTimes )

Definition at line 259 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pushAER()

void pushAER	(	int	time,
		int	neurId
	)

Definition at line 305 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLastUpdated()

void setLastUpdated ( long int lastUpdate )

inline

Definition at line 190 of file spike_monitor_core.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMode()

void setMode ( SpikeMonMode mode )

inline

Definition at line 163 of file spike_monitor_core.h.

Here is the caller graph for this function:

◆ setPersistentData()

void setPersistentData ( bool persistentData )

inline

Definition at line 166 of file spike_monitor_core.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSpikeFileId()

void setSpikeFileId ( FILE * spikeFileId )

Definition at line 361 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ startRecording()

void startRecording ( )

Definition at line 312 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stopRecording()

void stopRecording ( )

Definition at line 344 of file spike_monitor_core.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SpikeMonitorCore()

◆ ~SpikeMonitorCore()

Member Function Documentation

◆ clear()

◆ getAccumTime()

◆ getAllFiringRates()

◆ getAllFiringRatesSorted()

◆ getBufferSize()

◆ getGrpId()

◆ getGrpNumNeurons()

◆ getLastUpdated()

◆ getMaxFiringRate()

◆ getMinFiringRate()

◆ getMode()

◆ getMonitorId()

◆ getNeuronMeanFiringRate()

◆ getNeuronNumSpikes()

◆ getNumNeuronsWithFiringRate()

◆ getNumSilentNeurons()

◆ getPercentNeuronsWithFiringRate()

◆ getPercentSilentNeurons()

◆ getPersistentData()

◆ getPopMeanFiringRate()

◆ getPopNumSpikes()

◆ getPopStdFiringRate()

◆ getRecordingLastStartTime()

◆ getRecordingStartTime()

◆ getRecordingStopTime()

◆ getRecordingTotalTime()

◆ getSpikeFileId()

◆ getSpikeVector2D()

◆ isBufferBig()

◆ isRecording()

◆ print()

◆ pushAER()

◆ setLastUpdated()

◆ setMode()

◆ setPersistentData()

◆ setSpikeFileId()

◆ startRecording()

◆ stopRecording()