openflexure_microscope_server.scan_planners.VisitedScanLocation

class documentation

class VisitedScanLocation: (source)

Data for information on locations already visited during a 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 xyz-position or xy-position if z isn't available.
Method	`__init__`	Initialise VisitedScanLocation with an xyz-position, and whether imaged/focused.
Instance Variable	`focused`	Undocumented
Instance Variable	`imaged`	Undocumented
Instance Variable	`planner_data`	Undocumented
Property	`xy_tuple`	The xy position tuple.
Property	`xyz_tuple`	The xyz position tuple.
Instance Variable	`_xyz_pos`	Undocumented

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

Check for equality, only checks the xyz-position or xy-position if z isn't available.

Will check xyz-position against 3-value tuples and other VisitedScanLocation objects.

Will check xy-position against 2-value tuples and FutureScanLocation objects.

def __init__(self, xyz_pos: XYZPos, imaged: bool, focused: bool, **kwargs: Any): (source) ¶

Initialise VisitedScanLocation with an xyz-position, and whether imaged/focused.

Parameters
xyz_pos:`XYZPos`	The (x, y, z) position visited.
imaged:`bool`	True if an image was taken, False if not (due to background detect)
focused:`bool`	True if autofocus completed successfully
**kwargs:`Any`	Any other information about the location. This should be passed through to from the FutureScanLocation object that requested the location to be scanned.

Undocumented

Undocumented

Undocumented

@property

The xy position tuple.

@property

The xyz position tuple.

Undocumented