ArchiveStatistic Class Reference

#include <ArchiveStatistic.h>

Inheritance diagram for ArchiveStatistic:

List of all members.

Public Member Functions
	ArchiveStatistic (unsigned int *fNeurCount, unsigned int *fNeurTotal)
unsigned int	getID ()
unsigned int	getType ()
virtual void	recalculate (unsigned int neurID)
virtual void	recalculate ()
virtual void	recalculateNeuronGrp ()
void	resetFiringNeuronCount ()
void	resetFiringNeuronTotal ()
void	setID (unsigned int id)
virtual QString	toQString ()=0
virtual	~ArchiveStatistic ()
Static Public Attributes
static const unsigned int	NEURON_GROUP = 10
static const unsigned int	NEURON_ID = 20
Protected Attributes
unsigned int *	firingNeuronCount
unsigned int *	firingNeuronTotal
unsigned int	type
Static Protected Attributes
static dense_hash_map< unsigned int, bool, hash< unsigned int > > *	neuronIDHashMap
Private Attributes
unsigned int	ID
Friends
class	NetworkDataXmlHandler

---

Detailed Description

Abstract class used to gather statistics about an archive. Inheriting classes add up information about neuron groups or neuron ids.

Definition at line 41 of file ArchiveStatistic.h.

---

Constructor & Destructor Documentation

ArchiveStatistic::ArchiveStatistic (  unsigned int *  fNeurCount, unsigned int *  fNeurTotal )

Constructor. Definition at line 45 of file ArchiveStatistic.cpp. References firingNeuronCount, firingNeuronTotal, NEURON_ID, and type.

ArchiveStatistic::~ArchiveStatistic (   )  [virtual]

Destructor. Definition at line 56 of file ArchiveStatistic.cpp.

---

Member Function Documentation

unsigned int ArchiveStatistic::getID (   )

Returns the ID given to the class. Definition at line 64 of file ArchiveStatistic.cpp. References ID.

unsigned int ArchiveStatistic::getType (   )

Returns the type of the class. Definition at line 70 of file ArchiveStatistic.cpp. References type.

void ArchiveStatistic::recalculate (  unsigned int  neurID  )  [virtual]

Default implementation of this method, which gets called if it is not overridden by a subclass. Definition at line 83 of file ArchiveStatistic.cpp.

void ArchiveStatistic::recalculate (   )  [virtual]

Default implementation of this method, which gets called if it is not overridden by a subclass. Reimplemented in RangeArchiveStatistic, AndArchiveStatistic, OrArchiveStatistic, and NeuronIDArchiveStatistic. Definition at line 77 of file ArchiveStatistic.cpp.

void ArchiveStatistic::recalculateNeuronGrp (   )  [virtual]

Default implementation of this method, which gets called if it is not overridden by a subclass. Reimplemented in NeuronGrpArchiveStatistic. Definition at line 89 of file ArchiveStatistic.cpp.

void ArchiveStatistic::resetFiringNeuronCount (   )

Resets the firing neuron count. Generally called when starting to load the data for a timestep. Definition at line 95 of file ArchiveStatistic.cpp. References firingNeuronCount.

void ArchiveStatistic::resetFiringNeuronTotal (   )

Resets the firing neuron total. Generally called when rewinding the archive or after editing the statistics. Definition at line 102 of file ArchiveStatistic.cpp. References firingNeuronTotal.

void ArchiveStatistic::setID (  unsigned int  id  )

Sets the id. Definition at line 108 of file ArchiveStatistic.cpp. References ID.

virtual QString ArchiveStatistic::toQString (   )  [pure virtual]

Implemented in NeuronGrpArchiveStatistic, RangeArchiveStatistic, AndArchiveStatistic, OrArchiveStatistic, and NeuronIDArchiveStatistic.

---

Friends And Related Function Documentation

friend class NetworkDataXmlHandler [friend]

Definition at line 66 of file ArchiveStatistic.h.

---

Member Data Documentation

unsigned int* ArchiveStatistic::firingNeuronCount [protected]

The number of neurons firing at the current timestep. This is a pointer to the variable in the ArchiveStatisticsHolder struct, which contains one or more ArchiveStatistics. Definition at line 82 of file ArchiveStatistic.h. Referenced by ArchiveStatistic(), NeuronIDArchiveStatistic::recalculate(), OrArchiveStatistic::recalculate(), AndArchiveStatistic::recalculate(), RangeArchiveStatistic::recalculate(), NeuronGrpArchiveStatistic::recalculateNeuronGrp(), and resetFiringNeuronCount().

unsigned int* ArchiveStatistic::firingNeuronTotal [protected]

The total number of neurons that have fired so far. This is a pointer to the variable in the ArchiveStatisticsHolder struct, which contains one or more ArchiveStatistics. Definition at line 87 of file ArchiveStatistic.h. Referenced by ArchiveStatistic(), NeuronIDArchiveStatistic::recalculate(), OrArchiveStatistic::recalculate(), AndArchiveStatistic::recalculate(), RangeArchiveStatistic::recalculate(), NeuronGrpArchiveStatistic::recalculateNeuronGrp(), and resetFiringNeuronTotal().

unsigned int ArchiveStatistic::ID [private]

The unique id of this archive statistic. Used for deleting them. Definition at line 93 of file ArchiveStatistic.h. Referenced by getID(), and setID().

const unsigned int ArchiveStatistic::NEURON_GROUP = 10 [static]

This statistic is monitoring an entire neuron group. Definition at line 59 of file ArchiveStatistic.h. Referenced by NetworkDataXmlHandler::addArchiveStatistics(), ArchiveStatisticsDialog::ArchiveStatisticsDialog(), and NeuronGrpArchiveStatistic::NeuronGrpArchiveStatistic().

const unsigned int ArchiveStatistic::NEURON_ID = 20 [static]

This statistic is monitoring a selection of neuron ids. Definition at line 62 of file ArchiveStatistic.h. Referenced by ArchiveStatistic().

dense_hash_map< unsigned int, bool, hash< unsigned int > > * ArchiveStatistic::neuronIDHashMap [static, protected]

Pointer to the hash map in the NetworkDataXmlHandler. At each timestep the firing neuron ids are placed in this map and then the archive statistics are invoked to carry out their analysis. Definition at line 77 of file ArchiveStatistic.h. Referenced by NetworkDataXmlHandler::NetworkDataXmlHandler(), NeuronIDArchiveStatistic::recalculate(), OrArchiveStatistic::recalculate(), AndArchiveStatistic::recalculate(), and RangeArchiveStatistic::recalculate().

unsigned int ArchiveStatistic::type [protected]

Is this monitoring a neuron group or a set of neuron ids?. Definition at line 72 of file ArchiveStatistic.h. Referenced by ArchiveStatistic(), getType(), and NeuronGrpArchiveStatistic::NeuronGrpArchiveStatistic().

---

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

• spikestreamapplication/src/ArchiveStatistic.h
• spikestreamapplication/src/ArchiveStatistic.cpp

---