8.6.6.1.1. pymodaq_gui.plotting.data_viewers.base module

exception pymodaq_gui.plotting.data_viewers.base.ViewerError[source]

Bases: Exception

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

Bases: QObject

Base Class for data viewers implementing all common functionalities

Parameters:
Variables:
Attributes:
get_action

Convenience method

has_action

Convenience method

is_action_checked

Convenience method

is_action_visible

Convenience method

roi_manager

Convenience method

roi_target

Convenience method to get the ROI target object

set_action_checked

Convenience method

set_action_visible

Convenience method

title
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

do_math

roi_select_signal

sig_double_clicked

status_signal
activate_roi(activate=True)[source]

Activate the Roi manager using the corresponding action

add_attributes_from_view()[source]

Convenience function to add attributes from the view to self

do_math()[source]
move_roi_target(pos=None, **kwargs)[source]

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

setVisible(show=True)[source]

convenience method to show or hide the parent widget

show_data(data, **kwargs)[source]

Entrypoint to display data into the viewer

Parameters:

data (DataWithAxes)

show_data_temp(data, **kwargs)[source]

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)[source]

Show/Hide a specific read only ROI

trigger_action(action_name)[source]

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
property get_action

Convenience method

property has_action

Convenience method

property is_action_checked

Convenience method

property is_action_visible

Convenience method

property roi_manager: ROIViewerManager | None

Convenience method

roi_select_signal
property roi_target: InfiniteLine | ROI

Convenience method to get the ROI target object

property set_action_checked

Convenience method

property set_action_visible

Convenience method

sig_double_clicked
staticMetaObject = PySide6.QtCore.QMetaObject("ViewerBase" inherits "QObject": Methods:   #4 type=Signal, signature=data_to_export_signal(PyObject), parameters=PyObject   #5 type=Signal, signature=_data_to_show_signal(PyObject), parameters=PyObject   #6 type=Signal, signature=ROI_changed()   #7 type=Signal, signature=crosshair_dragged(double,double), parameters=double, double   #8 type=Signal, signature=status_signal(QString), parameters=QString   #9 type=Signal, signature=crosshair_clicked(bool), parameters=bool   #10 type=Signal, signature=sig_double_clicked(double,double), parameters=double, double   #11 type=Signal, signature=ROI_select_signal(QRectF), parameters=QRectF   #12 type=Signal, signature=roi_select_signal(PyObject), parameters=PyObject )
status_signal
property title: str
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)[source]

Bases: BaseEnum

enum relating a given viewer with data type

classmethod from_n_axes(n_axes)[source]
static get_viewers_enum_from_data(dwa)[source]
Return type:

ViewersEnum

static get_viewers_enum_from_metadata(dim, distribution, n_nav_axes, n_sig_indexes, shape_len, size)[source]
Return type:

ViewersEnum

get_dim()[source]
increase_dim(ndim)[source]
Viewer0D = 'Data0D'
Viewer1D = 'Data1D'
Viewer2D = 'Data2D'
ViewerND = 'DataND'
ViewerSequential = 'DataSequential'