SOURCE
ssievent.dll

SUMMARY
ZeroEventSender ZeroEventSender
XMLEventSender XMLEventSender
TupleEventSender TupleEventSender
TriggerEventSender TriggerEventSender
ThresTupleEventSender ThresTupleEventSender
ThresEventSender ThresEventSender
ThresClassEventSender ThresClassEventSender
TheEventBoard TheEventBoard
StringEventSender StringEventSender
MapEventSender MapEventSender
FixationEventSender FixationEventSender
EventToStream EventToStream
EventMonitor EventMonitor
ClockEventSender ClockEventSender

DETAILS
ZeroEventSender
  ZeroEventSender  CONSUMER
 
           Detects events by looking for non-zero samples.
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  hard   BOOL   1   'false'   LOCK   consider all dimensions 
             +  hangin   UINT   1   '0'   FREE   # of non-zero values before onset is detected 
             +  hangout   UINT   1   '0'   FREE   # of non-zero values before offset is detected 
             +  mindur   DOUBLE   1   '0.00000'   FREE   minimum duration in seconds 
             +  maxdur   DOUBLE   1   '5.00000'   FREE   maximum duration in seconds (0 to turn off) 
             +  incdur   DOUBLE   1   '0.00000'   FREE   duration in seconds for sending incremental events (0 to turn off) 
             +  loffset   DOUBLE   1   '0.00000'   FREE   lower offset in seconds (will be substracted from event start time) 
             +  uoffset   DOUBLE   1   '0.00000'   FREE   upper offset in seconds (will be added to event end time) 
             +  skip   BOOL   1   'false'   FREE   skip if max duration is exceeded 
             +  sname   CHAR   1024   'zsender'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'zevent'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  eager   BOOL   1   'false'   FREE   start event is sent as soon as possible event is triggered 
             +  empty   BOOL   1   'true'   LOCK   send as empty event 
             +  string   CHAR   1024   ''   LOCK   default string (if empty == false) 
 
XMLEventSender
  XMLEventSender  CONSUMER
 
           Stores streams to a file on disk.
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'sender'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'xml'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  path   CHAR   1024   ''   LOCK   file path (empty for stdout) 
             +  update   UINT   1   '100'   LOCK   update interval in ms (if set to 0 sender will update with every change) 
             +  console   BOOL   1   'false'   LOCK   output on console 
             +  monitor   BOOL   1   'false'   LOCK   output on monitor 
             +  relative   BOOL   1   'false'   LOCK   arrange windows relative to screen 
             +  screen   FLOAT   2   '0.00000,0.00000'   LOCK   customize screen region [width,height], by default set to desktop size 
             +  mpos   FLOAT   4   '0.00000,0.00000,100.00000,100.00000'   LOCK   position of monitor on screen [posx,posy,width,height], either in pixels or relative to screen 
             +  mname   CHAR   1024   'XMLMonitor'   LOCK   name of monitor (will be displayed in title) 
             +  chars   UINT   1   '10000'   LOCK   maximum number of chars displayed on monitor 
             +  rowdelim   CHAR   1   ';'   LOCK   delimiter to separate values in different rows 
             +  coldelim   CHAR   1   ','   LOCK   delimiter to separate values in the same column 
             +  strbuf   UINT   1   '1024'   LOCK   temporary string buffer, should be large enough to hold mapped values 
 
TupleEventSender
  TupleEventSender  CONSUMER
 
           Converts a stream to a tuple event (value1,value2,...).
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'floats'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'values'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  mean   BOOL   1   'true'   LOCK   send mean values (only a single event will be sent) 
             +  valchanges   BOOL   1   'false'   LOCK   send events only on value changes 
 
