User Tools

Site Tools


documentation

Oscopy User manual

The user manual is available in the doc/ioscopy directory and also as PDF file.

Inside a Graph

  • Toggle cursors: keys 1,2,3,4
  • 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 PDF file

Command description

Oscopy-specific commands are prefixed with the letter o.
In addition to these commands, numpy.ufuncs and numpy.fft functions support operations with Signals.

Command Arguments Description
oadd SIG [, SIG [, SIG]…] Add a graph to the current figure
ocontext Return the Context object used within ioscopy. Use it only if you want to have direct access to internal ioscopy objects.
ocreate [SIG [, SIG [, SIG]…] ]Create a new figure, set it as current, add the signals
odelete GRAPH# Delete a graph from the current figure
odestroy FIG# Destroy a figure
oexec FILENAME execute commands from file
ofactors X, Y set the scaling factor of the graph (in power of ten) use 'auto' for automatic scaling factor e.g. factor -3, 6 set the scale factor at 1e-3 and 10e6
ofiglist Print the list of figures
ofreeze SIG [, SIG [, SIG]…] Do not consider signal for subsequent updates
ogui Show the GUI
oimport SIG [, SIG [, SIG]…] Import a list of signals into oscopy to handle dependencies during updates
oinsert SIG [, SIG [, SIG]…] Insert a list of signals into the current graph
olayout horiz|vert|quadDefine the layout of the current figure
omode MODE Set the type of the current graph of the current figure
Available modes :
* lin Linear graph
orange [x|y min max]|[xmin xmax ymin ymax] Set the axis range of the current graph of the current figure
oread DATAFILE read signal file
orefresh FIG#|on|off|current|all Force/toggle autorefresh of current/#/all figures on update
oremove SIG [, SIG [, SIG]…] Delete a list of signals into from current graph
oscale [lin|logx|logy|loglog] Set the axis scale
oselect FIG#-GRAPH# Select the current figure and the current graph
osiglist List loaded signals
ounfreeze SIG [, SIG [, SIG]…] Consider signal for subsequent updates
ounit [XUNIT,] YUNIT Set the unit to be displayed on graph axis
oupdate Reread data files
owrite format [(OPTIONS)] FILE SIG [, SIG [, SIG]…] Write signals to file

Windows description

The Graphical User Interface of oscopy is composed of several windows:

  • The command line terminal
  • The main window
  • The (many) figures windows

Main Window

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. 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.

The 'File' menu:

Option Description
Add file(s)…To read Signals from file(s)
UpdateTo read Signals from file(s) again
Execute script…To read ioscopy commands from file
New Math SignalTo compute a new Signal from existing ones
Run netlister and simulateTo generate the netlist, run the simulator and eventually update the Signals
QuitExit ioscopy

The 'Windows' menu contains the list of the windows, and select one to show it.

Figure window

Each Figure window is composed of two parts:

  • On the top part, a zone containing up to 4 graphs
  • 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:

  • Add/delete graph
  • Layout
  • Range settings
  • Unit settings
  • Scale
  • Remove Signal

For each Graph, cursors are available through keys:

  • '1' for first vertical cursor
  • '2' for second vertical cursor
  • '3' for first horizontal cursor
  • '4' for second horizontal cursor

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

documentation.txt · Last modified: 2015/01/11 22:43 (external edit)