C++ Modules

The HAL C++ modules come in two varieties:

• Experiment Logic: these modules are used at the core of the data processing for the closed-loop experiments

  • ElectrodeMap

  • ChannelWindow

  • Controller

  • NES

  • StimVector

  • WaveDetector

  • WorldState

• General Purpose: these modules were made to either simplify code or add useful visualizations

  • Plotter

  • ProgressBar

  • argparse Module

Index

• ElectrodeMap
  • Overview
  • Members
    • ElectrodeMap
      • ElectrodeMap::ElectrodeMap()
      • ElectrodeMap::ElectrodeMap()
      • ElectrodeMap::exists()
      • ElectrodeMap::get()
      • ElectrodeMap::getPosition()
      • ElectrodeMap::getX()
      • ElectrodeMap::getY()
      • ElectrodeMap::size()
      • ElectrodeMap::print()
• ChannelWindow
  • Overview
  • Members
    • ChannelWindow
      • ChannelWindow::ChannelWindow()
      • ChannelWindow::ChannelWindow()
      • ChannelWindow::init()
      • ChannelWindow::shift()
      • ChannelWindow::get()
      • ChannelWindow::length()
      • ChannelWindow::totalSpikeCount()
      • ChannelWindow::numChannels()
      • ChannelWindow::electrodeMap()
      • ChannelWindow::avgPastWindows()
      • ChannelWindow::getAvgX()
      • ChannelWindow::firingRateSD()
      • ChannelWindow::firingRate()
      • ChannelWindow::pastWindowsReady()
      • ChannelWindow::print()
      • ChannelWindow::debug()
• Controller
  • Overview
  • Members
    • Controller
      • Controller::Controller()
      • Controller::~Controller()
      • Controller::addButton()
      • Controller::init()
      • Controller::getButtonWindow()
      • Controller::buttonExists()
      • Controller::shift()
      • Controller::numChannels()
      • Controller::numSpikes()
• NES
  • Overview
    • CSV output
  • Members
    • NES
      • NES::NES()
      • NES::NES()
      • NES::NES()
      • NES::~NES()
      • NES::checkButtons()
• StimVector
  • Overview
  • Timeline Behavior
  • Usage Notes
  • Integration
  • See Also
  • Documentation note
• WaveDetector
  • Overview
  • Conceptual Timeline
  • Key Features
  • Typical Usage
  • Burst Detection Parameters
  • Return Values
  • Members
    • WaveDetector
      • WaveDetector::WaveDetector()
      • WaveDetector::WaveDetector()
      • WaveDetector::~WaveDetector()
      • WaveDetector::getWindow()
      • WaveDetector::getMetadata()
      • WaveDetector::shiftWindow()
      • WaveDetector::processFrame()
      • WaveDetector::checkBurst()
    • WaveMetadata
      • WaveMetadata::burstOnsetComplete
      • WaveMetadata::bursting
      • WaveMetadata::burstStartFrame
      • WaveMetadata::burstStartSpikeCount
      • WaveMetadata::burstStartLocation
      • WaveMetadata::maxSpikes
      • WaveMetadata::maxSpikesFrame
      • WaveMetadata::maxSpikesLoc
      • WaveMetadata::framesAboveThreshold
      • WaveMetadata::noSpikeFrameCount
    • Wave
      • Wave::noBurst
      • Wave::bursting
      • Wave::burstStart
      • Wave::endShortBurst
      • Wave::burstOnLeft
      • Wave::burstOnRight
  • Old Example
  • See Also
• WorldState
  • Overview
  • Members
    • WorldState
      • WorldState::WorldState()
      • WorldState::display()
      • WorldState::moveLeft()
      • WorldState::moveRight()
      • WorldState::getPosition()
• Plotter
  • Overview
  • Members
    • Plotter
      • Plotter::Plotter()
      • Plotter::sync()
      • Plotter::sendFrequencyGameData()
      • Plotter::close()
• ProgressBar
  • Overview
  • Members
• argparse Module
  • Overview
  • Members
    • argparse
      • argparse::checkOption()
      • argparse::getStringArg()
      • argparse::getIntArg()
      • argparse::getFloatArg()
      • argparse::getStringArgSecure()
      • argparse::getIntArgSecure()
      • argparse::getFloatArgSecure()