8.3.2. Scanner module and classes
Summary of the classes in the scanner module
|
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_paragrah.
- class pymodaq.utils.scanner.Scanner(parent_widget: QtWidgets.QWidget = None, scanner_items={}, actuators: List[DAQ_Move] = [])[source]
Main Object to define a PyMoDAQ scan and create a UI to set it
- Parameters
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
- scanner
Methods
get_indexes_from_scan_index
(scan_index)To be reimplemented.
Get a summary of the configured scan as a ScanInfo object
Get the current ScannerBase implementation's settings
positions_at
(index)Extract the actuators positions at a given index in the scan as a DataToExport of DataActuators
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
save_scanner_settings
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] [source]
To be reimplemented. Calculations of indexes within the scan
- positions_at(index: int) DataToExport [source]
Extract the actuators positions at a given index in the scan as a DataToExport of DataActuators
- set_scan()[source]
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)[source]
Convenience function to set the main scan type
- Parameters
See also
ScannerFactory
- value_changed(param: Parameter)[source]
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)