openflexure_microscope_server.scan_planners.RegularGridPlanner

class documentation

class RegularGridPlanner(RectGridPlanner): (source)

A scan planner that performs a snake or a raster scan.

Direction cannot yet be set it always scans, right and down from a corner.

This planner starts at the corner of the region to scan, snaking back and forth, starting moving right and down (assuming positive dx and dy.)

Method	`_initial_location_list`	Set the initial list of locations for this scan planner.
Method	`_parse`	Parse any settings sent to this planner and store them if needed.
Instance Variable	`_style`	Undocumented
Instance Variable	`_x_count`	Undocumented
Instance Variable	`_y_count`	Undocumented

Inherited from RectGridPlanner:

Method	`moves_between`	Return displacement in grid-move units as a numpy array [dx_moves, dy_moves].
Method	`select_nearby_focus_site`	Return a focused site near the given position to estimate Z for the next move.
Method	`_adjacent_positions`	Undocumented
Method	`_intermediate_position`	Return an (x,y) position halfway between two input positions.
Instance Variable	`_dx`	Undocumented
Instance Variable	`_dy`	Undocumented

Inherited from ScanPlanner (via RectGridPlanner):

Method	`__init__`	Set up lists for the path planning, and scan history.
Method	`get_next_location_and_z_estimate`	Return the next location to scan and its estimated z-position.
Method	`get_visited_location`	Return the scan location from the history that matches the input position.
Method	`mark_location_visited`	Mark the location as visited.
Method	`position_planned`	Return True if input scan position position is planned.
Method	`position_visited`	Return True if input scan position has been visited before.
Property	`focused_locations`	Property to access a copy of the focused_locations.
Property	`focused_locations_xyz`	Property to access a copy of the focused_locations.
Property	`imaged_locations`	Property to access a copy of the imaged_locations.
Property	`path_history`	Property to access a copy of the path_history.
Property	`remaining_locations`	Property to access a copy of the remaining_locations.
Property	`scan_complete`	Return True if there are no locations left to scan.
Method	`_grid_to_future_locations`	Flatten a 2D grid of coordinates into flat list of FutureScanLocation objects.
Instance Variable	`_initial_position`	Undocumented
Instance Variable	`_path_history`	Undocumented
Instance Variable	`_remaining_locations`	Undocumented

def _initial_location_list(self) -> list[FutureScanLocation]: (source) ¶

overrides openflexure_microscope_server.scan_planners.ScanPlanner._initial_location_list

Set the initial list of locations for this scan planner.

This is called on initialisation.

For snake scan, this is the full grid, and none will be added during scanning.

def _parse(self, planner_settings: dict | None = None): (source) ¶

overrides openflexure_microscope_server.scan_planners.RectGridPlanner._parse

Parse any settings sent to this planner and store them if needed.

_style: Literal['snake', 'raster'] = (source) ¶

Undocumented

Undocumented

Undocumented