8.5.5.1.4. pymodaq_gui.plotting.data_viewers.viewer1D module

class pymodaq_gui.plotting.data_viewers.viewer1D.DataDisplayer(plotitem, flip_axes=False, plot_colors=<pymodaq_utils.utils.PlotColors object>)[source]

Bases: QObject

This Object deals with the display of 1D data on a plotitem

Attributes:
Ndata
labels
legend

Methods

get_axis

get_plot_item

get_plot_items

labels_changed

legend_items

plot_with_scatter

show_overlay

update_axis

update_colors

update_data

update_display_items

update_errors

update_plot

update_scatter

update_sort

update_xy

update_xyplot

updated_item

get_axis()[source]
Return type:

Axis

get_plot_item(index)[source]
get_plot_items()[source]
legend_items()[source]
plot_with_scatter(with_scatter=True, symbol_size=5, symbol='o', color=None)[source]
show_overlay(show=True)[source]
update_axis(axis)[source]
update_colors(colors)[source]
update_data(data, do_xy=False, sort_data=False, force_update=False, do_scatter=False, show_errors=False)[source]
update_display_items(data=None, show_errors=False)[source]
update_errors(show_errors=False)[source]
update_plot(do_xy=True, data=None, sort_data=False, scatter=False, show_errors=False)[source]
update_scatter(do_scatter=False)[source]
update_sort(do_sort=False)[source]
update_xy(do_xy=False)[source]
update_xyplot(do_xy=True, dwa=None)[source]
property Ndata
property labels
property legend
class pymodaq_gui.plotting.data_viewers.viewer1D.View1D(parent_widget=None, show_toolbar=True, no_margins=False, flip_axes=False)[source]

Bases: ActionManager, QObject

Attributes:
axis

Get the current axis used to display data

plotitem

Methods

get_crosshair_position()

Convenience function from the Crosshair

get_crosshair_signal()

Convenience function from the Crosshair

process_xyplot()

Uncheck things if xyplot is active

set_crosshair_position(*positions)

Convenience function from the Crosshair

setup_actions()

update_roi_channels(roi_name)

Update the use_channel setting each time a ROI is added

add_data_displayer

add_plot_item

add_roi_displayer

connect_things

display_data

display_roi_lineouts

do_math

get_double_clicked

lock_aspect_ratio

move_roi_target

prepare_ui

remove_data_displayer

remove_roi_displayer

setup_widgets

show_ROI_select

show_hide_crosshair

update_colors

update_crosshair_data

add_data_displayer(displayer_name, plot_colors=<pymodaq_utils.utils.PlotColors object>)[source]
add_plot_item(item)[source]
add_roi_displayer(roi_name='')[source]
connect_things()[source]
display_data(data, displayer=None)[source]
display_roi_lineouts(roi_dte)[source]
do_math()[source]
get_crosshair_position()[source]

Convenience function from the Crosshair

get_crosshair_signal()[source]

Convenience function from the Crosshair

get_double_clicked()[source]
lock_aspect_ratio()[source]
move_roi_target(pos, **kwargs)[source]
prepare_ui()[source]
process_xyplot()[source]

Uncheck things if xyplot is active

remove_data_displayer(displayer_name)[source]
remove_roi_displayer(roi_name='')[source]
set_crosshair_position(*positions)[source]

Convenience function from the Crosshair

setup_actions()[source]
setup_widgets()[source]
show_ROI_select()[source]
show_hide_crosshair(show=True)[source]
update_colors(colors)[source]
update_crosshair_data(crosshair_dte)[source]
update_roi_channels(roi_name)[source]

Update the use_channel setting each time a ROI is added

property axis

Get the current axis used to display data

crosshair: Crosshair
data_displayer: DataDisplayer
lineout_viewers: Viewer0D
lineout_widgets: qtpy.QtWidgets.QWidget
other_data_displayers: Dict[str, DataDisplayer]
plot_widget: PlotWidget
property plotitem
class pymodaq_gui.plotting.data_viewers.viewer1D.Viewer1D(parent=None, title='', show_toolbar=True, no_margins=False, flip_axes=False)[source]

Bases: ViewerBase

DataWithAxis of type Data1D can be plotted using this data viewer

show_data:

parameter: * dwa: a DataWithaxis * scatter_dwa: an optional extra DataWithAxis to be plotted with scatter points

it could define extra_attributes such as symbol: str (to define the symbol layout default: ‘o’) and symbol_size: int (to define the symbol size)

Attributes:
crosshair

Convenience method

labels
roi_manager

Convenience method

roi_target

To be implemented if necessary (Viewer1D and above)

Methods

activate_roi([activate])

move_roi_target([pos])

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

set_crosshair_position(xpos[, ypos])

Convenience method to set the crosshair positions

add_plot_item

crosshair_changed

double_clicked

get_axis_from_view

prepare_connect_ui

process_crosshair_lineouts

process_roi_lineouts

roi_changed

selected_region_changed

update_colors

update_status

activate_roi(activate=True)[source]
add_plot_item(item)[source]
crosshair_changed()[source]
double_clicked(posx, posy=0)[source]
get_axis_from_view(data)[source]
move_roi_target(pos=None)[source]

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

prepare_connect_ui()[source]
process_crosshair_lineouts(crosshair_dte)[source]
process_roi_lineouts(roi_dte)[source]
roi_changed()[source]
selected_region_changed()[source]
set_crosshair_position(xpos, ypos=0)[source]

Convenience method to set the crosshair positions

update_colors(colors, displayer=None)[source]
update_status(txt)[source]
property crosshair

Convenience method

property labels
property roi_manager

Convenience method

property roi_target: InfiniteLine
pymodaq_gui.plotting.data_viewers.viewer1D.main()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_errors()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_extra_scatter()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_nans()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_random()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_unsorted()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_view1D()[source]
pymodaq_gui.plotting.data_viewers.viewer1D.main_xy()[source]