Differences between revisions 15 and 16

Documentation of nrec Parameters

Contents

1. Data Acquisition

Channel Bitmask for DIn spike recording (24ch)
- Enter here a bitmask which defines the DIn channels to be recorded. Channel 0 is reserved for the Trigger and should always be set. A complete 24 channel recording is specified by a channel mask 16777215.
Number of AIn channels to be recorded
- How many analog input channels are sampled, recorded and saved to the hdf5 data file. Since one channel for the trial trigger and two for the eye position is needed, the minimum for this parameter is 3.
sampling rate
- Acquired samples per second by the daq card.
SubdeviceID for AIn (eye position) recording (16ch)
- The ID of the analog input subdevice (find out via comedi_test -t info).
SubdeviceID for DIn spike recording (24ch)
- The ID of the digital input subdevice (find out via comedi_test -t info). If no spikes or comparable digital signals are to be recorded, set this value to -1.
SubdeviceID for other DIO (8ch)
- The ID of the digital in-/output subdevice (find out via comedi_test -t info). The trial trigger is on channel 0 output. The other channels may be used for response buttons, reward signals, LEDs and similar things.

Experiment file
- Path and filename of the last experiment configuration used. Usually this is not modified here. If the experiment file can not be found, nrec might no longer start up. You will then have to edit .nrec.cfg manually or using a XML-editor and set this parameter back to a valid value.

Channel 0
- Currently used horizontal calibration coefficients. These are the 6 coefficients a,b,c,d,e,f in the voltage (x) to gaze_angle funtion:
  ganze_angle = a + b * x + c * y + d * x² + e * x * y + f * y².
  Usually this is not modified here.
Channel 1
- Currently used vertical calibration coefficients. These are the 6 coefficients a,b,c,d,e,f in the voltage (x) to gaze_angle funtion:
  ganze_angle = a + b * x + c * y + d * x² + e * x * y + f * y².
  Usually this is not modified here.
# Channels
- Number of channels used for eye position calibration. Use 1 for x-only mode or 2 for x-y-mode.
# Coefficient/channel
- Number of calibration coefficients per channel. Order of the polynomial in the above equations. Currently only a value of 6 is implemented.

# Channels
- Number of channels used for eye position measurement. Currently only a value of 2 is implemented.
  Usually this is not modified here.
Device ID
- Device ID for eye movement data acquisition. Usually 0.
Subevice ID
- Subdevice ID for eye movement data acquisition. Usually equals DAQ/SUBDEVICE_ID_AIN.
X Channel ID
- ID of channel for horizontal eye position. Usually 0.
Y Channel ID
- ID of channel for vertical eye position. Usually 1.
Range ID (see comedi_test output)
- ID of the voltage range used on the X and Y channel inputs. comedi_test returns the possible ranges, e.g.: ranges: all chans: [-10,10] [-5,5] [-0.5,0.5] [-0.05,0.05] . These ranges would refer to the IDs 0, 1, 2, 3.

Clear Screen at the End of Experiment
- If activated, the screen is cleared when the experiment is finished or stopped.
Frameerror handling
- 0: strict, system assumes that calculation of a new frame lasts less than 1/framerate seconds.
  1: tolerant, system allows the frame calculation to be longer than 1/framerate seconds. Especially useful in conjunction with movie primitives.
Minimum trial duration
- Use this parameter, if you want to ensure, that the time between the start of two consecutive trials is constant. Deactivated, if set to -1.

Parameters defining the graphics output. You will have to restart nrec to apply these settings.

Full screen
- If activated, the whole screen is used instead of a window.
Graphics system
- DirectFB is obsolete. Use "X Window".
Height
- Number of vertical pixels (rows).
Width
- Number of horizontal pixels (columns).
X Display Name
- Choose the appropriate X Display. For Notebooks e.g., the external screen normally is :0.1
  Caution: If the chosen display is not GLX capable, nrec might not start up anymore. You will then have to edit .nrec.cfg manually or using a XML-editor and set this parameter back to a valid value.

Parameters related to storage of the data to a hdf5-file.

Append Date and Time to Filename
- To the filename which is set in the parameter list, an extra suffix is added in front of the h5-suffix. It has the format year-month-day-hour-minute-second-millisecond. A new filename is generated every time the experiment starts (usually by a button press on "START EXPERIMENT").
Automatic Backup Creation after N Trials
- To avoid data loss in case of (hopefully seldom) nrec crashes, the current data file can be copied to a backup file (suffix ".bak") after N trials. N is specified by this parameter. The copying process interrupts nrec execution for a certain time interval. Functionality is disabled when it is set to 0.

Parameters defining the look of the user interface.

Digital inputs (channel mask)
- Some of the digital channels are visualized by red/green squares below the eye position panel. This number specifies which channels are shown. You will have to restart nrec to apply this setting.

Area on the right upper side of the main window where the current eye position and other things are displayed.

Online Display Raw Scaling
- If "raw data" is activated below the panel, the display shows the current analog input in volts. This parameter defines the voltage range of the shown area.
Online Display Scaling
- If "raw data" is deactivated, the display shows the current eye position (gaze angle) in degrees. A scaling of 1 scales the shown eye position range so, that it covers the current screen size.

These parameters are usually changed directly on the user interface. There is no need to modify them here.

These parameters are usually changed directly on the user interface. There is no need to modify them here.

nrec: ParameterExplanationNrec (last edited 2015-12-11 09:24:32 by FriedemannBunjes)

-  ⇤ ← Revision 15 as of 2008-10-15 08:34:04 → 
  Size: 7037
  Editor: homer
  Comment:
+   ← Revision 16 as of 2008-11-11 14:07:01 → ⇥
  Size: 7308
  Editor: hih-kn-2301-01
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 9:
+ * {{{ Channel Bitmask for DIn spike recording (24ch) }}}
  . Enter here a bitmask which defines the DIn channels to be recorded. Channel 0 is reserved for the Trigger and should always be set. A complete 24 channel recording is specified by a channel mask 16777215.