TriggerEventSender
  TriggerEventSender  CONSUMER
 
           Detects events in a trigger stream (e.g. when values in the stream exceed a certain threshold).
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  triggerType   INT   1   '0'   LOCK   threshold type (0='>',1='>=',2='<',3='<=',4='==',5='!=',6=']..[',7='[..]',8='![..]',9='!]..[') 
             +  thresholdIn   DOUBLE   1   '0.00000'   FREE   threshold to trigger onset 
             +  thresholdOut   DOUBLE   1   '0.00000'   FREE   threshold to trigger offset 
             +  thresholdInEnd   DOUBLE   1   '0.00000'   FREE   end of interval to trigger onset (only applied if type is 6-9) 
             +  thresholdOutEnd   DOUBLE   1   '0.00000'   FREE   end of interval to trigger offset (only applied if type is 6-9) 
             +  hardThreshold   BOOL   1   'false'   LOCK   consider all dimensions to tigger on/offset 
             +  hangInDuration   DOUBLE   1   '0.00000'   FREE   minimum duration with only positive samples before an onset is triggered 
             +  hangOutDuration   DOUBLE   1   '0.00000'   FREE   minimum duration with only negative smaples before an offset is triggered 
             +  hangInSamples   UINT   1   '0'   FREE   like 'hangInDuration' but given in #samples (overides if > 0) 
             +  hangOutSamples   UINT   1   '0'   FREE   like 'hangOutDuration' but given in #samples (overides if > 0) 
             +  minDuration   DOUBLE   1   '0.00000'   FREE   if > 0 minimum duration in seconds (skip all shorter events) 
             +  incDuration   DOUBLE   1   '0.00000'   FREE   if > 0 incremental duration in seconds (incomplete events are sent when duration has passed and the current event is not yet finished) 
             +  maxDuration   DOUBLE   1   '5.00000'   FREE   if > 0 maximum duration in seconds (otherwise the start time of an event is moved forward) 
             +  offsetInDuration   DOUBLE   1   '0.00000'   FREE   lower offset in seconds (will be substracted from event start time) 
             +  offsetOutDuration   DOUBLE   1   '0.00000'   FREE   upper offset in seconds (will be added to event end time) 
             +  sendStartEvent   BOOL   1   'false'   FREE   send a start event if onset is triggered 
             +  skipMaxDuration   BOOL   1   'false'   FREE   skip events that exceed the max duration 
             +  eventType   INT   1   '1'   LOCK   event type (1=empty, 2=string [see 'eventString'], 3=map [see 'eventString', values are set to mean of input stream], 4=tuple [set to mean of input stream]) 
             +  eventString   CHAR   1024   ''   LOCK   if event type is 'string' this will be the string that is sent, if event type is 'map' this will be key (if multiple keys separate by ';') 
 
ThresTupleEventSender
  ThresTupleEventSender  CONSUMER
 
           Converts a stream to a map event (key1=value1,key2=value2,...).
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'threstuplesender'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'class'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  classes   CHAR   1024   'low, medium, high'   LOCK   names of the classes event (e.g. low,medium,high) 
             +  thres   CHAR   1024   '0.1, 0.3, 0.8'   LOCK   thresholds (e.g. 0.1,0.3,0.8) 
             +  minDiff   FLOAT   1   '0.00088'   LOCK   minimum difference to previous value 
             +  mean   BOOL   1   'true'   LOCK   send mean value (only a single event will be sent) 
 
ThresEventSender
  ThresEventSender  CONSUMER
 
           Detects events if samples exceed a certain threshold.
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'tsender'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'tevent'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  thres   DOUBLE   1   '0.00000'   FREE   threshold to trigger into event 
             +  hard   BOOL   1   'false'   LOCK   consider all dimensions 
             +  hangin   UINT   1   '0'   LOCK   # of non-zero values before onset is detected 
             +  hangout   UINT   1   '0'   LOCK   # of non-zero values before offset is detected 
             +  mindur   DOUBLE   1   '0.00000'   LOCK   minimum duration in seconds 
             +  maxdur   DOUBLE   1   '5.00000'   LOCK   maximum duration in seconds 
             +  loffset   DOUBLE   1   '0.00000'   LOCK   lower offset in seconds (will be substracted from event start time) 
             +  uoffset   DOUBLE   1   '0.00000'   LOCK   upper offset in seconds (will be added to event end time) 
             +  skip   BOOL   1   'false'   LOCK   skip if max duration is exceeded 
             +  eall   BOOL   1   'false'   LOCK   forward incomplete events to event board, otherwise only complete events are sent 
             +  eager   BOOL   1   'false'   LOCK   send an event when the observation begins 
             +  usethresout   BOOL   1   'false'   LOCK   use different threshold to trigger out of event 
             +  thresout   DOUBLE   1   '0.00000'   LOCK   threshold to trigger out of event 
             +  empty   BOOL   1   'true'   LOCK   send as empty event 
             +  string   CHAR   1024   ''   LOCK   default string (if empty == false) 
 
ThresClassEventSender
  ThresClassEventSender  CONSUMER
 
           Classifies stream using thresholds.
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'tcsender'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'class'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  classes   CHAR   1024   'low, medium, high'   LOCK   names of the classes event (e.g. low,medium,high) 
             +  thres   CHAR   1024   '0.1, 0.3, 0.8'   LOCK   thresholds (e.g. 0.1,0.3,0.8) 
             +  minDiff   FLOAT   1   '0.10000'   LOCK   minimum difference to previous value 
             +  mean   BOOL   1   'false'   LOCK   classify based on mean value of entire frame 
 
