Welcome to Project HAL’s documentation!

• Project Overview
• Getting Started
  • Folder Structure
• Experiment Results
• Python Modules
  • hal
    • Overview
    • Members
      • build_frequency_list()
      • build_training_sequences()
      • connect_stim_units_to_stim_electrodes()
      • get_electrode_square()
      • get_file_names()
      • init_well()
      • make_trial_folders()
      • make_trial_folders_parallel()
      • make_trial_folders_raw()
      • power_up_stim_units()
      • write_closed_loop_args()
      • write_exp_description()
      • write_exp_notes()
      • write_frequency_list()
      • write_stim_electrodes()
  • stimulation
    • Overview
    • Members
      • ArbitraryStimulation
        • ArbitraryStimulation.build_sequence()
        • ArbitraryStimulation.get_duration()
      • Stimulation
        • Stimulation.combine_stimuli()
        • Stimulation.from_frequency()
  • world_stimulation
    • Overview
    • Members
      • ObjectDistanceParams
      • build_distance_stimuli()
  • config
    • Overview
    • Members
      • read_config()
      • read_config_elecs()
      • read_config_electrode_to_channel()
  • plotter
    • Overview
    • Members
      • Plotter
        • Plotter.plot_frequency_game()
• C++ Modules
  • 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()