navigate.model.features.volume_search.VolumeSearch3D
- class navigate.model.features.volume_search.VolumeSearch3D(model, target_resolution='Nanoscale', target_zoom='N/A', position_id=0, z_step_size=0.1, x_direction='x', y_direction='y', overlap=0.05, analysis_function=None, current_pixel_size=1.0, filter_pixel_number=10)
Bases:
FeatureBase- __init__(model, target_resolution='Nanoscale', target_zoom='N/A', position_id=0, z_step_size=0.1, x_direction='x', y_direction='y', overlap=0.05, analysis_function=None, current_pixel_size=1.0, filter_pixel_number=10)
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
position_id (int) – The index of position in multiposition table
z_step_size (float) – Target z step size
overlap (float) – The overlap ratio
analysis_function (callable) – An analysis function return a labeled object
current_pixel_size (float) – The current pixel size
filter_pixel_number (int) – The pixel number to filter a label
Methods
__init__(model[, target_resolution, ...])Initialize VolumeSearch
cleanup()data_func(frame_ids)Attributes
- cleanup()
- data_func(frame_ids)
- analysis_function
analysis function
- Type:
function
- config_table
Feature configuration
- Type:
dict
- current_pixel_size
The current pixel size
- Type:
float
- filter_pixel_number
The filter pixel number
- Type:
int
- model
Navigate Model
- overlap
The overlap ratio
- Type:
float
- parameter_schema = {'analysis_function': SettingSpec(value_type=<class 'str'>, default=None, label='Analysis Function', help_text='Optional analysis callable. Leave empty for the default analysis.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=False, dynamic_source=None, depends_on=None), 'current_pixel_size': SettingSpec(value_type=<class 'float'>, default=1.0, label='Current Pixel Size', help_text='Pixel size for the current microscope.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=None, step=0.1, required=True, dynamic_source=None, depends_on=None), 'filter_pixel_number': SettingSpec(value_type=<class 'int'>, default=10, label='Filter Pixel Number', help_text='Minimum labeled-object pixel count kept by the filter.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=None, step=1, required=True, dynamic_source=None, depends_on=None), 'overlap': SettingSpec(value_type=<class 'float'>, default=0.05, 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), 'position_id': SettingSpec(value_type=<class 'int'>, default=0, label='Position ID', help_text='Index of the multi-position row used as the search seed.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=None, step=1, 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'), 'x_direction': SettingSpec(value_type=<class 'str'>, default='x', label='X Direction', help_text='Stage axis used as the search x direction.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'y_direction': SettingSpec(value_type=<class 'str'>, default='y', label='Y Direction', help_text='Stage axis used as the search y direction.', choices=None, choice_values=None, minimum=None, exclusive_minimum=None, maximum=None, step=None, required=True, dynamic_source=None, depends_on=None), 'z_step_size': SettingSpec(value_type=<class 'float'>, default=0.1, label='Z Step Size', help_text='Target z-step size for the 3D search.', choices=None, choice_values=None, minimum=0, exclusive_minimum=None, maximum=None, step=0.1, required=True, dynamic_source=None, depends_on=None)}
- position_id
The index of position
- 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
- x_direction
string
- y_direction
string
- z_step
The Z step size
- Type:
float