#include <Stats.h>

Inheritance diagram for Stats:

Collaboration diagram for Stats:

Public Member Functions
void	doWindowCalculation () const

double	getMean () const

unsigned int	getNum () const

double	getSdev () const

double	getSum () const

unsigned int	getWindowLength () const

double	getWmean () const

unsigned int	getWnum () const

double	getWsdev () const

double	getWsum () const

void	innerWindowCalculation ()

void	input (double v)

void	process (const Eref &e, ProcPtr p)

void	reinit (const Eref &e, ProcPtr p)

void	setWindowLength (unsigned int len)

	Stats ()

virtual void	vProcess (const Eref &e, ProcPtr p)
	Virtual func for handling process calls for derived classes. More...

virtual void	vReinit (const Eref &e, ProcPtr p)

Static Public Member Functions
static const Cinfo *	initCinfo ()

Private Attributes
bool	isWindowDirty_

double	lastt_

double	mean_

unsigned int	num_

vector< double >	samples_

double	sdev_

double	sum_

double	sumsq_

double	wmean_

unsigned int	wnum_

double	wsdev_

double	wsum_

Detailed Description

Definition at line 12 of file Stats.h.

Constructor & Destructor Documentation

Stats::Stats ( )

Definition at line 134 of file Stats.cpp.

     :
     mean_( 0.0 ), sdev_( 0.0 ), sum_( 0.0 ), num_( 0 ),
     wmean_( 0.0 ), wsdev_( 0.0 ), wsum_( 0.0 ), wnum_( 0 ),
     sumsq_( 0.0 ), isWindowDirty_( true )
 {
     ;
 }

Member Function Documentation

void Stats::doWindowCalculation ( ) const

Definition at line 262 of file Stats.cpp.

References innerWindowCalculation().

Referenced by getWmean(), getWnum(), getWsdev(), and getWsum().

 {
     Stats* temp = const_cast< Stats* >( this );
     temp->innerWindowCalculation();
 }

Here is the call graph for this function:

Here is the caller graph for this function:

double Stats::getMean ( ) const

Definition at line 197 of file Stats.cpp.

References num_, and sum_.

Referenced by initCinfo().

 {
     if ( num_ > 0 )
         return sum_ / num_;
     return 0.0;
 }

Here is the caller graph for this function:

unsigned int Stats::getNum ( ) const

Definition at line 216 of file Stats.cpp.

References num_.

Referenced by initCinfo().

 {
     return num_;
 }

Here is the caller graph for this function:

double Stats::getSdev ( ) const

Definition at line 204 of file Stats.cpp.

References num_, sum_, and sumsq_.

Referenced by initCinfo().

 {
     if ( num_ > 0 )
         return sqrt( ( sumsq_ - sum_ * sum_ / num_ ) / num_ );
     return 0.0;
 }

Here is the caller graph for this function:

double Stats::getSum ( ) const

Definition at line 211 of file Stats.cpp.

References sum_.

Referenced by initCinfo().

 {
     return sum_;
 }

Here is the caller graph for this function:

unsigned int Stats::getWindowLength ( ) const

Definition at line 255 of file Stats.cpp.

References samples_.

Referenced by initCinfo().

 {
     return samples_.size();
 }

Here is the caller graph for this function:

double Stats::getWmean ( ) const

Definition at line 221 of file Stats.cpp.

References doWindowCalculation(), and wmean_.

