digitize(1) manual page Table of Contents

Name

digitize - acquire, display and store EEG data and events

Synopsis

digitize [OPTIONS] info-file log-file raw-file condition-code

Description

Collect digitized EEG data and event codes from the the /dev/dig driver ( see digitize(4) ), display it on an X window and store it to disk in ERPSS compressed rawfile format (RDF). The info-file contains the setup information used by the digitize program and is described in detail in digitize-info(5) . The log-file is the name of the ERPSS format log file to save the event code information that is collected during digitization. The raw-file is the name of the ERPSS RDF format (little-endian) raw EEG data that are collected during digitization. digitize will not overwrite the raw and log files if they already exist. condition-code is the initial condition code used for the raw and log files.

When in operation, the digitize program takes input from the keyboard, the following keys are supported (case is not relevant):

S - start
Start a new run of data collection. Data are now saved to the raw and log files.
P - pause
Pause saving data to the raw and log files.
D - done
Exit the digitize program.
C - change condition code
Allow the user to put in a new condition code.
F - UNDOCUMENTED - filter 60Hz
A simple 60Hz smoothing filter for the display only (data are not touched).
+ - increase the y-axis scale
Increment the y-axis scale.
- - decrease the y-axis scale
Decrement the y-axis scale.
> - speed up time base
Speed up the time base, move the trace faster.
< - slow down time base
Slow down the time base, move the trace slower.
I - increase trace intensity
Increase the trace intensity.
I - decrease trace intensity
Decrease the trace intensity.
1-9 - display 1-9 columns
Display 1-9 columns.
/ - decrease linger
Leave less trace lingering on the display.
\ - increase linger
Leave more trace lingering on the display.

Options

-scale scale
y (voltage) scale. The scale value is multiplied by the input data to calculate the displayed trace deflection in pixels. Values greater than 1 or less than -1 make no sense. The display is normally rendered with negative going up, choosing a scale parameter less than zero will flip this orientation so that negative will go down. Once a negative or positive scale parameter is chosen, it will remain the same sign throughout the digitize session. The default value is 0.019
-columns n
use n columns in display. From 1 to 8 columns are allowed.
-speed speed
use speed as speedup/slowdown factor (time base). This value scales the acquisition frequency so that the display can go slower per pixel than the data are acquired on the card. By using anti-aliased rendering, we are still able to pick out higher frequencies on the display. The default value is 0.5. Values higher than 1 and less than or equal to 0 make no sense.
-intensity intensity
Use intensity to set the brightness of the trace, similar to the intensity knob on an oscilloscope. Values less than 1 make the trace dimmer than normal, values greater than 1 make the trace brighter. Values near 10 completely defeat the anti-aliased renderer. The default value is 1.
-updatems ms
The number of milliseconds to wait before updating the X display, a lower number here makes for a smoother display but uses far more CPU resources. A bigger number can give a "jumpy" look to the display. an updatems less than 30ms probably is of no use, and an updatems greater than 1000ms will probably be too jumpy to use. The default is 200ms.
-display location
The digitize display location. This must be on the local machine so the X Shared Memory Extension can be used. The default is :0.0.
-activeForeground color
The foreground (trace) color when digitize is saving data to disk.
-activeBackground color
The background color when digitize is saving data to disk.
-activeCode color
The color of event codes when digitize is saving data to disk.
-activeHighlight color
The color of the highlighted channels (if any) when digitize is saving data to disk.
-inactiveForeground color
The foreground (trace) color when digitize is not saving data to disk.
-inactiveBackground color
The background color when digitize is not saving data to disk.
-inactiveCode color
The color of event codes when digitize is not saving data to disk.
-inactiveHighlight color
The color of the highlighted channels (if any) when digitize is not saving data to disk.
-linger percent
The percentage of the screen width that the trace should linger behind the current drawing location. If this value is 100 then the trace will stay on for one complete cycle, if it is less than 100 it will fade before the next cycle starts and greater than 100, it will stay even while the next cycle has started (similar to persistence mode on a digital storage scope). The default value here is 95.
-highlight channels...
Pick channel descriptors to highlight. These channels are usually rendered in a different color from the "normal" channels.
-blendHighlight boolean
When the highlighted channels are rendered they can "overwrite" the current display or "blend" into the current display. If this resource is set to True the highlighted colors are blended into the other traces. This requires significantly more CPU resources than overwriting, so the default is False.
-rawfile rawfile
Use rawfile as input to digitize program instead of the normal /dev/dig driver file. The info-file parameters are ignored in this case, but the user may still save raw and event data to the log-file and raw-file.
-resources resources_file
Use resources file as a source of resources for the resource database. The resources in this file are merged in to the current resource database for digitize.

