openflexure_microscope_server.scan_planners.FutureScanLocation

class documentation

class FutureScanLocation: (source)

Data for information on future locations to scan.

This object is only used for internal calculation and data storage it shouldn't be an input or output of public methods.

Method	`__eq__`	Check for equality, only checks the xy position.
Method	`__init__`	Initialise FutureScanLocation with an xy position.
Instance Variable	`planner_data`	Undocumented
Property	`xy_tuple`	The xy position tuple.
Instance Variable	`_xy_pos`	Undocumented

def __eq__(self, other: Any) -> bool: (source) ¶

Check for equality, only checks the xy position.

Will check against tuple or other FutureScanLocation object.

def __init__(self, xy_pos: XYPos, **kwargs: Any): (source) ¶

Initialise FutureScanLocation with an xy position.

Parameters
xy_pos:`XYPos`	The (x, y) position to scan.
**kwargs:`Any`	Any other information about the location. This will be passed through to the VisitedScanLocation object.

Undocumented

@property

The xy position tuple.

Undocumented