\doxysection{pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker Class Reference}
\hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker}{}\label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
Inheritance diagram for pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=8.383233cm]{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a0b616fa517717c83f6326f536ac037ac}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a99cd756c232a37fabc040dbdf9f37e81}{calibrate}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a3333734abcb6d78266f00e495cd55dc0}{close}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a4accb57853300992e3c3317bc3a2059c}{connected}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a004eb0e1d8900b37d886d7e66e7d0e8f}{drift\+\_\+correction}} (self, pos=None, fix\+\_\+triggered=False)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_aa74d6e7b5e08893eb76a67061771f5db}{fix\+\_\+triggered\+\_\+drift\+\_\+correction}} (self, pos=None, min\+\_\+samples=30, max\+\_\+dev=60, reset\+\_\+threshold=10)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a20afa5a83ebbfbdd3c2deaa7e7223a45}{get\+\_\+eyetracker\+\_\+clock\+\_\+async}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_aecad16ce0b77cb26c29bc7ec897ef140}{log}} (self, msg)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a92f919963177d1243c9026207bf4eff4}{log\+\_\+var}} (self, var, val)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_afa80db525c0d9132ebce5521537f17d4}{pupil\+\_\+size}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_adc02ba529f099f36a3af0717e1b51be3}{sample}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a48de05b7dc87c8c8a6e9422d51f55741}{send\+\_\+command}} (self, cmd)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a2e6b839b5f11cbd5c5a3763cc4de4dee}{set\+\_\+eye\+\_\+used}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a45133752a66c34c9acacaaea01872470}{draw\+\_\+drift\+\_\+correction\+\_\+target}} (self, x, y)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_abbd40a43331e00c35a4a61b7fea8c9c2}{draw\+\_\+calibration\+\_\+target}} (self, x, y)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_ae425c468ceafb500b911231f5b10fa58}{set\+\_\+draw\+\_\+calibration\+\_\+target\+\_\+func}} (self, func)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a2cb6ee0bfdf9ca4f34d1dc073843a8f3}{set\+\_\+draw\+\_\+drift\+\_\+correction\+\_\+target\+\_\+func}} (self, func)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a5e679620aadceb234c5fc55da1faa60d}{start\+\_\+recording}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a1664d48e4913d8097fb457f238f02923}{status\+\_\+msg}} (self, msg)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6936119910931316c5df84353eb1c845}{stop\+\_\+recording}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_ae1bc33d1fc27a7f07c535c3e9fdf7ab6}{set\+\_\+detection\+\_\+type}} (self, eventdetection)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a4e1b1428e6053b3804230af6c3a4dd33}{wait\+\_\+for\+\_\+event}} (self, event)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a71c103171fec41c5d94e0c6848e4e776}{wait\+\_\+for\+\_\+blink\+\_\+end}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a59364472b9f0f9bde0485586502401f4}{wait\+\_\+for\+\_\+blink\+\_\+start}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_abf2fc54bcd7d7762c70e48c2a98869d5}{wait\+\_\+for\+\_\+fixation\+\_\+end}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a8c0f412002fcd9589b1cc859befa7f74}{wait\+\_\+for\+\_\+fixation\+\_\+start}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6ffc7f2d4d9570b9f558c05771bcced1}{wait\+\_\+for\+\_\+saccade\+\_\+end}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6b1ca931a4b9b467eb6e2fc219d4d9c8}{wait\+\_\+for\+\_\+saccade\+\_\+start}} (self)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a5d4d7a6af7e5e91b911256ee66ece3ee}{draw\+\_\+calibration\+\_\+target}} = func
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6e8f75f481dbc2e0e0c716109c5a58a8}{draw\+\_\+drift\+\_\+correction\+\_\+target}} = func
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}    desc: |
        A generic Python library for eye tracking.
\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a0b616fa517717c83f6326f536ac037ac}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a0b616fa517717c83f6326f536ac037ac} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}



