API

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
  • 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
    • SDBufferHeader
      • SDBufferHeader.battery_voltage
      • SDBufferHeader.data_length
      • SDBufferHeader.dropped_buffer_count
      • SDBufferHeader.length
      • SDBufferHeader.write_buffer_count
      • SDBufferHeader.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
  • 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.fs
      • StreamDaqConfig.header_len
      • StreamDaqConfig.num_buffers
      • StreamDaqConfig.pix_depth
      • StreamDaqConfig.port
      • StreamDaqConfig.preamble
      • StreamDaqConfig.show_video
      • StreamDaqConfig.preamble_to_bytes
      • StreamDaqConfig.resolve_relative
• exceptions
  • DeviceConfigurationError
  • DeviceError
  • DeviceOpenError
  • EndOfRecordingException
  • InvalidSDException
  • StreamError
  • StreamReadError
• Plots
  • Headers
    • battery_voltage()
    • buffer_count()
    • dropped_buffers()
    • plot_headers()
    • timestamps()
• Utils
  • hash_file()
  • hash_video()
• Stream DAQ
  • Command
  • Prerequisites
  • Configuration
    • Example Configuration
      • StreamDaq
        • StreamDaq.buffer_npix
        • StreamDaq.capture()
        • StreamDaq.init_video()
        • StreamDaq.nbuffer_per_fm
      • main()
• Vendor
  • OpalKelly FrontPanel