navigate Logo

Getting Started

  • Quick Start Guide
  • Software Installation
  • I Want To…

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
  • Feature Container
  • REST-API
  • Plugin Architecture

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.log_files
    • navigate.model
      • navigate.model.analysis
      • navigate.model.concurrency
      • navigate.model.data_sources
      • navigate.model.device_startup_functions
      • navigate.model.devices
      • navigate.model.features
        • navigate.model.features.adaptive_optics
        • navigate.model.features.auto_tile_scan
        • navigate.model.features.autofocus
        • navigate.model.features.common_features
        • navigate.model.features.feature_container
        • navigate.model.features.feature_related_functions
        • navigate.model.features.image_writer
        • navigate.model.features.remove_empty_tiles
        • navigate.model.features.restful_features
        • navigate.model.features.update_setting
        • navigate.model.features.volume_search
      • navigate.model.metadata_sources
      • navigate.model.microscope
      • navigate.model.model
      • navigate.model.plugins_model
      • navigate.model.waveforms
    • navigate.tools
    • navigate.view
navigate
  • Acquiring Data
  • Currently Implemented Features
  • navigate.model.features.common_features
  • navigate.model.features.common_features.Snap
  • View page source

navigate.model.features.common_features.Snap

class navigate.model.features.common_features.Snap(model, saving_flag=False)

Bases: object

Snap class for capturing data frames using a microscope.

This class provides functionality to capture data frames using a microscope and log information about the camera and frame IDs.

Notes:

  • This class is used to capture data frames using a microscope and log

relevant information, such as the active camera and frame IDs.

  • The Snap class is typically used for capturing individual frames during

microscopy experiments.

  • The data capture process involves capturing frames and logging

camera-related information.

  • The config_table attribute is used to define the configuration for the

data capture process, specifically the main data capture function.

__init__(model, saving_flag=False)

Initialize the Snap class.

Parameters:

modelMicroscopeModel

The microscope model object used for data capture.

Methods

__init__(model[, saving_flag])

Initialize the Snap class.

data_func(frame_ids)

Capture data frames and log camera information.

signal_func()

Mark saving flags in the signal function

Attributes

model

The microscope model associated with the data capture.

saving_flag

Saving each frames

config_table

A dictionary defining the configuration for the data capture process.

data_func(frame_ids: list) → bool

Capture data frames and log camera information.

This method captures data frames using the microscope and logs information about the active camera and the provided frame IDs.

Parameters:

frame_idslist

A list of frame IDs for which data frames should be captured.

Returns:

bool

A boolean value indicating the success of the data capture process.

signal_func() → bool

Mark saving flags in the signal function

config_table

A dictionary defining the configuration for the data capture process.

Type:

dict

model

The microscope model associated with the data capture.

Type:

MicroscopeModel

saving_flag

Saving each frames

Type:

bool

Previous Next

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