\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a99cd756c232a37fabc040dbdf9f37e81}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!calibrate@{calibrate}}
\index{calibrate@{calibrate}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{calibrate()}{calibrate()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a99cd756c232a37fabc040dbdf9f37e81} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+calibrate (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        strict:
            False

        desc: |
            Initializes the EyeTracker object.

        arguments:
            display:
                desc:   A pygaze.display.Display instance.
                type:   Display

        keywords:
            logfile:
                desc: |
                    A logfile name (string value); path may be included in the
                    file name for SMI and for Tobii; SMI will create a `.idf`
                    and a `.txt`, Tobii will make a `.tsv`; for EyeLink PLEASE
                    DO NOT USE THIS: use `data_file` instead, see below for
                    explanation.
                type:   [unicode, str]
            eventdetection:
                desc: |
                    A string specifying the type of event detection, either
                    'native' for system default functions (not always
                    available!), of 'pygaze' for Dalmaijer et al. (2013)
                    algorithms; NOTE: will fall back to 'pygaze' if 'native' is
                    not available on your system!
                type:   [unicode, str]
            saccade_velocity_threshold:
                desc:   A saccade velocity threshold in degrees per second.
                type:   [float, int]
            saccade_acceleration_threshold:
                desc:   A saccade acceleration threshold in degrees per square
                        second.
                type:   [float, int]
            data_file:
                desc: |
                    __EyeLink only!__ IMPORTANT: use data_file in stead of
                    logfile keyword for EyeLink, as it does not
                    support filenames longer than 8 characters (so no
                    path assignment in the logfile name, as is possible
                    for SMI and Tobii).
                type:   [str, unicode]
            force_drift_correct:
                desc: |
                    __EyeLink only!__ Indicates whether an active drift
                    correction should be used. This option is relevant for
                    EyeLink 1000 devices, on which drift correction is by
                    default only a check, and not an actual single-point
                    recalibration.
                type:   bool
            pupil_size_mode:
                desc: |
                    __EyeLink only!__ Indicates whether pupil size is recorded
                    in area or diameter values.
                type:   bool
            resolution:
                desc: |
                    __EyeLink only!__ Specify the display resolution using
                    a (w,h) tuple.
                type:   tuple
            fg_color: |
                desc: |
                    __EyeLink only!__ Specify the foreground colour using
                    an (R,G,B) tuple.
                type:   tuple
            bg_color:
                desc: |
                    __EyeLink only!__ Specify the background colour using
                    an (R,G,B) tuple.
                type:   tuple
            ip:
                desc: __SMI only!__ The ip address for iViewX.
                type:   [str, unicode]
                    (default = '127.0.0.1')
            sendport:
                desc:   __SMI only!__ port number for iViewX sending.
                type:   int
            receiveport:
                desc:   __SMI only!__ port number for iViewX receiving.
                type:   int
\end{DoxyVerb}


\begin{DoxyVerb}        desc: |
            Calibrates the eye tracking system. The actual behavior of this
            function depends on the type of eye tracker and is described below.

            __EyeLink:__

            This function will activate the camera-setup screen, which allows
            you to adjust the camera, and peform a calibration/ validation
            procedure. Pressing 'q' will exit the setup routine. Pressing
            'escape' will first trigger a confirmation dialog and then, upon
            confirmation, raises an Exception.

            __EyeTribe:__

            Activates a simple calibration routine.

        returns:
            desc: |
                Returns True if calibration succeeded, or False if not; in
                addition a calibration log is added to the log file and some
                properties are updated (i.e. the thresholds for detection
                algorithms).
            type:   bool
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a6802f78c6d9250c71ffad396736789f3}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a7889b137d542b27a28e0706ff9ec71d2}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_ac309112981674e0c46de7004f8e8f65e}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_ae1d4cfe1e20e6b9cf3ccee0f472b1c94}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_ac0aa5ae9fdba93f3484bb404a8c1bb79}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a9a880153a025c624c8adb46cb966afe6}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_aca414c01d132f3bd76ef1480992b0ecc}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a9f266a8ec92d629da18d52b586a95e1b}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a3333734abcb6d78266f00e495cd55dc0}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!close@{close}}
\index{close@{close}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{close()}{close()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a3333734abcb6d78266f00e495cd55dc0} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+close (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Neatly closes connection to tracker. Saves data and sets
            `self.connected` to False.
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_adc99195541d8070fb7474bee4a33abd1}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_ab362887e50e39f473c438a2d946cb91e}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_ae670e94ed12b353a40a05a4a19122551}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_ab2c644756438c10083e0992e559c8224}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_ae49ad9ec0edab63a49d941ab0bd18f7e}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a44de2c46ef1a0ac761e37c934d7f5094}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a6feadaf95d5529e0d044a67fb1d3074b}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a8692989ea2fd34e5f46e85889af54e23}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a4accb57853300992e3c3317bc3a2059c}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!connected@{connected}}
\index{connected@{connected}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{connected()}{connected()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a4accb57853300992e3c3317bc3a2059c} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+connected (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Checks if the tracker is connected.

        returns:
            desc: |
                True if connection is established, False if not; sets
                `self.connected` to the same value.
            type:   bool
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a11539cec5efb8ed75b2d55314a86349d}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_ab76aa90c0480d4ffe99dc7bf6dbf84c8}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a44ffffce31a62562241661d4857cd4b1}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_adfc91762c80074223f44e64498cca1b0}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_adce9dfbefeba978273225ff4f35c4b70}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_aaa5f622e95c6dd294690017522f04959}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_abbd40a43331e00c35a4a61b7fea8c9c2}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!draw\_calibration\_target@{draw\_calibration\_target}}
\index{draw\_calibration\_target@{draw\_calibration\_target}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{draw\_calibration\_target()}{draw\_calibration\_target()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_abbd40a43331e00c35a4a61b7fea8c9c2} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+draw\+\_\+calibration\+\_\+target (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{x}{, }\item[{}]{y}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Draws a calibration target.

        arguments:
            x:
                desc:   The X coordinate
                type:   int
            y:
                desc:   The Y coordinate
                type:   int
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a8716fc8144a0bef8c367d5e6f176b1e2}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a1d55b850041b19644b5fe80910d13b08}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a45133752a66c34c9acacaaea01872470}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!draw\_drift\_correction\_target@{draw\_drift\_correction\_target}}
\index{draw\_drift\_correction\_target@{draw\_drift\_correction\_target}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{draw\_drift\_correction\_target()}{draw\_drift\_correction\_target()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a45133752a66c34c9acacaaea01872470} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+draw\+\_\+drift\+\_\+correction\+\_\+target (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{x}{, }\item[{}]{y}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Draws a drift-correction target.

        arguments:
            x:
                desc:   The X coordinate
                type:   int
            y:
                desc:   The Y coordinate
                type:   int
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a468f94e1dbd79d455bcfeebb23037d3c}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a0ce695940556bec5a7ccd8df8b947c7a}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a2ee1e47d8fedbb6caaf36f4d8104321d}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a5edb10ca286533522e5ae61d0e50712e}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a004eb0e1d8900b37d886d7e66e7d0e8f}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!drift\_correction@{drift\_correction}}
\index{drift\_correction@{drift\_correction}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{drift\_correction()}{drift\_correction()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a004eb0e1d8900b37d886d7e66e7d0e8f} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+drift\+\_\+correction (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{pos}{ = {\ttfamily None}, }\item[{}]{fix\+\_\+triggered}{ = {\ttfamily False}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Performs a drift-correction procedure. The exact behavior of this
            function on the type of eye tracker and is described below. Because
            drift correction may fail, you will generally call this function in
            a loop.

            __EyeLink:__

            Pressing 'q' during drift-correction will activate the camera-setup
            screen. From there, pressing 'q' again will cause drift correction
            to fail immediately. Pressing 'escape' will give the option to abort
            the experiment, in which case an Exception is raised.

        keywords:
            pos:
                desc:   (x, y) position of the fixation dot or None for a
                        central fixation.
                type:   [tuple, NoneType]
            fix_triggered:
                desc:   Boolean indicating if drift check should be performed
                        based on gaze position (True) or on spacepress (False).
                type:   bool

        returns:
            desc:   A boolean indicating if drift check is ok (True) or not
                    (False).
            type:   bool
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a5433dbdbc578cdee3304bd8da21dbe7b}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_af8a02b36a26659063c0462748d303c0d}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a0eb6b2bd6fa786744e0a64686b86c505}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_af0fd5d19fa87fdbe3e6b7b38b23646a4}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a3faf7e96e7fa217a535e769026911330}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a83085a61924cde3c69d851a032ee64df}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a5284f804777e576af0d34cea81f4f088}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a56f570116ef2022d064a2b0162124a3e}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_aa74d6e7b5e08893eb76a67061771f5db}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!fix\_triggered\_drift\_correction@{fix\_triggered\_drift\_correction}}
\index{fix\_triggered\_drift\_correction@{fix\_triggered\_drift\_correction}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{fix\_triggered\_drift\_correction()}{fix\_triggered\_drift\_correction()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_aa74d6e7b5e08893eb76a67061771f5db} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+fix\+\_\+triggered\+\_\+drift\+\_\+correction (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{pos}{ = {\ttfamily None}, }\item[{}]{min\+\_\+samples}{ = {\ttfamily 30}, }\item[{}]{max\+\_\+dev}{ = {\ttfamily 60}, }\item[{}]{reset\+\_\+threshold}{ = {\ttfamily 10}}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Performs a fixation triggered drift correction by collecting
            a number of samples and calculating the average distance from the
            fixation position

        keywords:
            pos:
                desc:   (x, y) position of the fixation dot or None for a
                        central fixation.
                type:   [tuple, NoneType]
            min_samples:
                desc:   The minimal amount of samples after which an
                        average deviation is calculated.
                type:   int
            max_dev:
                desc:   The maximal deviation from fixation in pixels.
                type:   int
            reset_threshold:
                desc:   If the horizontal or vertical distance in pixels between
                        two consecutive samples is larger than this threshold,
                        the sample collection is reset.
                type:   int

        returns:
            desc:   A boolean indicating if drift check is ok (True) or not
                    (False).
            type:   bool
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a99f9430ac2996608addb3d290edc675d}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_af196838ac4b704781c00e695075e3fcf}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a0045790960395935e44f33805fe44d44}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a38b2630559ce9291c32394960309ef1e}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a571102b1bb2be8ff611a6578514c6be2}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_ae381e37c4ffc6a3e2b34ad8c2780ce68}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_adc25d384700cabf25c59624e2572323b}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_aaf556481130cb970782e93e183535eee}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a20afa5a83ebbfbdd3c2deaa7e7223a45}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!get\_eyetracker\_clock\_async@{get\_eyetracker\_clock\_async}}
\index{get\_eyetracker\_clock\_async@{get\_eyetracker\_clock\_async}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{get\_eyetracker\_clock\_async()}{get\_eyetracker\_clock\_async()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a20afa5a83ebbfbdd3c2deaa7e7223a45} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+get\+\_\+eyetracker\+\_\+clock\+\_\+async (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Returns the difference between tracker time and PyGaze time, which
            can be used to synchronize timing

        returns:
            desc:   The difference between eyetracker time and PyGaze time.
            type:   [int, float]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a82f2638dfbedc4461f0008af84d80d64}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a08c5bb5600c7515df91140d39ccec56e}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_aa298535bcb78ad27d2c140bcb5bc1098}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_ae24b86116ae3c2d8803758339aa2c99f}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_aecad16ce0b77cb26c29bc7ec897ef140}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!log@{log}}
