auryn::RateMonitor Class Reference

Monitor class to record neural firing rates. More...

#include <RateMonitor.h>

Inheritance diagram for auryn::RateMonitor:

Collaboration diagram for auryn::RateMonitor:

Public Member Functions
	RateMonitor (SpikingGroup *source, string filename, AurynFloat samplinginterval=1)
virtual	~RateMonitor ()
void	execute ()

Protected Member Functions
void	init (SpikingGroup *source, string filename, AurynFloat samplinginterval)
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)
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...
Protected Member Functions inherited from auryn::Device
void	init ()
	Standard initializer to be called by the constructor. More...
	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 ()

Protected Attributes
SpikingGroup *	src
Protected Attributes inherited from auryn::Monitor
std::ofstream	outfile
std::string	fname
std::string	default_file_extension
bool	active
	Standard active switch. More...
Protected Attributes inherited from auryn::Device
std::string	device_name
	Identifying name for device. More...
bool	active
	Standard active switch. More...

Detailed Description

Monitor class to record neural firing rates.

Instances of this class record the firing rates of all neurons in the src SpikingGroup. To estimate rates online it uses an exponential filter with a time constant that is three times the sampling interval. To do so the class uses a synaptic trace. Each rank only records spikes from local neurons.

Constructor & Destructor Documentation

RateMonitor()

RateMonitor::RateMonitor	(	SpikingGroup *	source,
		std::string	filename,
		AurynFloat	samplinginterval = 1
	)

Default Constructor

Parameters

                                                                                               : Monitor(filename)
{
        init(source,filename,samplinginterval);
}

Here is the call graph for this function:

~RateMonitor()

RateMonitor::~RateMonitor ( )

virtual

Default Destructor

{
}

Member Function Documentation

execute()

void RateMonitor::execute ( )

virtual

Implementation of necessary execute() function.

Reimplemented from auryn::Device.

{
        if ( src->evolve_locally() ) {
                if (auryn::sys->get_clock()%ssize==0) {
                        outfile << auryn_timestep*(auryn::sys->get_clock()) << " "; 
                        for  (NeuronID i = 0 ; i < src->get_rank_size() ; ++i ) {
                                outfile << tr_post->normalized_get(i)
                                        << " "; 
                        }
                        outfile << "\n";
                }
        }
}

Here is the call graph for this function:

init()

void RateMonitor::init ( SpikingGroup *  source, std::string  filename, AurynFloat  samplinginterval  )

protected

Default init method

{
        auryn::sys->register_device(this);

        src = source;
        ssize = samplinginterval/auryn_timestep;
        if ( ssize < 1 ) ssize = 1;

        tau_filter = 3*samplinginterval;

        tr_post = source->get_post_trace(tau_filter);

        std::stringstream oss;
        oss << "RateMonitor:: Setting sampling interval " << samplinginterval << "s";
        auryn::logger->msg(oss.str(),NOTIFICATION);

        outfile << std::setiosflags(std::ios::fixed) << std::setprecision(6);
}

Here is the call graph for this function:

Member Data Documentation

src

SpikingGroup* auryn::RateMonitor::src

protected

The source SpikingGroup

---

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

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