Public Member Functions | Private Attributes
BurstChecker Class Reference

Helper class for the burst_creator node. More...

#include <burst_checker.h>

List of all members.

Public Member Functions

 BurstChecker ()
 Sets values to their initial states.
bool endOfBurst ()
const burst_calc::burst & getBurst ()
const ros::Time * getTimePtr ()
 Returns a pointer to the start time of the burst.
void init (int index, double baseline, double threshold, int burst_window)
 Gives the object values needed for later calculations.
bool isBursting ()
void reset ()
 Resets the burst checker.
void update (const neuro_recv::dish_state &d)
 Updates the burst checker with a new dish state.

Private Attributes

double baseline_
burst_calc::burst burst_
int burst_window_
bool end_of_burst_
int frame_count_
int index_
bool is_bursting_
bool is_possible_burst_
int spike_count_
double threshold_

Detailed Description

Helper class for the burst_creator node.

Monitors a single channel for bursting activity. A burst is defined as 3 or more spikes in a period in which the activity does not drop below baseline.

Author:
Jonathan Hasenzahl

Definition at line 22 of file burst_checker.h.


Constructor & Destructor Documentation

Sets values to their initial states.

Definition at line 13 of file burst_checker.cpp.


Member Function Documentation

bool BurstChecker::endOfBurst ( ) [inline]

Definition at line 33 of file burst_checker.h.

const burst_calc::burst& BurstChecker::getBurst ( ) [inline]

Definition at line 31 of file burst_checker.h.

const ros::Time * BurstChecker::getTimePtr ( )

Returns a pointer to the start time of the burst.

Returns:
if there is a possible burst, returns a pointer to the start time of the; returns a null pointer otherwise

Definition at line 144 of file burst_checker.cpp.

void BurstChecker::init ( int  index,
double  baseline,
double  threshold,
int  burst_window 
)

Gives the object values needed for later calculations.

Parameters:
indexthe index of the channel, from 0 to 59
baselinethe baseline voltage of the channel
thresholdthe spike threshold of the channel
burst_windowthe size (in dish states) of the burst window

Definition at line 29 of file burst_checker.cpp.

bool BurstChecker::isBursting ( ) [inline]

Definition at line 32 of file burst_checker.h.

Resets the burst checker.

This should be called after the end of a burst has been detected (isBursting) and the burst has been retrieved (getBurst).

Definition at line 131 of file burst_checker.cpp.

void BurstChecker::update ( const neuro_recv::dish_state &  d)

Updates the burst checker with a new dish state.

This method contains the logic for determining if a burst is occurring on this channel.

Parameters:
dthe dish state being added

Definition at line 47 of file burst_checker.cpp.


Member Data Documentation

double BurstChecker::baseline_ [private]

Definition at line 38 of file burst_checker.h.

burst_calc::burst BurstChecker::burst_ [private]

Definition at line 36 of file burst_checker.h.

Definition at line 45 of file burst_checker.h.

Definition at line 44 of file burst_checker.h.

Definition at line 40 of file burst_checker.h.

int BurstChecker::index_ [private]

Definition at line 37 of file burst_checker.h.

Definition at line 42 of file burst_checker.h.

Definition at line 43 of file burst_checker.h.

Definition at line 41 of file burst_checker.h.

double BurstChecker::threshold_ [private]

Definition at line 39 of file burst_checker.h.


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


burst_calc
Author(s): Jonathan Hasenzahl
autogenerated on Sun Jan 5 2014 11:12:30