\index{log@{log}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{log()}{log()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_aecad16ce0b77cb26c29bc7ec897ef140} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+log (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{msg}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Writes a message to the log file.

        arguments:
            msg:
                desc:   A message.
                type:   [str, unicode]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_ae4aca960d89212fdd3483a12a8dcf77a}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a4ddc4cd8f17e0ba07ac0088a32e68552}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a532c67a61b3725103a345891f1aa83bd}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_aa57e567ead86e1036feab16c61ac05b1}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_af5a7c206149c5026ce90d8d94569e7b5}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a2f68682f0adbefd0c534c1d49ba6c4aa}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a716a5e317751405760e1c14c469da2d1}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a92f919963177d1243c9026207bf4eff4}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!log\_var@{log\_var}}
\index{log\_var@{log\_var}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{log\_var()}{log\_var()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a92f919963177d1243c9026207bf4eff4} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+log\+\_\+var (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{var}{, }\item[{}]{val}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Writes a variable's name and value to the log file

        arguments:
            var:
                desc:   A variable name.
                type:   [str, unicode]
            val:
                desc:   A variable value
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a64932565f07b4c3136bd005b020d13a5}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a4690ed005a1a5dd8fc8f794ef19fdb1d}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a383b698fb424be2f0ea6c7e9c55e6881}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a1831aa34019582c634485afa4788a753}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_afa80db525c0d9132ebce5521537f17d4}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!pupil\_size@{pupil\_size}}
\index{pupil\_size@{pupil\_size}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{pupil\_size()}{pupil\_size()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_afa80db525c0d9132ebce5521537f17d4} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+pupil\+\_\+size (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Returns the newest pupil size sample; size may be measured as the
            diameter or the area of the pupil, depending on your setup (note
            that pupil size mostly is given in an arbitrary units).

        returns:
            desc:   Returns pupil size for the eye that is currently
                    being tracked (as specified by self.eye_used) or -1
                    when no data is obtainable.
            type:   [int, float]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_ad7ddb90acd83bc75634ec8950a94c45d}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_af783a3e87da620015aed11e4fe9eacab}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a9ed20f579ca1332f7a7233d04d44725e}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a246f2b530abe5b32d35ff5ea07567e90}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_ad70c2ab9b423b80006005fd4b91cdf7b}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a46a289b91b78051ec66747a7275749c3}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a28ed7e32044a73783569acbe554f0ccc}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a259c1d4082a50f1ebe45a1cd64074071}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_adc02ba529f099f36a3af0717e1b51be3}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!sample@{sample}}
