From e9c65c11c3096e97e7f263c3b26b29c32130ac50 Mon Sep 17 00:00:00 2001 From: Esref Ozdemir Date: Mon, 26 Aug 2019 10:04:23 +0200 Subject: [PATCH] Change default eyelink edge discard factor to 0 --- doc/PsPM_Manual.lyx | 63 +++++++++++++++++++++++++++++++++- src/pspm_cfg/pspm_cfg_import.m | 14 ++++++-- src/pspm_get_eyelink.m | 13 +++++-- 3 files changed, 83 insertions(+), 7 deletions(-) diff --git a/doc/PsPM_Manual.lyx b/doc/PsPM_Manual.lyx index 9226482ea..28614c2dd 100644 --- a/doc/PsPM_Manual.lyx +++ b/doc/PsPM_Manual.lyx @@ -5851,6 +5851,61 @@ The length unit in which the eyetracker distance is given. It can be mm, cm, m or inches. \end_layout +\begin_layout Subparagraph* +Blink/Saccade Edge Discard +\end_layout + +\begin_layout Standard +Samples surrounding a blink or saccade period may be noisy. + For this reason, Eyelink import provides a parameter that allows users + to specify the amount of samples they want to discard on each side of every + blink and saccade period. + This value is multiplied by the sampling rate of the recording to determine + the number of samples to discard from one end. + Therefore, for each blink/saccade period, +\begin_inset Formula $2\cdot factor\cdot F_{sampling}$ +\end_inset + + many samples are discarded in total, and effectively blink/saccade period + is extended. +\end_layout + +\begin_layout Standard +This value also corresponds to the duration of samples to discard on one + end in seconds. + For example, when it is 0.01, we discard 10 ms worth of data on each end + of every blink/saccade period. +\end_layout + +\begin_layout Standard +The default value has been changed to 0 in PsPM revision r803 to reduce + the amount of discarded data. + Note that this might result in noisy samples around blink/saccade points. + Therefore, it is highly recommended to perform pupil size data preprocessing + +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Pupil-Preprocessing" +plural "false" +caps "false" +noprefix "false" + +\end_inset + + and gaze data filtering +\begin_inset CommandInset ref +LatexCommand ref +reference "subsec:Find-valid-fixations" +plural "false" +caps "false" +noprefix "false" + +\end_inset + +. + +\end_layout + \begin_layout Paragraph* SMI (SensoMotoric Instruments) \end_layout @@ -18602,6 +18657,12 @@ Nonlinear SCR model (DCM) now does not use the inter-trial interval duration Now, we prevent this from happening. \end_layout +\begin_layout Itemize +Eyelink import parameter blink/saccade edge discard factor default value + has been set to 0. + This means no extra samples are discarded around blinks/saccades. +\end_layout + \begin_layout Subsection* Bugfixes \end_layout @@ -18635,7 +18696,7 @@ New utility functions to make PsPM more compatible across different operating \begin_layout Itemize An optimized Eyelink import function that is significantly faster and more - efficient than previous versions + memory efficient than previous versions \end_layout \begin_layout Itemize diff --git a/src/pspm_cfg/pspm_cfg_import.m b/src/pspm_cfg/pspm_cfg_import.m index dfcd40641..5d8b6c9fa 100644 --- a/src/pspm_cfg/pspm_cfg_import.m +++ b/src/pspm_cfg/pspm_cfg_import.m @@ -1,7 +1,7 @@ function import_data = pspm_cfg_import -% $Id$ -% $Rev$ +% $Id: pspm_cfg_import.m 803 2019-08-26 08:00:45Z esrefo $ +% $Rev: 803 $ % Initialise global settings @@ -117,7 +117,7 @@ eyelink_edge_discard_factor = cfg_entry; eyelink_edge_discard_factor.name = 'Blink/saccade discard factor'; eyelink_edge_discard_factor.tag = 'eyelink_edge_discard_factor'; -eyelink_edge_discard_factor.val = {0.05}; +eyelink_edge_discard_factor.val = {0}; eyelink_edge_discard_factor.num = [1 1]; eyelink_edge_discard_factor.strtype = 'r'; eyelink_edge_discard_factor.help = {['Factor used to determine the number of', ... @@ -128,10 +128,18 @@ ' for each blink/saccade period, 2*this_value*SR many', ... ' samples are discarded in total, and effectively', ... ' blink/saccade period is extended.'], ... + ['This value also corresponds to the duration of', ... ' samples to discard on one end in seconds. For example,', ... ' when it is 0.01, we discard 10 ms worth of data on', ... ' each end of every blink/saccade period.'] ... + + ['The default value has been changed to 0 in PsPM revision', ... + ' r803 to reduce the amount of discarded data. Note that', ... + ' this might result in noisy samples around blink/saccade', ... + ' points. Therefore, it is highly recommended to perform', ... + ' pupil size data preprocessing and gaze data filtering by', ... + ' finding valid fixations.'] ... }; distance_unit = cfg_menu; diff --git a/src/pspm_get_eyelink.m b/src/pspm_get_eyelink.m index 6e8f3b73c..c2406d398 100644 --- a/src/pspm_get_eyelink.m +++ b/src/pspm_get_eyelink.m @@ -38,7 +38,14 @@ % samples to discard on one end in seconds. For example, % when it is 0.01, we discard 10 ms worth of data on % each end of every blink/saccade period. - % (Default: 0.05) + % + % The default value has been changed to 0 in PsPM revision + % r803 to reduce the amount of discarded data. Note that + % this might result in noisy samples around blink/saccade + % points. Therefore, it is highly recommended to perform + % pupil size data preprocessing using pspm_pupil_pp and + % gaze data filtering using pspm_find_valid_fixations. + % (Default: 0) % % % In this function, channels related to eyes will not produce an error, if @@ -49,8 +56,8 @@ % PsPM 3.0 % (C) 2008-2017 Tobias Moser (University of Zurich) - % $Id: pspm_get_eyelink.m 802 2019-08-23 08:07:30Z esrefo $ - % $Rev: 802 $ + % $Id: pspm_get_eyelink.m 803 2019-08-26 08:00:45Z esrefo $ + % $Rev: 803 $ % initialise % -------------------------------------------------------------------------