Differences between revisions 9 and 12 (spanning 3 versions)
⇤ ← Revision 9 as of 2008-05-13 11:03:12 →
Size: 4401
Editor: hih-kn-2301-01
Comment:
← Revision 12 as of 2008-05-13 11:26:31 → ⇥
Size: 6313
Editor: hih-kn-2301-01
Comment:
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
Line 10: Line 9:
Line 12: Line 10:
   Acquired samples per second by the daq card.   . Acquired samples per second by the daq card.
Line 15: Line 13:
   The ID of the analog input subdevice (find out via {{{comedi_test -t info}}}).   . The ID of the analog input subdevice (find out via {{{comedi_test -t info}}}).
Line 18: Line 16:
   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.   . 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.
Line 21: Line 19:
   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.   . 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.
Line 24: Line 22:
Line 26: Line 23:
   Path and filename of the last experiment configuration used. Usually this is not modified here.   . Path and filename of the last experiment configuration used. Usually this is not modified here.
Line 29: Line 26:
Line 31: Line 27:
Line 33: Line 28:

   Currently used horizontal calibration coefficients. These are the 6 coefficients a,b,c,d,e,f in the voltage (x) to gaze_angle funtion:<<BR>> ganze_angle = a + b * x + c * y + d * x^2^ + e * x * y + f * y^2^.<<BR>>
   Usually this is not modified here.		   . Currently used horizontal calibration coefficients. These are the 6 coefficients a,b,c,d,e,f in the voltage (x) to gaze_angle funtion:<<BR>> ganze_angle = a + b * x + c * y + d * x^2^ + e * x * y + f * y^2^.<<BR>> Usually this is not modified here.
Line 38: Line 31:
   Currently used vertical calibration coefficients. These are the 6 coefficients a,b,c,d,e,f in the voltage (x) to gaze_angle funtion:<<BR>> ganze_angle = a + b * x + c * y + d * x^2^ + e * x * y + f * y^2^.<<BR>>
   Usually this is not modified here.		   . Currently used vertical calibration coefficients. These are the 6 coefficients a,b,c,d,e,f in the voltage (x) to gaze_angle funtion:<<BR>> ganze_angle = a + b * x + c * y + d * x^2^ + e * x * y + f * y^2^.<<BR>> Usually this is not modified here.
Line 42: Line 34:
   Number of channels used for eye position calibration. Use 1 for x-only mode or 2 for x-y-mode.   . Number of channels used for eye position calibration. Use 1 for x-only mode or 2 for x-y-mode.
Line 45: Line 37:
   Number of calibration coefficients per channel. Order of the polynomial in the above equations. Currently only a value of 6 is implemented.   . Number of calibration coefficients per channel. Order of the polynomial in the above equations. Currently only a value of 6 is implemented.
Line 48: Line 40:
Line 50: Line 41:
   Number of channels used for eye position measurement. Currently only a value of 2 is implemented.<<BR>>Usually this is not modified here.   . Number of channels used for eye position measurement. Currently only a value of 2 is implemented.<<BR>>Usually this is not modified here.
Line 53: Line 44:
   Device ID for eye movement data acquisition. Usually 0.   . Device ID for eye movement data acquisition. Usually 0.
Line 56: Line 47:
   Subdevice ID for eye movement data acquisition. Usually equals DAQ/SUBDEVICE_ID_AIN.   . Subdevice ID for eye movement data acquisition. Usually equals DAQ/SUBDEVICE_ID_AIN.
Line 59: Line 50:
   ID of channel for horizontal eye position. Usually 0.   . ID of channel for horizontal eye position. Usually 0.
Line 62: Line 53:
   ID of channel for vertical eye position. Usually 1.   . ID of channel for vertical eye position. Usually 1.
Line 67: Line 58:
Line 69: Line 59:
   Viewing distance between eyes and screen in mm.   . Viewing distance between eyes and screen in mm.
