Home

Documentation

Project Support

Changes in Version 2 of GraspSwDemoVideo

Author:
isani
Timestamp:
Mon Mar 5 17:53:05 2012

Legend:

Unmodified
Added
Removed
Modified

  • GraspSwDemoVideo

    v1 v2
    1 1  '''[wiki:GraspSwDemoScripts video]''' 
    2 2  [[TracNav(GraspContents)]] 
    3 3  ||Command:||'''video'''|| 
    4 4  ||Contexts:||Director console or command port|| 
    5 5  ||Function:||Acquire sequential raw frames and deliver them to the video server|| 
    6 6  ||Required Parameters:||none.|| 
    7 7  ||Optional Parameters:|| || 
    8 8  ||'''nframes='''||![16] Number of raw frames/cycles|| 
    9 9  ||'''etime='''||*[0.005] Seconds of integration time per frame|| 
    10    ||'''intstart='''||*[0.005] Seconds after start (or end) of readout to start integration|| 
      10  ||'''intstart='''||*[0.005] Seconds after end of readout to start integration|| 
    11 11  ||'''width='''||[det-dependent] Width (columns) of readout per output|| 
    12 12  ||'''height='''||[det-dependent] Height (rows) of readout per output|| 
    13 13  ||'''videodest='''||[from-config] Video server destination IP, port, and feed name|| 
    14 14  ||'''keep='''||*[TRUE] If FALSE, read frame but discard the data|| 
    15 15  ||'''mod='''||Number of cycles after which to repeat pattern (must be < nframes)|| 
    16    ||'''ncpus='''||![2] Multi-threaded|| 
      16  ||'''ncpus='''||![2] The default enables multi-threaded operation for best performance. "1" disables.|| 
    16 16  ||'''dreg='''||*|| 
      17   
      18  === Frame-based options === 
    17 19  (*) Options etime= intstart= dreg= and keep= take optional extensions to change to a new value on a given frame number.  For example, to 
    18 20  perform on reset and then readouts after: 
    19 21  {{{ 
    20 22    dreg=<regval_with_reset>,2:<regval_no_reset> 
    21 23  }}} 
    22 24  Without whitespace a comma, a frame number, a colon, and new value. 
      25   
      26  === nframes === 
      27   
      28  The nframes option actually specifies the number of video "cycles" to complete.  The video cycle goes in this order: 
      29   
      30   * Program dreg 
      31   * Perform a readout (possibly with integration starting during readout in low gain mode if intstart is negative.) 
      32   * Integrate 
      33   
      34  During the integration phase, the device's master clock is currently not operated.  (This appears not to cause any adverse effects.) 
      35   
      36  The integration ends at the start of cycle n+1.  The first cycle may also often request a "reset" rather than a readout for IR devices.  For these reasons, nframes is often 1 or 2 greater than the actual number of desired video frames.  (See the "keep" option for syntax to throw away data produced by these initial cycles.) 
      37   
      38  === etime === 
      39   
      40  The exposure time is specified in seconds.  As of this writing, the controller pays attention to up to 3 decimal places (milliseconds) but a future upgrade will increase the precision to microseconds. 
      41   
      42  === intstart === 
      43   
      44  For devices with an electronic shutter, a time in seconds after the readout ends can be specified as the "start of integration."  If it is desired to have integration overlap with readout, a negative number of seconds can be used (up to but not greater than the readout time, and also never greater than the etime.)  No attempt is made to enforce the validity of integration during readout based on dreg.  I.e., the user  
      45   
      46  === width, height === 
      47   
      48  These parameters default to the full (per output) detector size.  If a window readout mode has been selected (see dreg) then width and height should be adjusted accordingly. 
      49   
      50  === keep === 
      51   
      52  When keep=false is used, no data will be transmitted.  This is useful for a reset frame which should be discarded, or pipelined data which does not need to be kept.  The default is keep=false.  This option can be changed on a given frame (cycle) number using the extended syntax described under Frame-based options above. 
      53   
      54  === mod === 
      55   
      56  All of the frame based options can be set to repeat on a given number of cycles.  For example, if "mod=5" is given, the 6th cycle will operate with the settings that were applied to the first cycle. 
      57   
      58  === dreg === 
      59   
      60  This option sets a device-specific data register.  It can also be set to change on any cycle, but options which affect width and height (windowing) should remain the same.