oscopy.org

User Tools

Site Tools

Trace:
documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
documentation [2011/09/24 11:05] – [Oscopy User manual] Add screenshot arnauddocumentation [2015/01/11 21:43] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Oscopy User manual ====== ====== Oscopy User manual ======
  
-<column 100% 70% -> +<columns 100% 70% - > 
-The user manual is available in the doc/ioscopy directory and also as {{:oscopy:ioscopy-manual.pdf|PDF file}}.+The user manual is available in the ''doc/ioscopy'' directory and also as {{:ioscopy-manual-071.pdf|PDF file}}.
  
 Inside a Graph Inside a Graph
   * Toggle cursors: keys 1,2,3,4   * Toggle cursors: keys 1,2,3,4
   * Right-click to popup menu with all available options for figure, graph, signals and more!   * Right-click to popup menu with all available options for figure, graph, signals and more!
 +  * Zoom/unzoom: keys ''z'' and ''Z'' respectively, or the mouse wheel
 +The API manual is available in the ''doc/oscopy-api'' directory and also as {{:oscopy-api-071.pdf|PDF file}}
 <newcolumn> <newcolumn>
-{{:oscopy:ioscopy.png|}}+ 
 +{{:ioscopy-071.png?300|}} 
 </columns> </columns>
  
-===== Command description =====+====== Command description ======
 Oscopy-specific commands are prefixed with the letter ''o''.\\ Oscopy-specific commands are prefixed with the letter ''o''.\\
 In addition to these commands, In addition to these commands,
Line 45: Line 49:
 |owrite | format [(OPTIONS)] FILE SIG [, SIG [, SIG]...] |Write signals to file | |owrite | format [(OPTIONS)] FILE SIG [, SIG [, SIG]...] |Write signals to file |
  
-===== Windows description =====+====== Windows description ======
  
 The Graphical User Interface of oscopy is composed of several windows: The Graphical User Interface of oscopy is composed of several windows:
Line 52: Line 56:
     * The (many) figures windows     * The (many) figures windows
  
-==== Main Window ====+===== Main Window ===== 
 +<columns 100% 80% ->
 This is the first window that you will see when starting ioscopy. At anytime, it can be shown again by calling the command ogui from the terminal if closed. This is the first window that you will see when starting ioscopy. At anytime, it can be shown again by calling the command ogui from the terminal if closed.
  
 It contains the list of Readers and their Signals currently handled by ioscopy. Double-clicking on a Signal insert it in a new Figure. It contains the list of Readers and their Signals currently handled by ioscopy. Double-clicking on a Signal insert it in a new Figure.
 +Right-click on a Signal to select a Graph for insertion.
  
 Each Signal 'freeze' status can be toggled using the checkbox located in the right column. Toggling the checkbox for a Reader set the status for all the signals contained in the Reader. Each Signal 'freeze' status can be toggled using the checkbox located in the right column. Toggling the checkbox for a Reader set the status for all the signals contained in the Reader.
Line 70: Line 76:
 The 'Windows' menu contains the list of the windows, and select one to show it.  The 'Windows' menu contains the list of the windows, and select one to show it. 
  
-==== Figure window ====+<newcolumn> 
 +{{:ioscopy-gui.png?200|}} 
 +</columns> 
 +===== Figure window ===== 
 + 
 +<columns 100% 70% ->
  
 Each Figure window is composed of two parts: Each Figure window is composed of two parts:
   * On the top part, a zone containing up to 4 graphs   * On the top part, a zone containing up to 4 graphs
   * On the bottom part, the Matplotlib toolbar   * On the bottom part, the Matplotlib toolbar
 +  * On the right part, the Operation bar
  
 A contextual menu is available for each graph, raised by a right-click on the mouse button. Access to most of the ioscopy functionality is possible through this menu: A contextual menu is available for each graph, raised by a right-click on the mouse button. Access to most of the ioscopy functionality is possible through this menu:
Line 82: Line 94:
   * Unit settings   * Unit settings
   * Scale   * Scale
-  * Insert Signal 
   * Remove Signal   * Remove Signal
  
Line 93: Line 104:
 The value of each cursor is displayed on the bottom part of the graph, and the difference when both cursors are activated.  The value of each cursor is displayed on the bottom part of the graph, and the difference when both cursors are activated. 
  
 +Available **mouse** operations:
 +  * **left** In a graph and when 'span' is selected, define region for zooming
 +  * **wheel** In a graph, Zoom in / Zoom out
 +  * **right** Show 'Contextual signal' menu. Sensitive to position, e.g. Graph-related items are only available when mouse is over a Graph.
 +
 +==== The Operation Bar ====
 +
 +This bar is used to set options for all the Graphs at the same time or for a particular Graph. The target Graph is selected through the top-most combo-box.
 +
 +  * **Master pan** When scroll bars are moved, move also all Graphs with same X unit than selected.
 +  * **Zoom x10** When enabled, the graph range is expanded at a x10 scale, keeping the center of the view. When disabled, return to full range. E.g. if the initial range is [6 .. 11] and the data range is [0 .. 20], the x10 range will be [7.5 .. 9.5] and will be [0 .. 20] on disabling.
 +  * **Span** When enabled, use mouse­left to zoom in a region of a Graph (Figure 3.14). Region selection is made upon the Figure layout configuration:
 +    * //horizontal// Region is selected on X axis
 +    * //vertical// Region is selected on Y axis
 +    * //quad// Region is selected on both axis
 +  * **Export** Save figure as image
 +
 +<newcolumn>
 +{{:ioscopy-cursors.png?300|}}
 +</columns>
documentation.1316862336.txt.gz · Last modified: 2011/09/24 11:05 by arnaud