TheEventBoard
  TheEventBoard  OBJECT
 
           Collects events generated by sender components and distributes them to registered listener components.
 
             +  n_events   UINT   1   '1024'   LOCK   maximal # of buffered events 
             +  n_listener   UINT   1   '64'   LOCK   maximal # of listener 
             +  n_sender   UINT   1   '64'   LOCK   maximal # of sender 
             +  update   UINT   1   '100'   LOCK   update interval in milliseconds 
 
StringEventSender
  StringEventSender  CONSUMER
 
           Converts a stream to a string event ("value1,value2,...").
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'string'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'value'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  mean   BOOL   1   'true'   LOCK   send mean values (only a single event will be sent) 
             +  buffer   UINT   1   '1024'   LOCK   size of string buffer 
             +  delim   CHAR   1   ';'   LOCK   row delimiter 
 
MapEventSender
  MapEventSender  CONSUMER
 
           Converts a stream to a map event (key1=value1,key2=value2,...).
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'map'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'values'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  keys   CHAR   1024   ''   LOCK   keys (one per dimension separated by comma) 
             +  mean   BOOL   1   'true'   LOCK   send mean value (only a single event will be sent) 
 
FixationEventSender
  FixationEventSender  CONSUMER
 
           Looks for fixations and sends them as an event.
 
             +  sname   CHAR   1024   'gaze'   LOCK   name of sender 
             +  ename   CHAR   1024   'fixation'   LOCK   name of event 
             +  thres   FLOAT   1   '0.05000'   LOCK   fixation threshold 
             +  mindur   DOUBLE   1   '0.25000'   LOCK   minimum duration 
             +  maxdur   DOUBLE   1   '0.50000'   LOCK   minimum duration 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
 
EventToStream
  EventToStream  SENSOR
 
           Listens to the set events and continuously outputs the last value until a new event arrives.
 
             +  sr   DOUBLE   1   '1.00000'   LOCK   sampling rate of the output signal (Hz) 
             +  eventValue   CHAR   1024   ''   LOCK   Use "number_of_events" to get the number of events in the defined Window. Use [starttime | endtime | duration | (0 - n | name)] for the data index. Name only works if tuples are used. 
             +  useWindow   BOOL   1   'false'   LOCK   Use a window and a aggregation function (True) or output the raw data (False). 
             +  window   INT   1   '0'   LOCK   If useWindow is True, time span for the window in ms. 0 means no window (all prior events are used). This option competes with listener span. 
             +  statisticalFunction   INT   1   '0'   LOCK   0-Sum, 1-Mean, 2-Variance, 3-StdDev, 4-Minimum, 5-Maximum 
 
           Available channels:
 
             +  event output   continuously outputs the last value until a new event arrives. 
 
EventMonitor
  EventMonitor  OBJECT
 
           Generic visualization component to monitor events.
 
             +  title   CHAR   1024   'EventBoard'   LOCK   window caption 
             +  pos   INT   4   '0,0,100,100'   LOCK   window position (top, left, width, height) 
             +  fontSize   UINT   1   '16'   LOCK   font size 
             +  fontName   CHAR   1024   'Consolas'   LOCK   font name 
             +  list   BOOL   1   'true'   LOCK   display a list of events (otherwise only the last event will be displayed) 
             +  lineReturn   BOOL   1   'false'   LOCK   add line return before new line (if not displayed as list) 
             +  all   BOOL   1   'true'   LOCK   display all events, otherwise only new events will be displayed 
             +  detail   BOOL   1   'true'   LOCK   diplay event content (if list is on) 
             +  console   BOOL   1   'false'   LOCK   output on console instead of window 
             +  chars   UINT   1   '10000'   LOCK   maximum number of chars displayed 
             +  update   UINT   1   '0'   LOCK   minimum update rate in ms 
 
ClockEventSender
  ClockEventSender  OBJECT
 
           Sends an event in regular intervals.
 
             +  address   CHAR   1024   ''   LOCK   event address (event@sender) 
             +  sname   CHAR   1024   'clock'   LOCK   name of sender (if sent to event board) [deprecated, see address] 
             +  ename   CHAR   1024   'tick'   LOCK   name of event (if sent to event board) [deprecated, see address] 
             +  clock   UINT   1   '1000'   LOCK   clock interval in milliseconds 
             +  clocks   CHAR   1024   ''   LOCK   a set of clock intervals in milliseconds (separted by ;) 
             +  init   BOOL   1   'false'   LOCK   send an event in the beginning 
             +  empty   BOOL   1   'true'   LOCK   send as empty event 
             +  string   CHAR   1024   ''   LOCK   default string (if empty == false) 
             +  silence   BOOL   1   'false'   LOCK   do not send events 
 


Built with Social Signal Interpretation (SSI) [v1.0.5]
(c) University of Augsburg
http://openssi.net