.. 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

• Guide
  • Installation
    • Additional Dependencies
      • OpalKelly
        • Linux
        • Mac
        • Windows
  • Stream DAQ
    • Command
    • Prerequisites
    • Configuration
      • Example Configuration
        • StreamDaq
          • StreamDaq.buffer_npix
          • StreamDaq.capture()
          • StreamDaq.nbuffer_per_fm
        • main()

• 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()
  • Devices
    • OpalKelly
  • Formats
    • SDCard
      • WireFreeSDLayout_Battery
    • Stream
  • io
    • SDCard
      • SDCard.check_valid()
      • SDCard.config
      • SDCard.frame
      • SDCard.frame_count
      • SDCard.position
      • SDCard.positions
      • SDCard.read()
      • SDCard.skip()
      • SDCard.to_video()
  • Logging
    • init_logger()
  • Models
    • Container
    • MiniscopeConfig
    • MiniscopeIOModel
    • Buffer
      • BufferHeader
        • BufferHeader.buffer_count
        • BufferHeader.frame_buffer_count
        • BufferHeader.frame_num
        • BufferHeader.linked_list
        • BufferHeader.pixel_count
        • BufferHeader.timestamp
      • BufferHeaderFormat
        • BufferHeaderFormat.buffer_count
        • BufferHeaderFormat.frame_buffer_count
        • BufferHeaderFormat.frame_num
        • BufferHeaderFormat.linked_list
        • BufferHeaderFormat.pixel_count
        • BufferHeaderFormat.timestamp
    • Config
      • Config
        • Config.base_dir
        • Config.log_dir
        • Config.logs
        • Config.folder_exists
        • Config.paths_relative_to_basedir
      • LogConfig
        • LogConfig.file_n
        • LogConfig.file_size
        • LogConfig.level
        • LogConfig.level_file
        • LogConfig.level_stdout
        • LogConfig.inherit_base_level
        • LogConfig.uppercase_levels
    • Mixins
      • YAMLMixin
        • YAMLMixin.from_yaml()
    • Models
      • Container
      • MiniscopeConfig
      • MiniscopeIOModel
    • Stream
      • StreamBufferHeaderFormat
        • StreamBufferHeaderFormat.pixel_count
      • StreamDaqConfig
        • StreamDaqConfig.LSB
        • StreamDaqConfig.baudrate
        • StreamDaqConfig.bitstream
        • StreamDaqConfig.block_size
        • StreamDaqConfig.buffer_block_length
        • StreamDaqConfig.device
        • StreamDaqConfig.frame_height
        • StreamDaqConfig.frame_width
        • StreamDaqConfig.header_len
        • StreamDaqConfig.num_buffers
        • StreamDaqConfig.pix_depth
        • StreamDaqConfig.port
        • StreamDaqConfig.preamble
        • StreamDaqConfig.preamble_to_bytes
        • StreamDaqConfig.resolve_relative
  • exceptions
    • EndOfRecordingException
    • InvalidSDException
  • Plots
    • Headers
      • battery_voltage()
      • buffer_count()
      • dropped_buffers()
      • plot_headers()
      • timestamps()
  • Utils
    • hash_file()
  • Stream DAQ
    • Command
    • Prerequisites
    • Configuration
      • Example Configuration
        • StreamDaq
          • StreamDaq.buffer_npix
          • StreamDaq.capture()
          • StreamDaq.nbuffer_per_fm
        • main()
  • Vendor
    • OpalKelly FrontPanel

• Meta
  • Changelog
    • 0.1.8 - 24-06-16
    • 0.1.6 - 24-04-09
    • 0.1.5 - 23-09-03
    • 0.1.4 - 23-09-03
    • 0.1.1 - 23-07-13
      • Additions
      • Bugfixes
  • TODO

Indices and tables

• :ref:genindex

• :ref:modindex

• :ref:search