filter attribute

Member of

<data> <dataStream> <eyeTracker> <eyeTrackerSrResearch> <eyeTrackerTobii> <summaryData>

Syntax

/ filter = { script }

Parameters

Name	Type	Description
script	script	Specifies a expression returning true or false determining whether data should be recorded.

Remarks

The filter command enables a script to dynamically determine which rows of data should be recorded by a data, dataStream, or eyetracker element. This is especially useful for continuous data streams such as dataStream and eyetracker where many rows of data are written per second and data files can grow quite large. The filter can reduce the size of data files by allowing an experiment to record data only when the relevant conditions are met.

Requires an explicit 'return' statement.

Examples

The following dataStream records data only if the specified video is playing:

<dataStream example>
/ columns = (date, time, subject, video.test.currentTime, response)
/ filter = { return video.test.isPlaying;}
</dataStream>