\index{sample@{sample}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{sample()}{sample()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_adc02ba529f099f36a3af0717e1b51be3} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+sample (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Returns newest available gaze position.

        returns:
            desc:   An (x,y) tuple or a (-1,-1) on an error.
            type:   tuple
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_aa381ee0a3c4986dbb6eff4cd414a9d56}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a8f2af78b05a165d7b2b58328255b583a}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a99a1caf7d1e658eeea3e137962835237}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_aed57e2d5b309e3696df3ce97a9790da1}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a5522e63700f034ade79726c9f8cfbe33}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_ae8505fb19d89b7fbc05e3d3b0e33d58f}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a8a61af4152569f87d3d118c18ce78dad}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a2a487fb05d665d02080ea4b952215f9e}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a48de05b7dc87c8c8a6e9422d51f55741}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!send\_command@{send\_command}}
\index{send\_command@{send\_command}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{send\_command()}{send\_command()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a48de05b7dc87c8c8a6e9422d51f55741} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+send\+\_\+command (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{cmd}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Directly sends a command to the eye tracker (not supported for all
            brands; might produce a warning message if your setup does not
            support direct commands).

        arguments:
            cmd:
                desc:   The command to be sent to the eye tracker.
                type:   [str, unicode]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_addb67a60e886d04e714bf7ae48f07f16}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a2a06bb41271e839875f09b5cf82694c6}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a656d5ae01270448e4e372317da252993}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a4c39f28f6032ae246f539439442020d9}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_ae04c4e6ccb6e9871653a341c3a6542b1}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a294a765b6831c2a10cbadd665b127adf}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_ae1bc33d1fc27a7f07c535c3e9fdf7ab6}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!set\_detection\_type@{set\_detection\_type}}
