8.5.5.7. pymodaq_gui.plotting.navigator module

class pymodaq_gui.plotting.navigator.Navigator(parent=None, h5file_path=None)

Bases: ParameterManager, ActionManager, QObject

Attributes:

h5saver

Methods

param_deleted(param)	Non-mandatory method to be subclassed for actions to perform when one of the param in self.settings has been deleted
setup_actions()	Method where to create actions to be subclassed.
update_status(txt[, status_time, log_type])	Show the txt message in the status bar with a delay of status_time ms.
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

add_image_data
connect_things
get_data_from_scan_name
list_2D_scans
load_data
load_image
log_signal
move_at
remove_image_data
set_aspect_ratio
set_axes
setup_ui
show_all
show_histo
show_none
show_scans
sig_double_clicked
update_h5file

add_image_data(dwa: DataWithAxes)

connect_things()

get_data_from_scan_name(scan_name: str) → DataToExport

list_2D_scans()

load_data()

load_image()

move_at(posx, posy)

param_deleted(param)

Non-mandatory method to be subclassed for actions to perform when one of the param in self.settings has been deleted

For this to be triggered, the Parameter method: removeChild should be used

Parameters:

param (Parameter) – the parameter that has been deleted

remove_image_data(param)

set_aspect_ratio()

set_axes(dwa: DataWithAxes)

setup_actions()

Method where to create actions to be subclassed. Mandatory

Examples

>>> self.add_action('Quit', 'close2', "Quit program")
>>> self.add_action('Grab', 'camera', "Grab from camera", checkable=True)
>>> self.add_action('Load', 'Open', "Load target file (.h5, .png, .jpg) or data from camera", checkable=False)
>>> self.add_action('Save', 'SaveAs', "Save current data", checkable=False)

See also

ActionManager.add_action

setup_ui()

show_all()

show_histo()

show_none()

show_scans(show=True)

update_h5file(h5file)

update_status(txt, status_time=0, log_type=None)

Show the txt message in the status bar with a delay of status_time ms.

Parameters	Type	Description
txt	string	The message to show
status_time	int	the delay of showing
log_type	string	the type of the log

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

For this to be triggered, the Parameter method: setValue should be used

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 h5saver

log_signal

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision

params = [{'children': [{'name': 'Load h5', 'title': 'Load h5:', 'type': 'action'}, {'name': 'filepath', 'readonly': True, 'title': 'h5 path:', 'type': 'str', 'value': ''}, {'name': 'Load Image', 'title': 'Load Image:', 'type': 'action'}, {'name': 'imagepath', 'readonly': True, 'title': 'Image path:', 'type': 'str', 'value': ''}], 'name': 'settings', 'title': 'Settings', 'type': 'group'}, {'name': 'image', 'title': 'Image', 'type': 'pixmap_check'}, {'children': [], 'name': 'overlays', 'title': 'Overlays', 'type': 'group'}]

settings_name = 'navigator_settings'

sig_double_clicked

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:

pyqtSignal(*types, name

Type:

str = …, revision