8.5.5.1.1. pymodaq_gui.plotting.data_viewers.base module

exception pymodaq_gui.plotting.data_viewers.base.ViewerError

Bases: Exception

class pymodaq_gui.plotting.data_viewers.base.ViewerBase(parent=None, title='')

Bases: QObject

Base Class for data viewers implementing all common functionalities

Parameters:

• parent (QWidget)

• title (str)

view

Ui interface of the viewer

Type:

QObject

data_to_export_signal

Type:

pyqtSignal

ROI_changed

Type:

pyqtSignal

crosshair_dragged

Type:

pyqtSignal, float]

crosshair_clicked

Type:

pyqtSignal

sig_double_clicked

Type:

pyqtSignal, float]

status_signal

Type:

pyqtSignal

Attributes:

get_action

Convenience method

has_action

Convenience method

is_action_checked

Convenience method

is_action_visible

Convenience method

roi_target

To be implemented if necessary (Viewer1D and above)

set_action_checked

Convenience method

set_action_visible

Convenience method

toolbar

Convenience property

viewer_type

str: the viewer data type see DATA_TYPES

Methods

activate_roi([activate])	Activate the Roi manager using the corresponding action
add_attributes_from_view()	Convenience function to add attributes from the view to self
move_roi_target([pos])	move a specific read only ROI at the given position on the viewer
setVisible([show])	convenience method to show or hide the parent widget
show_data(data, **kwargs)	Entrypoint to display data into the viewer
show_data_temp(data, **kwargs)	Entrypoint to display temporary data into the viewer
show_roi_target([show])	Show/Hide a specific read only ROI
trigger_action(action_name)	Convenience function to trigger programmatically one of the action of the related view

ROI_changed
ROI_select_signal
crosshair_clicked
crosshair_dragged
data_to_export_signal
roi_select_signal
sig_double_clicked
status_signal

activate_roi(activate=True)

Activate the Roi manager using the corresponding action

add_attributes_from_view()

Convenience function to add attributes from the view to self

move_roi_target(pos=None, **kwargs)

move a specific read only ROI at the given position on the viewer

setVisible(show=True)

convenience method to show or hide the parent widget

show_data(data, **kwargs)

Entrypoint to display data into the viewer

Parameters:

data (DataWithAxes)

show_data_temp(data, **kwargs)

Entrypoint to display temporary data into the viewer

No processed data signal is emitted from the viewer

Parameters:

data (DataWithAxes)

show_roi_target(show=True)

Show/Hide a specific read only ROI

trigger_action(action_name)

Convenience function to trigger programmatically one of the action of the related view

property get_action

Convenience method

property has_action

Convenience method

property is_action_checked

Convenience method

property is_action_visible

Convenience method

property roi_target: InfiniteLine | ROI

To be implemented if necessary (Viewer1D and above)

property set_action_checked

Convenience method

property set_action_visible

Convenience method

property toolbar

Convenience property

property viewer_type

the viewer data type see DATA_TYPES

Type:

str

class pymodaq_gui.plotting.data_viewers.base.ViewersEnum(*values)

Bases: BaseEnum

enum relating a given viewer with data type

classmethod from_n_axes(n_axes)

static get_viewers_enum_from_data(dwa)

Return type:

ViewersEnum

static get_viewers_enum_from_metadata(dim, distribution, n_nav_axes, n_sig_indexes, shape_len, size)

Return type:

ViewersEnum

get_dim()

increase_dim(ndim)

Viewer0D = 'Data0D'

Viewer1D = 'Data1D'

Viewer2D = 'Data2D'

ViewerND = 'DataND'

ViewerSequential = 'DataSequential'