Blackchirp

Getting Started

  • Installation
  • First Run
  • Application Configuration
  • User Interface Overview

Hardware Setup

  • Hardware and Library Configuration
  • Python Hardware
  • Hardware Menu
  • Hardware Details

Running Experiments

  • Experiment Setup
  • FTMW Configuration
  • LIF Configuration

Inspecting Data

  • Viewing FTMW Data
  • Viewing LIF Data
  • Rolling/Aux Data
  • Application Log
  • Overlays
  • Plot Controls

Offline Analysis

  • Python Module
  • Blackchirp Viewer

Data Format and Diagnostics

  • Data Storage
  • Crash Reports

Contributing

  • Developer Guide
  • Conventions and Style
  • Build System and Project Layout
  • Packaging and Release CI
  • Python Module

Architecture

  • Architecture
  • Experiment Lifecycle
  • Persistence
  • Crash Handling and Triage
  • API Reference
    • AcquisitionManager
    • ApplicationConfigManager
    • AuxDataStorage
    • BatchManager
    • BlackchirpCSV
    • Blackchirp Plot Curve Classes
    • CatalogParser
    • ChirpConfig
    • ClickableLabel
    • ClockManager
    • CommunicationProtocol
    • CurveAppearance and CurveAppearanceWidget
    • CurveFactory and CurveStorageInterface
    • CustomInstrument
    • DataStorageBase
    • EnumComboBox
    • Experiment
    • ExperimentConfigPage
    • Fid
    • FidStorageBase
    • FileParser
    • FileParserRegistry
    • Ft
    • FtmwConfig
    • FtWorker
    • GenericXYParser
    • HardwareLoadout
    • HardwareManager
    • HardwareObject
    • HardwareProfileManager
    • HardwareRegistry
    • HeaderStorage
    • HwSettingsWidget
    • LifConfig
    • LifStorage
    • LoadoutManager
    • LogHandler
    • OverlayBase and OverlayStorage
    • PythonHardwareBase
    • PythonProcess
    • RfConfig
    • RfConfigSnapshot
    • RuntimeHardwareConfig
    • ScientificSpinBox
    • SettingsStorage
    • SettingsTable
    • SPCATParser
    • ThemeColors
    • VendorLibrary
    • WaveformBuffer and WaveformEntry
    • XIAMParser
    • ZoomPanPlot

Hardware Subsystem

  • Hardware Configuration
  • Hardware Runtime
  • Python Hardware
  • Vendor Libraries

Acquisition Pipelines

  • FTMW Acquisition and Visualization
  • LIF Acquisition and Visualization

Extending Blackchirp

  • Adding a New Hardware Driver
  • Adding a New Hardware Type
  • Adding an Experiment Mode

Version History

  • Migration Guide
  • Changelog
Index
Blackchirp
  • API Reference
  • View page source

API Reference

A selection of documented C++ classes important for developing new hardware drivers and other Blackchirp extensions. For help with adding hardware support, visit the Discord server. Contributions to this reference are welcome.

Contents:

  • AcquisitionManager
  • ApplicationConfigManager
  • AuxDataStorage
  • BatchManager
  • BlackchirpCSV
  • Blackchirp Plot Curve Classes
  • CatalogParser
  • ChirpConfig
  • ClickableLabel
  • ClockManager
  • CommunicationProtocol
  • CurveAppearance and CurveAppearanceWidget
  • CurveFactory and CurveStorageInterface
  • CustomInstrument
  • DataStorageBase
  • EnumComboBox
  • Experiment
  • ExperimentConfigPage
  • Fid
  • FidStorageBase
  • FileParser
  • FileParserRegistry
  • Ft
  • FtmwConfig
  • FtWorker
  • GenericXYParser
  • HardwareLoadout
  • HardwareManager
  • HardwareObject
  • HardwareProfileManager
  • HardwareRegistry
  • HeaderStorage
  • HwSettingsWidget
  • LifConfig
  • LifStorage
  • LoadoutManager
  • LogHandler
  • OverlayBase and OverlayStorage
  • PythonHardwareBase
  • PythonProcess
  • RfConfig
  • RfConfigSnapshot
  • RuntimeHardwareConfig
  • ScientificSpinBox
  • SettingsStorage
  • SettingsTable
  • SPCATParser
  • ThemeColors
  • VendorLibrary
  • WaveformBuffer and WaveformEntry
  • XIAMParser
  • ZoomPanPlot
Previous Next

© Copyright 2026, Kyle Crabtree.

Built with Sphinx using a theme provided by Read the Docs.