Debian Codegraph @

doc/features/signal/menu_view.rst

raw
1 .. _sig-menu-view:
2
3 View options for Signals
4 ========================
5
6 .. figure:: /images/shots/s_view.png
7
8 Screenshot of the "View" menu.
9
10 When the "Signal Panel" is selected, the menus and toolbars are updated to
11 provide signal-related actions.
12
13 The "View" menu allows you to visualize the current signal or group of signals.
14 It also allows you to show/hide titles, to enable/disable anti-aliasing, or to
15 refresh the visualization.
16
17 View in a new window
18 ^^^^^^^^^^^^^^^^^^^^
19
20 Open a new window to visualize the selected signals.
21
22 This option allows you to visualize the selected signals in a separate window,
23 in which you can visualize the data more comfortably (e.g., by maximizing the
24 window) and you can also annotate the data.
25
26 When you click on the button "Annotations" in the toolbar of the new window,
27 the annotation editing mode is activated (see the section "Edit annotations" below).
28
29 Edit annotations
30 ^^^^^^^^^^^^^^^^
31
32 Open a new window to edit annotations.
33
34 This option allows you to show the selected signals in a separate window,
35 in which you can visualize the data more comfortably (e.g., by maximizing the
36 window) as well as to add or edit annotations.
37
38 Annotations are used to add comments or labels to the data, and they can be used
39 to highlight specific events or regions of interest.
40
41 .. note::
42 The annotations are saved in the metadata of the signal, so they are
43 persistent and will be displayed every time you visualize the signal.
44
45 .. figure:: /images/annotations/signal_annotations1.png
46
47 Annotations may be added in the separate view.
48
49 The typical workflow to edit annotations is as follows:
50
51 1. Select the "Edit annotations" option.
52 2. In the new window, add annotations by clicking on the corresponding buttons
53 at the bottom of the window.
54 3. Eventually, customize the annotations by changing their properties (e.g.,
55 the text, the color, the position, etc.) using the "Parameters" option in the
56 context menu of the annotations.
57 4. When you are done, click on the "OK" button to save the annotations. This will
58 close the window and the annotations will be saved in the metadata of the signal
59 and will be displayed in the main window.
60
61 .. figure:: /images/annotations/signal_annotations2.png
62
63 Annotations are now part of the signal metadata.
64
65 .. note::
66 Annotations may be copied from a signal to another by using the
67 "copy/paste metadata" features.
68
69 Auto-refresh
70 ^^^^^^^^^^^^
71
72 Automatically refresh the visualization when the data changes:
73
74 - When enabled (default), the plot view is automatically refreshed when the
75 data changes.
76
77 - When disabled, the plot view is not refreshed until you manually refresh it
78 by using the "Refresh manually" menu entry.
79
80 Even though the refresh algorithm is optimized, it may still take some time to
81 refresh the plot view when the data changes, especially when the data set is
82 large. Therefore, you may want to disable the auto-refresh feature when you are
83 working with large data sets, and enable it again when you are done. This will
84 avoid unnecessary refreshes.
85
86 Show only first selected signal
87 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
88
89 Toggle between showing all selected signals or only the first one.
90
91 When this option is enabled, only the first selected signal is displayed in the plot
92 view. This may be useful when multiple signals are selected and focusing on a single
93 signal is (temporarily) preferred.
94
95 Refresh manually
96 ^^^^^^^^^^^^^^^^
97
98 Refresh the visualization manually.
99
100 This triggers a refresh of the plot view. It is useful when the auto-refresh
101 feature is disabled, or when you want to force a refresh of the plot view.
102
103 Show graphical object titles
104 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
105
106 Show/hide titles of analysis results or annotations.
107
108 This option allows you to show or hide the titles of the graphical objects
109 (e.g., the titles of the analysis results or annotations). Hiding the titles
110 can be useful when you want to visualize the data without any distractions,
111 or if there are too many titles and they are overlapping.
112
113 Curve anti-aliasing
114 ^^^^^^^^^^^^^^^^^^^
115
116 Enable/disable anti-aliasing of curves.
117
118 Anti-aliasing makes the curves look smoother, but it may also make them look less sharp.
119
120 .. note::
121 Anti-aliasing is enabled by default.
122
123 .. warning::
124 Anti-aliasing may slow down the visualization, especially when
125 working with large data sets.
126
127 Reset curve styles
128 ^^^^^^^^^^^^^^^^^^
129
130 Reset the curve style cycle to the beginning.
131
132 When plotting curves, DataLab automatically assigns a color and a line style to
133 each curve. Both parameters are chosen from a predefined list of colors and
134 line styles, and are assigned in a round-robin fashion.
135
136 This menu entry allows you to reset the curve styles, so that the next time
137 you plot curves, the first curve will be assigned the first color and the first
138 line style of the predefined lists, and the loop will start again from there.