\index{set\_detection\_type@{set\_detection\_type}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{set\_detection\_type()}{set\_detection\_type()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_ae1bc33d1fc27a7f07c535c3e9fdf7ab6} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+set\+\_\+detection\+\_\+type (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{eventdetection}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Set the event detection type to either PyGaze algorithms, or
            native algorithms as provided by the manufacturer (only if
            available: detection type will default to PyGaze if no native
            functions are available)

        arguments:
            eventdetection:
                desc: |
                        A string indicating which detection type
                        should be employed: either 'pygaze' for
                        PyGaze event detection algorithms or
                        'native' for manufacturers algorithms (only
                        if available; will default to 'pygaze' if no
                        native event detection is available)
                type:   [str, unicode]

        returns:
            desc:       Detection type for saccades, fixations and
                        blinks in a tuple, e.g.
                        ('pygaze','native','native') when 'native'
                        was passed, but native detection was not
                        available for saccade detection.
            type:       tuple
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a49fb1138e5aab6c3e5dade19407b5c7c}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a4bccd2901adfd2e0af5cd2708714262b}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a1c1aa9ae4e2bb7e6b608f0a44d96144c}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_ad2a9090f7d2419500f7d3e01ed078c4d}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_af8b6d522b0ab0dcbf7996334f1b617a1}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_ae425c468ceafb500b911231f5b10fa58}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!set\_draw\_calibration\_target\_func@{set\_draw\_calibration\_target\_func}}
\index{set\_draw\_calibration\_target\_func@{set\_draw\_calibration\_target\_func}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{set\_draw\_calibration\_target\_func()}{set\_draw\_calibration\_target\_func()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_ae425c468ceafb500b911231f5b10fa58} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+set\+\_\+draw\+\_\+calibration\+\_\+target\+\_\+func (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{func}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Specifies a custom function to draw the calibration target. This
            will function will override the default [draw_calibration_target].

        arguments:
            func:
                desc:   The function to draw a calibration target. This function
                        should accept two parameters, for the x and y coordinate
                        of the target.
                type:   function
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a15cc81042b9a53868f7302fe0cf3ca97}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a2cb6ee0bfdf9ca4f34d1dc073843a8f3}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!set\_draw\_drift\_correction\_target\_func@{set\_draw\_drift\_correction\_target\_func}}
\index{set\_draw\_drift\_correction\_target\_func@{set\_draw\_drift\_correction\_target\_func}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{set\_draw\_drift\_correction\_target\_func()}{set\_draw\_drift\_correction\_target\_func()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a2cb6ee0bfdf9ca4f34d1dc073843a8f3} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+set\+\_\+draw\+\_\+drift\+\_\+correction\+\_\+target\+\_\+func (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{func}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Specifies a custom function to draw the drift-correction target.
            This function will override the default
            [draw_drift_correction_target].

        arguments:
            func:
                desc:   The function to draw a drift-correction target. This
                        function should accept two parameters, for the x and y
                        coordinate of the target.
                type:   function
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a92494e1481bf6ea4f8e53fa823381db8}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a2e6b839b5f11cbd5c5a3763cc4de4dee}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!set\_eye\_used@{set\_eye\_used}}
\index{set\_eye\_used@{set\_eye\_used}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{set\_eye\_used()}{set\_eye\_used()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a2e6b839b5f11cbd5c5a3763cc4de4dee} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+set\+\_\+eye\+\_\+used (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Logs the `eye_used` variable, based on which eye was specified
            (if both eyes are being tracked, the left eye is used). Does not
            return anything.
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a85291ed8c30cb08714c928f848eabf05}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a279ad1dfbfe861d0fb2208fc6227d126}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_aa050878992870ef2ef8db851ac799bd1}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_af5efc86c93d94080b05d7c25e38aa763}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_ae6b7eff3dc9f209952542024f25c8bb9}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a5e679620aadceb234c5fc55da1faa60d}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!start\_recording@{start\_recording}}
\index{start\_recording@{start\_recording}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{start\_recording()}{start\_recording()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a5e679620aadceb234c5fc55da1faa60d} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+start\+\_\+recording (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Starts recording. Sets `self.recording` to `True` when recording
            is successfully started.
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a883d00b647f038fb7b37838accf6eca5}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a0cb296faa1cddad3887a447382e4e871}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a17b497a8e0e05a8cd8b5099710441017}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_ae4e4b37af3fb8ced878eada707e3289a}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a2e16e651c6049ff128357eaa7c706e69}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a231d4615f50dbbd63e0e9fadf6a7abfc}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a90403a1038cb4e74c8f1c088476103d1}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a1b2a2ae55c8b4a57774f718e8f331817}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a1664d48e4913d8097fb457f238f02923}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!status\_msg@{status\_msg}}
\index{status\_msg@{status\_msg}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{status\_msg()}{status\_msg()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a1664d48e4913d8097fb457f238f02923} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+status\+\_\+msg (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{msg}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Sends a status message to the eye tracker, which is displayed in
            the tracker's GUI (only available for EyeLink setups).

        arguments:
            msg:
                desc: |
                        A string that is to be displayed on the experimenter PC,
                        e.g.: "current trial: %d" % trialnr.
                type:   [str, unicode]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a970fed859fe2fae63e1d8e74c363bba6}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a98f4d56dbfeeaad4df9dee59317cfdfc}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a23b5601f571d1a34fadf03dfa382ecaf}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a071a93ba8bb46b04fcb59d2e022baece}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a30360c241b6fb19d85cb9f8123696067}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a7b332be9208741719352e858680e08c9}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6936119910931316c5df84353eb1c845}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!stop\_recording@{stop\_recording}}