Resources

digitize uses the X resource database to store details about the look and feel and operation of the program, the following resources are used:
scale scale
y (voltage) scale. The scale value is multiplied by the input data to calculate the displayed trace deflection in pixels. Values greater than 1 or less than -1 make no sense. The display is normally rendered with negative going up, choosing a scale parameter less than zero will flip this orientation so that negative will go down. Once a negative or positive scale parameter is chosen, it will remain the same sign throughout the digitize session. The default value is 0.019
columns n
use n columns in display. From 1 to 8 columns are allowed.
speed speed
use speed as speedup/slowdown factor (time base). This value scales the acquisition frequency so that the display can go slower per pixel than the data are acquired on the card. By using anti-aliased rendering, we are still able to pick out higher frequencies on the display. The default value is 0.5. Values higher than 1 and less than or equal to 0 make no sense.
intensity intensity
Use intensity to set the brightness of the trace, similar to the intensity knob on an oscilloscope. Values less than 1 make the trace dimmer than normal, values greater than 1 make the trace brighter. Values near 10 completely defeat the anti-aliased renderer. The default value is 1.
font fontspec
font used for rendering the user interface (top and bottom bars), default is: -*-helvetica-medium-r-normal-*-12-*-*-*-*-*-iso8859-*.
updatems ms
The number of milliseconds to wait before updating the X display, a lower number here makes for a smoother display but uses far more CPU resources. A bigger number can give a "jumpy" look to the display. an updatems less than 30ms probably is of no use, and an updatems greater than 1000ms will probably be too jumpy to use. The default is 200ms.
display location
The digitize display location. This must be on the local machine so the X Shared Memory Extension can be used. The default is :0.0.
activeForeground color
The foreground (trace) color when digitize is saving data to disk.
activeBackground color
The background color when digitize is saving data to disk.
activeCode color
The color of event codes when digitize is saving data to disk.
activeHighlight color
The color of the highlighted channels (if any) when digitize is saving data to disk.
inactiveForeground color
The foreground (trace) color when digitize is not saving data to disk.
inactiveBackground color
The background color when digitize is not saving data to disk.
inactiveCode color
The color of event codes when digitize is not saving data to disk.
inactiveHighlight color
The color of the highlighted channels (if any) when digitize is not saving data to disk.
linger percent
The percentage of the screen width that the trace should linger behind the current drawing location. If this value is 100 then the trace will stay on for one complete cycle, if it is less than 100 it will fade before the next cycle starts and greater than 100, it will stay even while the next cycle has started (similar to persistence mode on a digital storage scope). The default value here is 95.
highlight channels...
Pick channel descriptors to highlight. These channels are usually rendered in a different color from the "normal" channels.
blendHighlight boolean
When the highlighted channels are rendered they can "overwrite" the current display or "blend" into the current display. If this resource is set to True the highlighted colors are blended into the other traces. This requires significantly more CPU resources than overwriting, so the default is False.

Files

~/Digitize
The user resources file.

Bugs

Default colors are hideous...

The display should be oversampled...

Author

Arthur Jones, sponsored by: Yale University, University of Oregon, Dartmouth College, University of California, San Diego, University of Texas, San Antonio, University of California, Davis and the Salk Institute for Biological Studies.

See Also

digitize-info(5) , digitize(4) , ni(4) , nie(4)


Table of Contents