6.3.2. Scanner module and classes

Summary of the classes in the scanner module

Scanner([parent_widget, scanner_items, ...])

Main Object to define a PyMoDAQ scan and create a UI to set it

The scanner module contains all functionalities to defines a particular scan see Scanner.

class pymodaq.utils.scanner.Scanner(parent_widget: QtWidgets.QWidget = None, scanner_items={}, actuators: List[DAQ_Move] = [])

Main Object to define a PyMoDAQ scan and create a UI to set it

Parameters

• parent_widget (QtWidgets.QWidget) –

• scanner_items (list of GraphicItems) – used by ScanSelector for chosing scan area or linear traces

• actuators (List[DAQ_Move]) – list actuators names

See also

ScanSelector, ScannerBase, TableModelSequential, TableModelTabular, pymodaq_types.TableViewCustom

Attributes

actuators

list of str: Returns as a list the name of the selected actuators to describe the actual scan

axes_indexes

axes_unique

distribution

n_axes

n_steps

positions

scan_sub_type

scan_type

Methods

get_indexes_from_scan_index(scan_index)	To be reimplemented.
get_scan_info()	Get a summary of the configured scan as a ScanInfo object
get_scanner_sub_settings()	Get the current ScannerBase implementation's settings
set_scan()	Process the settings options to calculate the scan positions
set_scan_type_and_subtypes(scan_type, ...)	Convenience function to set the main scan type
value_changed(param)	Non-mandatory method to be subclassed for actions to perform (methods to call) when one of the param's value in self._settings is changed

connect_things
get_nav_axes
get_scan_shape
scanner_updated_signal
set_scan_from_settings
set_scanner
setup_ui
update_from_scan_selector

get_indexes_from_scan_index(scan_index: int) → Tuple[int]

To be reimplemented. Calculations of indexes within the scan

get_scan_info() → ScanInfo

Get a summary of the configured scan as a ScanInfo object

get_scanner_sub_settings()

Get the current ScannerBase implementation’s settings

set_scan()

Process the settings options to calculate the scan positions

Returns

bool

Return type

True if the processed number of steps if higher than the configured number of steps

set_scan_type_and_subtypes(scan_type: str, scan_subtype: str)

Convenience function to set the main scan type

Parameters

• scan_type (str) – one of registered Scanner main identifier

• scan_subtype (list of str or None) – one of registered Scanner second identifier for a given main identifier

See also

ScannerFactory

value_changed(param: Parameter)

Non-mandatory method to be subclassed for actions to perform (methods to call) when one of the param’s value in self._settings is changed

Parameters

param (Parameter) – the parameter whose value just changed

Examples

>>> if param.name() == 'do_something':
>>>     if param.value():
>>>         print('Do something')
>>>         self.settings.child('main_settings', 'something_done').setValue(False)

property actuators

Returns as a list the name of the selected actuators to describe the actual scan

Type

list of str