\hypertarget{decode_8h}{
\section{decode.h File Reference}
\label{decode_8h}\index{decode.h@{decode.h}}
}
Top-level decoding routines. 

{\tt \#include \char`\"{}expand.h\char`\"{}}\par
{\tt \#include \char`\"{}EDS/EBF\_\-gem.h\char`\"{}}\par
{\tt \#include \char`\"{}QSE/QSE\_\-ebf.h\char`\"{}}\par


Include dependency graph for decode.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=159pt]{decode_8h__incl}
\end{center}
\end{figure}


This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=95pt]{decode_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned int \hyperlink{decode_8h_a0}{QSEC\_\-decode} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, QSE\_\-ebf\-Evt $\ast$oevt, const unsigned int $\ast$ievt)
\begin{CompactList}\small\item\em Decode the event held in the expansion structure into the QSE\_\-evt structure. \item\end{CompactList}\item 
void \hyperlink{decode_8h_a1}{QSEC\_\-update} (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$exp, EBF\_\-gem $\ast$gem, unsigned int $\ast$seq, const unsigned int $\ast$ievt)
\begin{CompactList}\small\item\em Decode the GEM contribution and extract the 17 bit event sequence. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Top-level decoding routines. 

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{decode_8h}{decode.h},v 1.4 2008/07/17 21:47:44 saxton Exp \end{Desc}


\subsection{Function Documentation}
\hypertarget{decode_8h_a0}{
\index{decode.h@{decode.h}!QSEC_decode@{QSEC\_\-decode}}
\index{QSEC_decode@{QSEC\_\-decode}!decode.h@{decode.h}}
\subsubsection[QSEC\_\-decode]{\setlength{\rightskip}{0pt plus 5cm}unsigned int QSEC\_\-decode (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, QSE\_\-ebf\-Evt $\ast$ {\em oevt}, const unsigned int $\ast$ {\em ievt})}}
\label{decode_8h_a0}


Decode the event held in the expansion structure into the QSE\_\-evt structure. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to the expansion structure holding the histograms and encoder context\item[{\em oevt}]Pointer to the location to output the decoded event\item[{\em ievt}]Pointer to the location to input the encoded event\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Length, in bytes, of the event data\end{Desc}
\hypertarget{decode_8h_a1}{
\index{decode.h@{decode.h}!QSEC_update@{QSEC\_\-update}}
\index{QSEC_update@{QSEC\_\-update}!decode.h@{decode.h}}
\subsubsection[QSEC\_\-update]{\setlength{\rightskip}{0pt plus 5cm}void QSEC\_\-update (\hyperlink{structQSEC__expansion__}{QSEC\_\-expansion} $\ast$ {\em exp}, EBF\_\-gem $\ast$ {\em gem}, unsigned int $\ast$ {\em seq}, const unsigned int $\ast$ {\em ievt})}}
\label{decode_8h_a1}


Decode the GEM contribution and extract the 17 bit event sequence. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em exp}]Pointer to the expansion structure holding the histograms and encoder context\item[{\em gem}]Pointer to the location to place the decoded GEM contribution\item[{\em seq}]Pointer to the location to place the 17-bit event sequence number\item[{\em ievt}]Pointer to the location to input the encoded event number for use in QSE\_\-ctx\-Update\-At\-Event\end{description}
\end{Desc}
