\doxysection{pygaze.\+\_\+eyetracker.\+pytribe.\+calibration Class Reference}
\hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration}{}\label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a7767fc3bc0ed43358e0da6ceb631a127}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1connection}{connection}})
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a4252c83b1e7db1268e7d39d564a1efb0}{set\+\_\+connection}} (self, \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1connection}{connection}})
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a502082cb7c0bdb606247227531e90894}{start}} (self, pointcount=9, max\+\_\+attempts=5)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a2fcd786b60736742bf033356f1d5669a}{pointstart}} (self, x, y)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a28531171aa9cc78556da890db15632b4}{pointend}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a72876f26e4e2ecaff0f5798c7d41a7c9}{abort}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a74a07b1d72388f1a5b46d3d3cf9cbb63}{clear}} (self)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_adea0ba4dd7028240de57a1a8c9f374b4}{connection}} = \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1connection}{connection}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}class for calibration related requests\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a7767fc3bc0ed43358e0da6ceb631a127}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a7767fc3bc0ed43358e0da6ceb631a127} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{connection}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Initializes a calibration instance

        arguments

        connection  --  a pytribe.connection instance for the currently
                        attached EyeTribe tracker
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a72876f26e4e2ecaff0f5798c7d41a7c9}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!abort@{abort}}
\index{abort@{abort}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{abort()}{abort()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a72876f26e4e2ecaff0f5798c7d41a7c9} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+abort (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Cancels the ongoing sequence and reinstates the previous
        calibration (only if there is one!)

        returns

        success     --  Boolean: True on success, False on failure
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a74a07b1d72388f1a5b46d3d3cf9cbb63}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!clear@{clear}}
\index{clear@{clear}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{clear()}{clear()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a74a07b1d72388f1a5b46d3d3cf9cbb63} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+clear (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Removes the current calibration from the tracker

        returns

        success     --  Boolean: True on success, False on failure
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a28531171aa9cc78556da890db15632b4}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!pointend@{pointend}}
\index{pointend@{pointend}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{pointend()}{pointend()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a28531171aa9cc78556da890db15632b4} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+pointend (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Mark the end of processing a calibration point

        returns

        NORMALLY:
        success     --  Boolean: True on success, False on failure

        AFTER FINAL POINT:
        calibresults    --  a dict containing the calibration results:
                        {   'result':   Boolean indicating whether the
                                    calibration was succesful
                            'deg':  float indicating the average error
                                    in degrees of visual angle
                            'Ldeg': float indicating the left eye
                                    error in degrees of visual angle
                            'Rdeg': float indicating the right eye
                                    error in degrees of visual angle
                            'calibpoints': list, containing a dict for
                                        each calibration point:
                                        {'state':   integer indicating
                                                the state of the
                                                calibration point
                                                (0 means no useful
                                                data has been
                                                obtained and the
                                                point should be
                                                resampled; 1 means
                                                the data is of
                                                questionable
                                                quality, consider
                                                resampling; 2 means
                                                the data is ok)
                                        'cpx':  x coordinate of the
                                                calibration point
                                        'cpy':  y coordinate of the
                                                calibration point
                                        'mecpx':    mean estimated x
                                                coordinate of the
                                                calibration point
                                        'mecpy':    mean estimated y
                                                coordinate of the
                                                calibration point
                                        'acd':  float indicating
                                                the accuracy in
                                                degrees of visual
                                                angle
                                        'Lacd': float indicating
                                                the accuracy in
                                                degrees of visual
                                                angle (left eye)
                                        'Racd': float indicating
                                                the accuracy in
                                                degrees of visual
                                                angle (right eye)
                                        'mepix':    mean error in
                                                pixels
                                        'Lmepix':   mean error in
                                                pixels (left eye)
                                        'Rmepix':   mean error in
                                                pixels (right eye)
                                        'asdp': standard deviation
                                                in pixels
                                        'Lasdp':    standard deviation
                                                in pixels (left eye)
                                        'Rasdp':    standard deviation
                                                in pixels (right eye)
                                        }
                        }
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a2fcd786b60736742bf033356f1d5669a}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!pointstart@{pointstart}}
\index{pointstart@{pointstart}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{pointstart()}{pointstart()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a2fcd786b60736742bf033356f1d5669a} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+pointstart (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{x}{, }\item[{}]{y}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Mark the beginning of a new calibration point for the tracker to
        process

        arguments

        x           --  integer indicating the x coordinate of the
                        calibration point
        y           --  integer indicating the y coordinate of the
                        calibration point

        returns

        success     --  Boolean: True on success, False on a failure
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a4252c83b1e7db1268e7d39d564a1efb0}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!set\_connection@{set\_connection}}
\index{set\_connection@{set\_connection}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{set\_connection()}{set\_connection()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a4252c83b1e7db1268e7d39d564a1efb0} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+set\+\_\+connection (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{connection}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}Set a new connection

        arguments

        connection  --  a pytribe.connection instance for the currently
                        attached EyeTribe tracker
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a502082cb7c0bdb606247227531e90894}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!start@{start}}
\index{start@{start}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{start()}{start()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_a502082cb7c0bdb606247227531e90894} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+start (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{pointcount}{ = {\ttfamily 9}, }\item[{}]{max\+\_\+attempts}{ = {\ttfamily 5}}\end{DoxyParamCaption})}

\begin{DoxyVerb}Starts the calibration, using the passed number of calibration
        points

        keyword arguments

        pointcount  --  integer value indicating the amount of
                        calibration points that should be used, which
                        should be at least 7 (default = 9)
        max_attempts -- the number of times that calibration should be restarted
                        if starting the calibration fails (default=5)
\end{DoxyVerb}
 

\doxysubsection{Member Data Documentation}
\Hypertarget{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_adea0ba4dd7028240de57a1a8c9f374b4}\index{pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}!connection@{connection}}
\index{connection@{connection}!pygaze.\_eyetracker.pytribe.calibration@{pygaze.\_eyetracker.pytribe.calibration}}
\doxysubsubsection{\texorpdfstring{connection}{connection}}
{\footnotesize\ttfamily \label{classpygaze_1_1__eyetracker_1_1pytribe_1_1calibration_adea0ba4dd7028240de57a1a8c9f374b4} 
pygaze.\+\_\+eyetracker.\+pytribe.\+calibration.\+connection = \mbox{\hyperlink{classpygaze_1_1__eyetracker_1_1pytribe_1_1connection}{connection}}}



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