Line 72: Line 62:
   Refresh rate of the screen.   . Refresh rate of the screen.
Line 75: Line 65:
   Height of the screen in mm.   . Height of the screen in mm.
Line 78: Line 68:
   Width of the screen in mm.   . Width of the screen in mm.
Line 83: Line 73:
   Number of horizontal pixels (columns).   . Number of horizontal pixels (columns).
Line 86: Line 76:
   Number of vertical pixels (rows).   . Number of vertical pixels (rows).
Line 88: Line 78:
=== Stimuli ===
 == Stimuli ==
Line 91: Line 80:
   If activated, the screen is cleared when the experiment is finished or stopped.   . If activated, the screen is cleared when the experiment is finished or stopped.
Line 94: Line 83:
   0: strict, system assumes that calculation of a new frame lasts less than 1/framerate seconds.<<BR>>
   1: tolerant, system allows the frame calculation to be longer than 1/framerate seconds. Especially useful in conjunction with movie primitives.		   . 0: strict, system assumes that calculation of a new frame lasts less than 1/framerate seconds.<<BR>> 1: tolerant, system allows the frame calculation to be longer than 1/framerate seconds. Especially useful in conjunction with movie primitives.
Line 98: Line 86:
   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.   . 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.
Line 100: Line 88:
=== Stimulus window === == Stimulus window ==
Line 105: Line 93:
   If activated, the whole screen is used instead of a window.   . If activated, the whole screen is used instead of a window.
Line 108: Line 96:
   DirectFB is obsolete. Use "X Window".   . DirectFB is obsolete. Use "X Window".
Line 111: Line 99:
   Number of vertical pixels (rows).   . Number of vertical pixels (rows).
Line 114: Line 102:
   Number of horizontal pixels (columns).   . Number of horizontal pixels (columns).
Line 117: Line 105:
   Choose the appropriate X Display. For Notebooks e.g., the external screen normally is :0.1<<BR>>
   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.		   . Choose the appropriate X Display. For Notebooks e.g., the external screen normally is :0.1<<BR>> __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.
Line 120: Line 107:
== Storage ==
Line 121: Line 109:
Parameters related to storage of the data to a hdf5-file.
Line 122: Line 111:
 * {{{ 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").
Line 123: Line 114:
 * {{{ 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.
Line 124: Line 117:
== User Interface ==
Line 125: Line 119:
Parameters defining the look of the user interface.
Line 126: Line 121:
{{{... to be continued}}}  * {{{ 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.

=== Eye Position Panel ===

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.

=== Main window layout ===

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

=== Plotting setup ===

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

Documentation of nrec Parameters

Contents

  1. Data Acquisition
  2. Experiment file
  3. Eye position module
    1. Calibration
    2. Input hardware
  4. Local system setup
    1. Monitor
      1. Resolution
  5. Stimuli
  6. Stimulus window
  7. Storage
  8. User Interface
    1. Eye Position Panel
    2. Main window layout
    3. Plotting setup

1. Data Acquisition

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

2. Experiment file

  •  Experiment file 

    • Path and filename of the last experiment configuration used. Usually this is not modified here.

3. Eye position module

3.1. Calibration

  •  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 * x2 + e * x * y + f * y2.
      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 * x2 + e * x * y + f * y2.
      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.

3.2. Input hardware

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

4. Local system setup

4.1. Monitor

  •  Distance 

    • Viewing distance between eyes and screen in mm.

  •  Frame rate 

    • Refresh rate of the screen.

  •  Height 

    • Height of the screen in mm.

  •  Width 

    • Width of the screen in mm.

4.1.1. Resolution

  •  Horizontal 

    • Number of horizontal pixels (columns).

  •  Vertical 

    • Number of vertical pixels (rows).

5. Stimuli

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

6. Stimulus window

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.

7. Storage

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.

8. User Interface

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.

8.1. Eye Position Panel

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.

8.2. Main window layout

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

8.3. Plotting setup

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)