Stethoscope:
Filter:
Classes | GUI > Interfaces

Stethoscope

An oscilloscope
Location: NOT INSTALLED!

Description

Stethoscope provides a complete oscilloscope GUI. It displays a window containing a bus-plotting ScopeView and an interface to configure the plotting and choose among the buses.

Creation by message .scope

Several classes provide a convenient 'scope' method that creates a Stethoscope to display their data. See for example: Server: -scope, Bus: -scope, Function: -scope.

Keyboard shortcuts

The following keyboard shortcuts may be used when focused on the Stethoscope display:

ShortcutAction
Jone channel back
Kswitch rate (audio vs. control)
Lone channel forward
Ojump to first hardware output channel and adjust numChannels to hardware
Ijump to first hardware input channel and adjust numChannels to hardware
spacerun, if not running already
. (period)stop
Mtoggle screen size
+ / -zoom horizontally
* / _zoom vertically
Schange style between parallel and overlay
Shift+Schange style to lissajou
Shift+Aallocate buffer size so it fills the screen (to next power of two) (this can be dangerous, might crash)

Class Methods

.new

Create a Stethoscope, either as a window, or placed on a given parent view.

Arguments:

server

A valid Server (either a local or the internal server), or nil, in which case the Server.default is used.

numChannels

An integer. Default value is 2.

index

The offset index. An Integer. Default is nil.

bufsize

The size of the analysis buffer. Default is 4096. See also -bufsize.

zoom

Horizontal magnification of the displayed wave. Default is 1. See also -xZoom.

rate

\audio or \control. Default is \audio.

view

The optional parent view. Default is nil. If nil, then it will open in its own Window.

bufnum

The id number of the Buffer to analyze. Default value is nil. If nil, then a Buffer of size bufSize is allocated.

discussion: Example:

.isValidServer

Tests whether Stethoscope can operate on the given server (any local server. See Server: -isLocal).

Arguments:

A Server.

Returns:

A Boolean.

.ugenScopes

Returns an array of the running ugen scopes.

.tileBounds

A utility method used by UGen: -scope to tile scope windows.

Returns:

A Rect.

Inherited class methods

Instance Methods

Data

.server

The server on which the scope operates.

.rate

Whether to operate on audio or control busses.

Arguments:

One of the two symbols: \audio or \control.

.index

The starting index of the busses to scope.

Arguments:

An Integer.

.numChannels

The amount of adjacent busses to scope (from -index on).

Arguments:

An Integer.

.bufsize

Defines the maximum allowed -cycle.

.cycle

NOTE: Only available in Qt GUI

The exact scoping period, in signal frames. Reciprocal to what is also known as sweep speed in analog oscilloscopes. It is dynamically adjustable while the scope is running.

Data from scoped signals will be accumulated into a buffer until it reaches cycle amount frames, at which point the buffering will immediately restart. The view will repeatedly display the entire buffer; it may skip a cycle if the drawing is too slow to keep up with the speed of incoming data, but the cycle boundaries will never shift with respect to signals.

If you are scoping a periodic signal, setting cycle to match the signal's period will keep the waveform locked in place.

Display

.window

The (parent) Window of the scope.

.size

Sets the width and the height of the scope window.

Arguments:

An Integer (the window is square).

.toggleSize

Toggle between small and large size.

.zoom

A synonym for -xZoom.

.xZoom

Magnifies the displayed wave horizontally to the given factor.

This sets -cycle to 1024 * xZoom.reciprocal.

Arguments:

A Float.

.yZoom

Magnifies the displayed wave vertically to the given factor.

Arguments:

A Float.

.style

The plotting style:

Arguments:

One of the above Integers.

Operation

.run

Starts the scope, if not already running.

.quit

Closes the window, and cleans up any used synths and buffers.

Convenience

.setProperties

Sets several properties at once: -numChannels, -index, -bufsize, -zoom, and -rate.

Inherited instance methods

Examples

A step-by-step example

Embedded use

You can pass your own view in to add a stethoscope to it: