.. miniscope-io documentation master file, created by sphinx-quickstart on Tue Jun 27 10:52:50 2023. You can adapt this file completely to your liking, but it should at least contain the root toctree directive.

miniscope-io

• API
  • Data
    • Frame
      • Frame.data
      • Frame.headers
      • Frame.frame_nums_must_be_equal
      • Frame.frame_num
    • Frames
      • Frames.frames
      • Frames.flatten_headers()
      • Frames.to_df()
  • Formats
    • WireFreeSDLayout_Battery
  • io
    • SDCard
      • SDCard.check_valid()
      • SDCard.config
      • SDCard.frame
      • SDCard.frame_count
      • SDCard.position
      • SDCard.positions
      • SDCard.read()
      • SDCard.skip()
      • SDCard.to_video()
  • sdcard
    • BufferHeaderPositions
      • BufferHeaderPositions.battery_voltage
      • BufferHeaderPositions.buffer_count
      • BufferHeaderPositions.data_length
      • BufferHeaderPositions.dropped_buffer_count
      • BufferHeaderPositions.frame_buffer_count
      • BufferHeaderPositions.frame_num
      • BufferHeaderPositions.length
      • BufferHeaderPositions.linked_list
      • BufferHeaderPositions.timestamp
      • BufferHeaderPositions.write_buffer_count
      • BufferHeaderPositions.write_timestamp
    • ConfigPositions
      • ConfigPositions.buffer_size
      • ConfigPositions.fs
      • ConfigPositions.height
      • ConfigPositions.n_buffers_dropped
      • ConfigPositions.n_buffers_recorded
      • ConfigPositions.width
    • DataHeader
      • DataHeader.battery_voltage
      • DataHeader.buffer_count
      • DataHeader.data_length
      • DataHeader.dropped_buffer_count
      • DataHeader.frame_buffer_count
      • DataHeader.frame_num
      • DataHeader.length
      • DataHeader.linked_list
      • DataHeader.timestamp
      • DataHeader.write_buffer_count
      • DataHeader.write_timestamp
    • SDConfig
      • SDConfig.buffer_size
      • SDConfig.fs
      • SDConfig.height
      • SDConfig.n_buffers_dropped
      • SDConfig.n_buffers_recorded
      • SDConfig.width
    • SDHeaderPositions
      • SDHeaderPositions.battery_cutoff
      • SDHeaderPositions.delay_start
      • SDHeaderPositions.ewl
      • SDHeaderPositions.fs
      • SDHeaderPositions.gain
      • SDHeaderPositions.led
      • SDHeaderPositions.record_length
    • SDLayout
      • SDLayout.buffer
      • SDLayout.config
      • SDLayout.header
      • SDLayout.sectors
      • SDLayout.version
      • SDLayout.word_size
      • SDLayout.write_key0
      • SDLayout.write_key1
      • SDLayout.write_key2
      • SDLayout.write_key3
    • SectorConfig
      • SectorConfig.config
      • SectorConfig.data
      • SectorConfig.header
      • SectorConfig.size
  • exceptions
    • EndOfRecordingException
    • InvalidSDException
  • Plots
    • Headers
      • battery_voltage()
      • buffer_count()
      • dropped_buffers()
      • plot_headers()
      • timestamps()
  • Utils
    • hash_file()
• Changelog
  • 0.1.5 - 23-09-03
  • 0.1.4 - 23-09-03
  • 0.1.1 - 23-07-13
    • Additions
    • Bugfixes

Indices and tables

• :ref:genindex

• :ref:modindex

• :ref:search