\index{stop\_recording@{stop\_recording}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{stop\_recording()}{stop\_recording()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6936119910931316c5df84353eb1c845} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+stop\+\_\+recording (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Stops recording. Sets `self.recording` to `False` when recording is
            successfully stopped.
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a5bf71be113c22186b26667370c0bed02}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a0f9ce8fde5012545bcec8532f9973e93}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a8016506f8b093cff288d78f66bb8ce7e}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_ac4132ccb330e77345bc41362e88aefc0}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a9b476ff5adce93912c1fbcde0cb58cd4}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a3a3629d2aada719a6e7c1ff3966034c8}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a9e2a8f564abba39db45ad995da29cb3e}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a587f6ee9f75714b8dacce1faa12b5c35}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a71c103171fec41c5d94e0c6848e4e776}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_blink\_end@{wait\_for\_blink\_end}}
\index{wait\_for\_blink\_end@{wait\_for\_blink\_end}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_blink\_end()}{wait\_for\_blink\_end()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a71c103171fec41c5d94e0c6848e4e776} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+blink\+\_\+end (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Waits for a blink end and returns the blink ending time.
            Detection based on Dalmaijer et al. (2013) if EVENTDETECTION is set
            to 'pygaze', or using native detection functions if EVENTDETECTION
            is set to 'native' (NOTE: not every system has native functionality;
            will fall back to ;pygaze' if 'native' is not available!)

        returns:
            desc:   Blink ending time in milliseconds, as measured from
                    experiment begin time.
            type:   [int, float]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_add28009f5cc81ed58c8ca2bc9395ff6d}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_ae93b89a7c262c614d03c22395ff9c163}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a2603253d6c82d61d788a90a7a00bf0a9}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_af0ace7a24128054a48f6379718c1239b}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_abb8c27159f9348c80079e11a92c0e68d}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a173f62e77db1cdf124120291510de015}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_ae3fa89cfca6c58e03f5d2df83d12aa5f}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_ae9c2145d399b22f170d2a66cee9f4221}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a59364472b9f0f9bde0485586502401f4}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_blink\_start@{wait\_for\_blink\_start}}
