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.features
        • navigate.model.features.adaptive_optics
        • navigate.model.features.auto_tile_scan
        • navigate.model.features.autofocus
        • navigate.model.features.base
        • navigate.model.features.common_features
        • navigate.model.features.feature_container
        • navigate.model.features.feature_related_functions
        • navigate.model.features.image_writer
        • navigate.model.features.parameter_tools
        • 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.resolution_change
      • navigate.model.waveforms
    • navigate.tools
    • navigate.view
navigate
  • Acquiring Data
  • Currently Implemented Features
  • navigate.model.features.volume_search
  • navigate.model.features.volume_search.VolumeSearch
  • View page source

navigate.model.features.volume_search.VolumeSearch

class navigate.model.features.volume_search.VolumeSearch(model, target_resolution='Nanoscale', target_zoom='N/A', flipx=False, flipy=False, overlap=0.1, debug=False)

Bases: FeatureBase

VolumeSearch.

Find the outer boundary of a tissue, moving the stage through z. Assumes there is no tissue out-of-frame in the x,y-directions.

Construct a list of stage positions that will tile the entire tissue boundary in x,y,z at target_resolution, target_zoom. Current resolution and zoom is self.model.active_microscope_name and self.model.configuration[“experiment”][“MicroscopeState”][“zoom”].

__init__(model, target_resolution='Nanoscale', target_zoom='N/A', flipx=False, flipy=False, overlap=0.1, debug=False)

Initialize VolumeSearch

Parameters:
  • model (navigate.model.model.Model) – Navigate Model

  • target_resolution (str) – Name of microscope to use for tiled imaging of tissue

  • target_zoom (str) – Resolution of microscope (target_resolution) to use for tiled imaging of tissue

  • flipx (bool) – Flip the direction in which new tiles are added.

  • flipy (bool) – Flip the direction in which new tiles are added.

  • overlap (float) – Value between 0 and 1 indicating percent overlap of tiles.

  • debug (bool) – If True, save debug images to disk.

Methods

__init__(model[, target_resolution, ...])

Initialize VolumeSearch

cleanup()

Cleanup function

data_func(frame_ids)

Data function.

end_data_func()

End data function.

init_data_func()

Initialize data function

pre_signal_func()

Initialize signal function

signal_end()

Signal end function.

signal_func()

Signal function.

signal_response_func(*args)

Signal response function.

Attributes

  • parameter_schema

  • model

  • target_resolution

  • target_zoom

  • z_steps

  • z_step_size

  • z_pos

  • f_step_size

  • f_pos

  • f_offset

  • curr_z_index

  • sinx

  • siny

  • overlap

  • has_tissue_queue

  • direction

  • has_tissue

  • first_boundary

  • pre_boundary

  • end_flag

  • config_table

  • debug

  • volumes_selected

cleanup()

Cleanup function

data_func(frame_ids)

Data function.

Find the tissue boundary in the current frame.

Parameters:

frame_ids (list) – List of frame ids to process.

Returns:

True if the data function should be called again.

Return type:

bool

end_data_func()

End data function.

Map the tissue boundary to stage positions.

Returns:

True if the search is complete.

Return type:

bool

init_data_func()

Initialize data function

pre_signal_func()

Initialize signal function

signal_end()

Signal end function.

Check if the search is complete.

Returns:

True if the search is complete.

Return type:

bool

signal_func()

Signal function.

Move the stage to the next z-position.

Returns:

True if the signal function should be called again.

Return type:

bool

signal_response_func(*args)

Signal response function.

Check if tissue was found. If not, move the stage to the next z-position.

Returns:

True if the signal function should be called again.

Return type:

bool

config_table

Feature configuration

Type:

dict

curr_z_index

Current z-index

Type:

int

debug

True if debug mode is enabled

Type:

bool

direction

1 if moving up, -1 if moving down

Type:

int

end_flag

True if the search is complete

Type:

bool

f_offset

Current z-index

Type:

int

f_pos

Current focus position

Type:

float

f_step_size

Size of focus step

Type:

float

first_boundary

Boundary of tissue

Type:

dict

has_tissue

True if tissue was found

Type:

bool

has_tissue_queue

Queue for communicating whether tissue was found

Type:

Queue

model

Navigate Model

Type:

navigate.model.model.Model

overlap

Percent overlap of tiles

Type:

float

parameter_schema = {'debug': SettingSpec(value_type=<class 'bool'>, default=False, label='Debug', help_text='Save debug images while calculating the tissue boundary.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'flipx': SettingSpec(value_type=<class 'bool'>, default=False, label='Flip X', help_text='Reverse the x direction when adding tiles.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'flipy': SettingSpec(value_type=<class 'bool'>, default=False, label='Flip Y', help_text='Reverse the y direction when adding tiles.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'overlap': SettingSpec(value_type=<class 'float'>, default=0.1, label='Overlap', help_text='Tile overlap fraction from 0 to 1.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=1, step=0.01, required=True, dynamic_source=None, depends_on=None), 'target_resolution': SettingSpec(value_type=<class 'str'>, default='Nanoscale', label='Target Resolution', help_text='Microscope/resolution used for tiled follow-up imaging.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source='microscopes', depends_on=None), 'target_zoom': SettingSpec(value_type=<class 'str'>, default='N/A', label='Target Zoom', help_text='Zoom value used for tiled follow-up imaging.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source='zoom_values', depends_on='target_resolution')}
pre_boundary

Boundary of tissue

Type:

dict

sinx

1 if flipx is False, -1 if flipx is True

Type:

int

siny

1 if flipy is False, -1 if flipy is True

Type:

int

target_resolution

Name of microscope to use for tiled imaging of tissue

Type:

str

target_zoom

Resolution of microscope (target_resolution) to use for tiled imaging

Type:

str

volumes_selected

Debug image

Type:

np.ndarray

z_pos

Current z-position

Type:

float

z_step_size

Size of z-step

Type:

float

z_steps

Number of z-steps to take

Type:

int

Previous Next

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