---

punnets_common::tlogger Class Reference
[Logging (drawing a graph of neuron potentials)]

#include <dlogger.h>

Inheritance diagram for punnets_common::tlogger:

List of all members.

Public Types
enum	logoption { shownone = 0, showthr = 1, showext = 2, showpart = 4 }
Public Methods
	tlogger (std::ostream &iout, ntime_t istep, ntime_t ifrom=0, ntime_t iuntil=mak::Infinity)
	Constructs a logger with output stream iout, time step istep, and logging range between ifrom and iuntil.
virtual const char *	getClassName () const
	Get the class name of this action. Primarily for debugging.
virtual tqueue *	queue () const
	Obtain a local event queue of this action.
void	add (tneuron_base &p, ntime_t delay, bool ishowthr, bool ishowext=false, real offset=0.0)
	Add a neuron to be logged. Two boolean specifies logging options of thresholds and externals.
void	add (tneuron_base &p, ntime_t delay=0.0, logoption logopt=showthr, real offset=0.0)
	Add a neuron to be logged. logoption specifies logging options.
void	add (tsynapse_base &p, ntime_t delay=0.0)
	Add a synapse to be logged.
virtual void	activate (tscheduler &scheduler, ntime_t current_time)
	When activated by scheduler, the logger logs the current status to the log file.
void	schedule (tscheduler &scheduler)
	Schedule the logger itself to the specified scheduler.
void	gnuplot_def (std::ostream &os, std::string file)

---

Detailed Description

Activation logging class.

This class periodically probes the state (potential value) of neurons, and produces a log file of the state changes. To use logging, you need to do the followings:

• Register the neurons to be logged by calling add method of the logger. If you want to plot several neurons separately, specify offsets to displace the graph vertically. Or you may specify the horizontal displacement by delay. This is useful for analyzing events with temporal delays.
• Schedule the logger to the scheduler by calling schedule method of the logger.
• Create gnuplot definition file by calling gnuplot_def method of the logger.

Definition at line 51 of file dlogger.h.

---

Member Enumeration Documentation

enum punnets_common::tlogger::logoption

The option of the logging. You may log threshold, external inputs, and partitions. Multiple of them can be specified by logical or. Enumeration values: shownone  Nothing. showthr  Threshold. showext  External inputs. showpart  Partitions. Definition at line 58 of file dlogger.h. Referenced by add(). { shownone = 0, showthr = 1, showext = 2, showpart = 4 };

---

Member Function Documentation

void punnets_common::tlogger::gnuplot_def (  std::ostream &    os, std::string    file )

Generate a GNUPLOT definition file to the specified stream. file is a file name of the log file. Definition at line 90 of file dlogger.cpp. References showext, showpart, and showthr. { // cerr << "min/max: " << delaymin << "/" << delaymax << endl; // os << "set term X11" << endl; os << "set y2tics" << endl; os << "plot [" << from << ":" << until << "]"; string delim = ""; int column = 1; for( vector< neuentry >::iterator i = neus.begin(); i != neus.end(); i++ ) { int xcol = (i->delay == 0.0 ? 1 : ++column); os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " signal\" with lines"; delim = ","; if( i->logopt & showthr ) { os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " threshold\" with dots"; delim = ","; } if( i->logopt & showext ) { os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " external\" with dots"; delim = ","; } if( i->logopt & showpart ) { os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " partition 0\" with impulses"; delim = ","; os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " partition 1\" with impulses"; os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " partition 2\" with impulses"; os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y1 " << "title \"" << i->neuron->getClassName() << " '" << i->neuron->getName() << "'"; if( i->delay != 0.0 ) os << "(delay " << i->delay << ")"; if( i->offset != 0.0 ) os << "(offset " << i->offset << ")"; os << " partition delta_t\" with impulses"; } } for( vector<pair<tsynapse_base *, ntime_t> >::iterator i = syns.begin(); i != syns.end(); i++ ) { int xcol = (i->second == 0.0 ? 1 : ++column); os << delim << " \\" << endl << "\t'" << logfile << "' " << "using " << xcol << ":" << (++column) << " axes x1y2 " << "title \"" << i->first->getClassName() << " '" << i->first->getSrc().getName() << "' -> '" << i->first->getDest().getName() << "'"; if( i->second != 0.0 ) os << "(delay " << i->second << ")"; os << "\" with lines"; delim = ","; } os << endl; os << "pause -1" << endl; }

---

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

• dlogger.h
• dlogger.cpp

---