\index{wait\_for\_blink\_start@{wait\_for\_blink\_start}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_blink\_start()}{wait\_for\_blink\_start()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a59364472b9f0f9bde0485586502401f4} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+blink\+\_\+start (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Waits for a blink start and returns the blink starting time.
            Detection based on Dalmaijer et al. (2013) if EVENTDETECTION is set
            to 'pygaze', or using native detection functions if EVENTDETECTION
            is set to 'native' (NOTE: not every system has native functionality;
            will fall back to ;pygaze' if 'native' is not available!)

        returns:
            desc:   Blink starting time in milliseconds, as measured from
                    experiment begin time
            type:   [int, float]
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a905f54b865e0d25782c34dbcb927cec7}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a7a916cad99f4dfb693d6ffd9e55494a0}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a62994ba7de80bcb007ed72416a2e3427}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a5d12b5a0ac7ac700fb881b7fef038cf7}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a019acd1ac39a83b8b6089da9b8942b66}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_aed2913ed1838dfb5b2cc70437fe613d7}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a618c50ec01d2e99f37969ee447b320e1}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_ac701f4817f6a2610b85509e937be7709}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a4e1b1428e6053b3804230af6c3a4dd33}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_event@{wait\_for\_event}}
\index{wait\_for\_event@{wait\_for\_event}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_event()}{wait\_for\_event()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a4e1b1428e6053b3804230af6c3a4dd33} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+event (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{event}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc:
            Waits for an event.

        arguments:
            event:
                desc: |
                    An integer event code, one of the following:

                    - 3 = STARTBLINK
                    - 4 = ENDBLINK
                    - 5 = STARTSACC
                    - 6 = ENDSACC
                    - 7 = STARTFIX
                    - 8 = ENDFIX

                type:   int

        returns:
            desc:   A `self.wait_for_*` method is called, depending on the
                    specified event; the return value of corresponding
                    method is returned.
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a9a88497dfe244029a2f00623e58063aa}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a6712e91ed36b35ee82316c3b5221b04f}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_aa160b115b83cbd53d4d59bdfe3edbf41}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a0f800adf7fbecfa694b31d6c7738cc59}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a90bd19d165c73d3abcab6f212b3d7c6a}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a9c6c29f83053a6fcc86927dfcc720034}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_abf2fc54bcd7d7762c70e48c2a98869d5}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_fixation\_end@{wait\_for\_fixation\_end}}
\index{wait\_for\_fixation\_end@{wait\_for\_fixation\_end}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_fixation\_end()}{wait\_for\_fixation\_end()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_abf2fc54bcd7d7762c70e48c2a98869d5} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+fixation\+\_\+end (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Returns time and gaze position when a fixation has ended;
            function assumes that a 'fixation' has ended when a deviation of
            more than self.pxfixtresh from the initial fixation position has
            been detected (self.pxfixtresh is created in self.calibration,
            based on self.fixtresh, a property defined in self.__init__).
            Detection based on Dalmaijer et al. (2013) if EVENTDETECTION is set
            to 'pygaze', or using native detection functions if EVENTDETECTION
            is set to 'native' (NOTE: not every system has native functionality;
            will fall back to ;pygaze' if 'native' is not available!)

        returns:
            desc:   A `time, gazepos` tuple. Time is the end time in
                    milliseconds (from expstart), gazepos is a (x,y) gaze
                    position tuple of the position from which the fixation was
                    initiated.
            type:   tuple
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a501883de4e8ae7911f845944bad6efd2}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a9705993cdfaec1e041483d5c1b0e9420}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_af518292106e0cf656cf90977f3f9f7d1}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a462c1c4e168a79068654fecb7ff9d874}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_aa887850a99d205c446e5fb86fedabcea}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a1eee76da40946f6efc4dd4268c9fcdab}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a6d15e76bdafa2de5712aec32036cc2fc}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_abc73f4a8f964074a9d235a5ba99b12ec}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a8c0f412002fcd9589b1cc859befa7f74}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_fixation\_start@{wait\_for\_fixation\_start}}
\index{wait\_for\_fixation\_start@{wait\_for\_fixation\_start}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_fixation\_start()}{wait\_for\_fixation\_start()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a8c0f412002fcd9589b1cc859befa7f74} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+fixation\+\_\+start (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Returns starting time and position when a fixation is started;
            function assumes a 'fixation' has started when gaze position
            remains reasonably stable (i.e. when most deviant samples are
            within self.pxfixtresh) for five samples in a row (self.pxfixtresh
            is created in self.calibration, based on self.fixtresh, a property
            defined in self.__init__).
            Detection based on Dalmaijer et al. (2013) if EVENTDETECTION is set
            to 'pygaze', or using native detection functions if EVENTDETECTION
            is set to 'native' (NOTE: not every system has native functionality;
            will fall back to ;pygaze' if 'native' is not available!)

        returns:
            desc:   A `time, gazepos` tuple. Time is the starting time in
                    milliseconds (from expstart), gazepos is a (x,y) gaze
                    position tuple of the position from which the fixation was
                    initiated.
            type:   tuple
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a189484af5beae50efa2c583604eb3df1}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a15fc2d2fbb413d2d7e7e572ad2b6c3c7}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_adc243fa33753c97a8fc64444d6219de5}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_aa45f4b5d2e54b4bef20db52dab8e0502}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_ac0578045a59c05cb7a1b28a9df55fd38}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_ad86ac6c72ea5908922898ecd3a318fdd}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_af1e7dec1857704095ba0d459a9a4e8da}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a356951e57bce4a1fe017243927bbede5}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6ffc7f2d4d9570b9f558c05771bcced1}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_saccade\_end@{wait\_for\_saccade\_end}}
\index{wait\_for\_saccade\_end@{wait\_for\_saccade\_end}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_saccade\_end()}{wait\_for\_saccade\_end()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6ffc7f2d4d9570b9f558c05771bcced1} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+saccade\+\_\+end (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Returns ending time, starting and end position when a saccade is
            ended; based on Dalmaijer et al. (2013) online saccade detection
            algorithm if EVENTDETECTION is set to 'pygaze', or using native
            detection functions if EVENTDETECTION is set to 'native' (NOTE: not
            every system has native functionality; will fall back to ;pygaze'
            if 'native' is not available!)

        returns:
            desc:   An `endtime, startpos, endpos` tuple. Endtime in
                    milliseconds (from expbegintime); startpos and endpos
                    are (x,y) gaze position tuples.
            type:   tuple
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_a18f27e2dfce3c65d4715a24e1b7a34c4}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a707b529f0c551167352477c94471bb73}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a204a57b3d0d3be958263303cc2bffccf}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_aca403cdc962020fa50e2f2c16b67ef75}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a45629038b322f72732b6dfc8d797f4cd}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_acdbdbcd1e32af05795d436105fab46e0}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a5947a47b52309c945c126c3a2dcffe46}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_ae7b7e26117326b3e908407f8be996ec2}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6b1ca931a4b9b467eb6e2fc219d4d9c8}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!wait\_for\_saccade\_start@{wait\_for\_saccade\_start}}
\index{wait\_for\_saccade\_start@{wait\_for\_saccade\_start}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{wait\_for\_saccade\_start()}{wait\_for\_saccade\_start()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6b1ca931a4b9b467eb6e2fc219d4d9c8} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+wait\+\_\+for\+\_\+saccade\+\_\+start (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        desc: |
            Returns starting time and starting position when a saccade is
            started; based on Dalmaijer et al. (2013) online saccade detection
            algorithm if EVENTDETECTION is set to 'pygaze', or using native
            detection functions if EVENTDETECTION is set to 'native' (NOTE: not
            every system has native functionality; will fall back to ;pygaze'
            if 'native' is not available!)

        returns:
            desc:   An `endtime, startpos` tuple. Endtime in milliseconds (from
                    expbegintime); startpos is an (x,y) gaze position tuple.
            type:   tuple
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdumbdummy_1_1_dumb_dummy_af98aed50b7e1f1010dc74746a1d9fafe}{pygaze.\+\_\+eyetracker.\+libdumbdummy.\+Dumb\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_ae5181b8def43bff900c3497d194955bb}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a128340c8e8282728fc1860320478ff2e}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a68a9ae7f432940bb320c265c2974dfd6}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a31cd091ed2f8c67c83b37f149968fb97}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobii_1_1_tobii_pro_tracker_a762b9ee39ace9e84a352a00a60a28dc5}{pygaze.\+\_\+eyetracker.\+libtobii.\+Tobii\+Pro\+Tracker}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiiglasses_1_1_tobii_glasses_tracker_a04c633f086f09d13cb2adababeb1639b}{pygaze.\+\_\+eyetracker.\+libtobiiglasses.\+Tobii\+Glasses\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libtobiilegacy_1_1_tobii_tracker_a35a9e751483c1ea1eeae6c7cb9a0c05c}{pygaze.\+\_\+eyetracker.\+libtobiilegacy.\+Tobii\+Tracker}}.



