auryn::SpikeMonitor Class Reference

The standard Monitor object to record spikes from a SpikingGroup and write them to a text file. More...

#include <SpikeMonitor.h>

Inheritance diagram for auryn::SpikeMonitor:

Collaboration diagram for auryn::SpikeMonitor:

Public Member Functions
	SpikeMonitor (SpikingGroup *source, std::string filename)
	Default constructor. More...
	SpikeMonitor (SpikingGroup *source, std::string filename, NeuronID to)
	Default constructor which records from limited number of neurons. More...
	SpikeMonitor (SpikingGroup *source, std::string filename, NeuronID from, NeuronID to)
	Default constructor which records from a range of neurons. More...
void	set_every (NeuronID every)
	Sets every parameter that ellow to record only from every X neuron. More...
virtual	~SpikeMonitor ()
	Default destructor. More...
void	execute ()
	Propagate function for internal use. More...
Public Member Functions inherited from auryn::Monitor
virtual void	flush ()
	Flush to file. More...
	Monitor (std::string filename, std::string default_extension="dat")
	Standard constructor with file name. More...
	Monitor ()
	Constructor which does not open a text file for output. More...
std::string	generate_filename (std::string name_hint="")
	Generates a default filename from the device ID. More...
virtual	~Monitor ()
	Standard destructor. More...
Public Member Functions inherited from auryn::Device
	Device ()
	Standard constructor. More...
void	set_name (std::string s)
	Set device name. More...
std::string	get_name ()
	Get device name. More...
int	get_id ()
	Get numeric device id. More...
virtual	~Device ()
	Standard destructor. More...
virtual void	evolve ()

Public Attributes
bool	active
Public Attributes inherited from auryn::Monitor
bool	active
	Standard active switch. More...
Public Attributes inherited from auryn::Device
bool	active
	Standard active switch. More...

Additional Inherited Members
Protected Member Functions inherited from auryn::Monitor
virtual void	open_output_file (std::string filename)
virtual void	virtual_serialize (boost::archive::binary_oarchive &ar, const unsigned int version)
virtual void	virtual_serialize (boost::archive::binary_iarchive &ar, const unsigned int version)
Protected Member Functions inherited from auryn::Device
void	init ()
	Standard initializer to be called by the constructor. More...
Protected Attributes inherited from auryn::Monitor
std::ofstream	outfile
std::string	fname
std::string	default_file_extension
Protected Attributes inherited from auryn::Device
std::string	device_name
	Identifying name for device. More...

Detailed Description

The standard Monitor object to record spikes from a SpikingGroup and write them to a text file.

SpikeMonitor is specified with a source group of type SpikingGroup and writes all or a specified range of the neurons spikes to a text (ras) file that has to be given at construction time.

SpikeMonitor writes spikes into rank specific files and timestamps them before the axonal delay (this is generally what you want). DelaySpikeMonitor in contrast writes spikes after the axonal delay and records all spikes from all ranks and all all ranks (this is maninly for debugging).

Constructor & Destructor Documentation

SpikeMonitor() [1/3]

SpikeMonitor::SpikeMonitor	(	SpikingGroup *	source,
		std::string	filename
	)

Default constructor.

Parameters

source	Specifies the source SpikingGroup to record from
filename	Specifies the filename to write to. This filename needs to be rank specific to avoid problems in parallelm mode

        : Monitor(filename)
{
        init(source,filename,0,source->get_size());
}

Here is the call graph for this function:

SpikeMonitor() [2/3]

SpikeMonitor::SpikeMonitor	(	SpikingGroup *	source,
		std::string	filename,
		NeuronID	to
	)

Default constructor which records from limited number of neurons.

Parameters

source	Specifies the source SpikingGroup to record from
filename	Specifies the filename to write to. This filename needs to be rank specific to avoid problems in parallelm mode
to	The last NeuronID to record from starting from 0.

        : Monitor(filename)
{
        init(source,filename,0,to);
}

Here is the call graph for this function:

SpikeMonitor() [3/3]

SpikeMonitor::SpikeMonitor	(	SpikingGroup *	source,
		std::string	filename,
		NeuronID	from,
		NeuronID	to
	)

Default constructor which records from a range of neurons.

Parameters

source	Specifies the source SpikingGroup to record from
filename	Specifies the filename to write to. This filename needs to be rank specific to avoid problems in parallelm mode
from	The first NeuronID to record from.
to	The last NeuronID to record from.

        : Monitor(filename)
{
        init(source,filename,from,to);
}

Here is the call graph for this function:

~SpikeMonitor()

SpikeMonitor::~SpikeMonitor ( )

virtual

Default destructor.

{
        free();
}

Here is the call graph for this function:

Member Function Documentation

execute()

void SpikeMonitor::execute ( )

virtual

Propagate function for internal use.

Reimplemented from auryn::Device.

{
        if ( !active ) return;

        for (it = src->get_spikes_immediate()->begin() ; it < src->get_spikes_immediate()->end() ; ++it ) {
                if (*it >= n_from ) {
                        if ( *it < n_to && (*it%n_every==0) ) {
                          // using the good old stdio.h for formatting seems a bit faster 
                          char buffer[255];
                          int n = sprintf(buffer,"%f %u\n",auryn::sys->get_time(), *it); 
                          outfile.write(buffer,n); 
                        }
                }
        }
}

Here is the call graph for this function:

set_every()

void SpikeMonitor::set_every

(

NeuronID

every

)

Sets every parameter that ellow to record only from every X neuron.

Parameters

the	number X as described above.

{
        n_every = every;
}

Member Data Documentation

active

bool auryn::SpikeMonitor::active

Switch variable to enable/disable recording.

---

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

• /home/zenke/auryn/src/auryn/SpikeMonitor.h
• /home/zenke/auryn/src/auryn/SpikeMonitor.cpp