navigate Logo

Getting Started

  • Computer Considerations
  • Computer Power Configuration
  • Software Installation
  • Launching Navigate
  • Configuring Navigate
  • Acquiring Data
  • Smart Acquisition Routines

User Guide

  • Supported Hardware
  • Supported File Formats
  • User Interface Walkthrough
  • Setting Up a Microscope
  • Acquiring Data
  • Case Studies

Development

  • Contributing Guidelines
  • Developer Install
  • Software Architecture
  • Developer Architecture Concepts
  • Feature Container
  • REST API
  • Plugin Architecture
  • Adding New Hardware

Troubleshooting & Known Issues

  • Troubleshooting
  • Known Issues

Plugins

  • navigate Plugin Template
  • navigate Confocal Projection
  • navigate at Scale
  • navigate Constant Velocity Acquisition
  • navigate MMCore
  • navigate ilastik Server
  • navigate Photoactivation

Reference

  • Implemented Microscopes
  • Software API
    • navigate.config
    • navigate.controller
    • navigate.controller.configurator
    • navigate.log_files
    • navigate.model
      • navigate.model.analysis
      • navigate.model.concurrency
      • navigate.model.data_sources
      • navigate.model.device_startup_functions
      • navigate.model.devices
        • navigate.model.devices.MonitoredSerial
        • navigate.model.devices.camera
        • navigate.model.devices.configuration_schema
        • navigate.model.devices.daq
        • navigate.model.devices.device_types
        • navigate.model.devices.filter_wheel
        • navigate.model.devices.galvo
        • navigate.model.devices.laser
        • navigate.model.devices.mirror
        • navigate.model.devices.objectives
        • navigate.model.devices.pump
        • navigate.model.devices.remote_focus
        • navigate.model.devices.shutter
        • navigate.model.devices.stage
        • navigate.model.devices.zoom
      • navigate.model.features
      • navigate.model.metadata_sources
      • navigate.model.microscope
      • navigate.model.model
      • navigate.model.plugins_model
      • navigate.model.resolution_change
      • navigate.model.waveforms
    • navigate.tools
    • navigate.view
navigate
  • Software API
  • navigate.model
  • navigate.model.devices
  • navigate.model.devices.camera
  • navigate.model.devices.camera.format
  • navigate.model.devices.camera.format.CameraImageFormat
  • View page source

navigate.model.devices.camera.format.CameraImageFormat

class navigate.model.devices.camera.format.CameraImageFormat(dtype: str = 'uint16', bit_depth: Optional[int] = None)

Bases: object

Describe unpacked, right-aligned monochrome arrays delivered by a driver.

Parameters:
  • dtype (str) – Unsigned array type: uint8 or uint16. Legacy drivers use uint16.

  • bit_depth (int, optional) – Number of meaningful output bits. None means unknown, even when the storage width is known. It is not inferred from an image’s maximum value.

__init__(dtype: str = 'uint16', bit_depth: Optional[int] = None) → None

Methods

__init__([dtype, bit_depth])

for_bit_depth(bit_depth)

Choose the smallest supported array type preserving all output bits.

Attributes

  • bit_depth

  • bytes_per_pixel

  • dtype

classmethod for_bit_depth(bit_depth: int) → CameraImageFormat

Choose the smallest supported array type preserving all output bits.

Parameters:

bit_depth (int) – Confirmed camera output precision, from 1 to 16 bits.

Returns:

An unsigned byte or unsigned 16-bit word format.

Return type:

CameraImageFormat

bit_depth: Optional[int] = None
property bytes_per_pixel: int

Return storage bytes per pixel, independently of meaningful bits.

dtype: str = 'uint16'
Previous Next

© Copyright 2026, Dean Lab, UT Southwestern Medical Center.