\doxysubsection{Member Data Documentation}
\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a5d4d7a6af7e5e91b911256ee66ece3ee}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!draw\_calibration\_target@{draw\_calibration\_target}}
\index{draw\_calibration\_target@{draw\_calibration\_target}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{draw\_calibration\_target}{draw\_calibration\_target}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a5d4d7a6af7e5e91b911256ee66ece3ee} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+draw\+\_\+calibration\+\_\+target = func}



Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a8716fc8144a0bef8c367d5e6f176b1e2}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a1d55b850041b19644b5fe80910d13b08}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}.

\Hypertarget{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6e8f75f481dbc2e0e0c716109c5a58a8}\index{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}!draw\_drift\_correction\_target@{draw\_drift\_correction\_target}}
\index{draw\_drift\_correction\_target@{draw\_drift\_correction\_target}!pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker@{pygaze.\_eyetracker.baseeyetracker.BaseEyeTracker}}
\doxysubsubsection{\texorpdfstring{draw\_drift\_correction\_target}{draw\_drift\_correction\_target}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1baseeyetracker_1_1_base_eye_tracker_a6e8f75f481dbc2e0e0c716109c5a58a8} 
pygaze.\+\_\+eyetracker.\+baseeyetracker.\+Base\+Eye\+Tracker.\+draw\+\_\+drift\+\_\+correction\+\_\+target = func}



Reimplemented in \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libdummytracker_1_1_dummy_a468f94e1dbd79d455bcfeebb23037d3c}{pygaze.\+\_\+eyetracker.\+libdummytracker.\+Dummy}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyelink_1_1libeyelink_a0ce695940556bec5a7ccd8df8b947c7a}{pygaze.\+\_\+eyetracker.\+libeyelink.\+libeyelink}}, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libeyetribe_1_1_eye_tribe_tracker_a2ee1e47d8fedbb6caaf36f4d8104321d}{pygaze.\+\_\+eyetracker.\+libeyetribe.\+Eye\+Tribe\+Tracker}}, and \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1libopengaze_1_1_open_gaze_tracker_a5edb10ca286533522e5ae61d0e50712e}{pygaze.\+\_\+eyetracker.\+libopengaze.\+Open\+Gaze\+Tracker}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
C\+:/\+Users/lurax/eyetracking\+Tobii/pygaze/\+\_\+eyetracker/\mbox{\hyperlink{baseeyetracker_8py}{baseeyetracker.\+py}}\end{DoxyCompactItemize}