Referenced by initCinfo().

 {
     doWindowCalculation();
     return wmean_;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Stats::getWnum ( ) const

Definition at line 239 of file Stats.cpp.

References doWindowCalculation(), and wnum_.

Referenced by initCinfo().

 {
     doWindowCalculation();
     return wnum_;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

double Stats::getWsdev ( ) const

Definition at line 227 of file Stats.cpp.

References doWindowCalculation(), and wsdev_.

Referenced by initCinfo().

 {
     doWindowCalculation();
     return wsdev_;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

double Stats::getWsum ( ) const

Definition at line 233 of file Stats.cpp.

References doWindowCalculation(), and wsum_.

Referenced by initCinfo().

 {
     doWindowCalculation();
     return wsum_;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

const Cinfo * Stats::initCinfo ( )

static

Definition at line 21 of file Stats.cpp.

References getMean(), getNum(), getSdev(), getSum(), getWindowLength(), getWmean(), getWnum(), getWsdev(), getWsum(), Neutral::initCinfo(), input(), process(), reinit(), requestOut(), setWindowLength(), and statsCinfo.

Referenced by SpikeStats::initCinfo().

 {
         // Field Definitions
         static ReadOnlyValueFinfo< Stats, double > mean(
             "mean",
             "Mean of all sampled values or of spike rate.",
             &Stats::getMean
         );
         static ReadOnlyValueFinfo< Stats, double > sdev(
             "sdev",
             "Standard Deviation of all sampled values, or of rate.",
             &Stats::getSdev
         );
         static ReadOnlyValueFinfo< Stats, double > sum(
             "sum",
             "Sum of all sampled values, or total number of spikes.",
             &Stats::getSum
         );
         static ReadOnlyValueFinfo< Stats, unsigned int > num(
             "num",
             "Number of all sampled values, or total number of spikes.",
             &Stats::getNum
         );
         static ValueFinfo< Stats, unsigned int > windowLength(
             "windowLength",
             "Number of bins for windowed stats. "
             "Ignores windowing if this value is zero. ",
             &Stats::setWindowLength,
             &Stats::getWindowLength
         );
         static ReadOnlyValueFinfo< Stats, double > wmean(
             "wmean",
             "Mean of sampled values or of spike rate within window.",
             &Stats::getWmean
         );
         static ReadOnlyValueFinfo< Stats, double > wsdev(
             "wsdev",
             "Standard Deviation of sampled values, or rate, within window.",
             &Stats::getWsdev
         );
         static ReadOnlyValueFinfo< Stats, double > wsum(
             "wsum",
             "Sum of all sampled values, or total number of spikes, within window.",
             &Stats::getWsum
         );
         static ReadOnlyValueFinfo< Stats, unsigned int > wnum(
             "wnum",
             "Number of all sampled values, or total number of spikes, "
             "within window.",
             &Stats::getWnum
         );
 
         // MsgDest Definitions
         static DestFinfo process( "process",
             "Handles process call",
             new ProcOpFunc< Stats >( &Stats::process ) );
         static DestFinfo reinit( "reinit",
             "Handles reinit call",
             new ProcOpFunc< Stats >( &Stats::reinit ) );
 
         static DestFinfo input( "input",
             "Handles continuous value input as a time-series. "
             "Multiple inputs are allowed, they will be merged. ",
             new OpFunc1< Stats, double >( &Stats::input ) );
 
         // SharedFinfo Definitions
         static Finfo* procShared[] = {
             &process, &reinit
         };
         static SharedFinfo proc( "proc",
             "Shared message for process and reinit",
             procShared, sizeof( procShared ) / sizeof( const Finfo* )
         );
 
     static Finfo* statsFinfos[] = {
         &mean,  // ReadOnlyValue
         &sdev,  // ReadOnlyValue
         &sum,   // ReadOnlyValue
         &num,   // ReadOnlyValue
         &wmean, // ReadOnlyValue
         &wsdev, // ReadOnlyValue
         &wsum,  // ReadOnlyValue
         &wnum,  // ReadOnlyValue
         &windowLength,  // Value
         &input,     // DestFinfo
         requestOut(),       // SrcFinfo
         &proc       // SharedFinfo
     };
 
     static Dinfo< Stats > dinfo;
     static Cinfo statsCinfo (
         "Stats",
         Neutral::initCinfo(),
         statsFinfos,
         sizeof( statsFinfos ) / sizeof ( Finfo* ),
         &dinfo
     );
 
     return &statsCinfo;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Stats::innerWindowCalculation ( )

Definition at line 268 of file Stats.cpp.

References isWindowDirty_, num_, samples_, wmean_, wnum_, wsdev_, and wsum_.

Referenced by doWindowCalculation().

 {
     if ( isWindowDirty_ ) {
         double wsumsq = 0.0;
         wsum_ = 0.0;
         unsigned int max = samples_.size();
         if ( max > num_ )
             max = num_;
         for ( unsigned int i = 0; i < max; ++i ) {
             wsum_ += samples_[i];
             wsumsq += samples_[i] * samples_[i];
         }
         if ( max > 0 ) {
             wmean_ = wsum_ / max;
             wsdev_ = sqrt( ( wsumsq - wsum_ * wsum_ / max ) / max );
         }
         wnum_ = max;
         isWindowDirty_ = false;
     }
 }

Here is the caller graph for this function:

void Stats::input ( double v )

Definition at line 183 of file Stats.cpp.

References isWindowDirty_, num_, samples_, sum_, and sumsq_.

Referenced by initCinfo(), SpikeStats::vProcess(), and vProcess().

 {
     sum_ += v;
     sumsq_ += v * v;
     if ( samples_.size() > 0 )
         samples_[ num_ % samples_.size() ] = v;
     ++num_;
     isWindowDirty_ = true;
 }

Here is the caller graph for this function:

void Stats::process	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 147 of file Stats.cpp.

References vProcess().

Referenced by initCinfo().

 {
     this->vProcess( e, p );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Stats::reinit	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 161 of file Stats.cpp.

References vReinit().

Referenced by initCinfo().

 {
     this->vReinit( e, p );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Stats::setWindowLength ( unsigned int len )

Definition at line 245 of file Stats.cpp.

References isWindowDirty_, and samples_.

Referenced by initCinfo().

 {
     if ( len < 1e6 ) {
         samples_.resize( len, 0.0 );
         isWindowDirty_ = true;
     } else {
         samples_.resize( 0 );
     }
 }

Here is the caller graph for this function:

void Stats::vProcess	(	const Eref &	e,
		ProcPtr	p
	)

virtual

Virtual func for handling process calls for derived classes.

Reimplemented in SpikeStats.

Definition at line 152 of file Stats.cpp.

References input(), and requestOut().

Referenced by process().

 {
     vector< double > v;
     requestOut()->send( e, &v );
     for ( vector< double >::const_iterator
                     i = v.begin(); i != v.end(); ++i )
         input( *i );
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void Stats::vReinit	(	const Eref &	e,
		ProcPtr	p
	)

virtual

Reimplemented in SpikeStats.

Definition at line 166 of file Stats.cpp.

References mean_, num_, samples_, sdev_, sum_, sumsq_, wmean_, wnum_, wsdev_, and wsum_.

Referenced by reinit(), and SpikeStats::vReinit().

 {
     mean_ = 0.0;
     sdev_ = 0.0;
     sum_ = 0.0;
     num_ = 0;
     sumsq_ = 0.0;
     wmean_ = 0.0;
     wsdev_ = 0.0;
     wsum_ = 0.0;
     wnum_ = 0;
     samples_.assign( samples_.size(), 0.0 );
 }