\hypertarget{catechise_8c}{
\section{catechise.c File Reference}
\label{catechise_8c}\index{catechise.c@{catechise.c}}
}
Examine the collected events to form the tables against which the data will be encoded. 

{\tt \#include \char`\"{}LCI/LCI\_\-msgs.h\char`\"{}}\par
{\tt \#include \char`\"{}collect.h\char`\"{}}\par
{\tt \#include \char`\"{}macros\_\-p.h\char`\"{}}\par
{\tt \#include \char`\"{}LSEC/compact.h\char`\"{}}\par
{\tt \#include \char`\"{}LSEC/LSEC\_\-ctx.h\char`\"{}}\par
{\tt \#include \char`\"{}EDS/EBF\_\-cid.h\char`\"{}}\par
{\tt \#include \char`\"{}MSG/MSG\_\-pubdefs.h\char`\"{}}\par
{\tt \#include \char`\"{}PBS/WCT.h\char`\"{}}\par
{\tt \#include $<$string.h$>$}\par
{\tt \#include $<$stdio.h$>$}\par
{\tt \#include $<$stdlib.h$>$}\par


Include dependency graph for catechise.c:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=208pt]{catechise_8c__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
static unsigned \hyperlink{catechise_8c_a0}{catechise\-Acd} (LSEC\_\-compaction $\ast$cpc, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$src, unsigned mon)
\begin{CompactList}\small\item\em Analyse the ACD and GEM contributions to the event. \item\end{CompactList}\item 
static unsigned \hyperlink{catechise_8c_a1}{catechise\-Cal} (LSEC\_\-compaction $\ast$cpc, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$src, unsigned mon)
\begin{CompactList}\small\item\em Analyse the CAL and GEM contributions to the event. \item\end{CompactList}\item 
static unsigned \hyperlink{catechise_8c_a2}{catechise\-Tkr} (LSEC\_\-compaction $\ast$cpc, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$src, unsigned mon)
\begin{CompactList}\small\item\em Analyse the TKR and GEM contributions to the event. \item\end{CompactList}\item 
unsigned \hyperlink{catechise_8c_a3}{LCI\_\-catechise} (LSEC\_\-compaction $\ast$cpc, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$src, unsigned mode, unsigned mon)
\begin{CompactList}\small\item\em Analyse the event collection and generate the histograms to encode against. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Examine the collected events to form the tables against which the data will be encoded. 

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{catechise_8c}{catechise.c},v 1.12 2007/06/12 23:51:11 saxton Exp \end{Desc}


\subsection{Function Documentation}
\hypertarget{catechise_8c_a0}{
\index{catechise.c@{catechise.c}!catechiseAcd@{catechiseAcd}}
\index{catechiseAcd@{catechiseAcd}!catechise.c@{catechise.c}}
\subsubsection[catechiseAcd]{\setlength{\rightskip}{0pt plus 5cm}unsigned catechise\-Acd (LSEC\_\-compaction $\ast$ {\em cpc}, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$ {\em src}, unsigned {\em mon})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{catechise_8c_a0}


Analyse the ACD and GEM contributions to the event. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpc}]Pointer to an LSEC\_\-compaction structure\item[{\em src}]Pointer to the source of data to compact (a collection)\item[{\em mon}]Monitoring level - controls the diagnostic output\end{description}
\end{Desc}
\hypertarget{catechise_8c_a1}{
\index{catechise.c@{catechise.c}!catechiseCal@{catechiseCal}}
\index{catechiseCal@{catechiseCal}!catechise.c@{catechise.c}}
\subsubsection[catechiseCal]{\setlength{\rightskip}{0pt plus 5cm}unsigned catechise\-Cal (LSEC\_\-compaction $\ast$ {\em cpc}, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$ {\em src}, unsigned {\em mon})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{catechise_8c_a1}


Analyse the CAL and GEM contributions to the event. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpc}]Pointer to an LSEC\_\-compaction structure\item[{\em src}]Pointer to the source of data to compact (a collection)\item[{\em mon}]Monitoring level - controls the diagnostic output\end{description}
\end{Desc}
\hypertarget{catechise_8c_a2}{
\index{catechise.c@{catechise.c}!catechiseTkr@{catechiseTkr}}
\index{catechiseTkr@{catechiseTkr}!catechise.c@{catechise.c}}
\subsubsection[catechiseTkr]{\setlength{\rightskip}{0pt plus 5cm}unsigned catechise\-Tkr (LSEC\_\-compaction $\ast$ {\em cpc}, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$ {\em src}, unsigned {\em mon})\hspace{0.3cm}{\tt  \mbox{[}inline, static\mbox{]}}}}
\label{catechise_8c_a2}


Analyse the TKR and GEM contributions to the event. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpc}]Pointer to an LSEC\_\-compaction structure\item[{\em src}]Pointer to the source of data to compact (a collection)\item[{\em mon}]Monitoring level - controls the diagnostic output\end{description}
\end{Desc}
\hypertarget{catechise_8c_a3}{
\index{catechise.c@{catechise.c}!LCI_catechise@{LCI\_\-catechise}}
\index{LCI_catechise@{LCI\_\-catechise}!catechise.c@{catechise.c}}
\subsubsection[LCI\_\-catechise]{\setlength{\rightskip}{0pt plus 5cm}unsigned LCI\_\-catechise (LSEC\_\-compaction $\ast$ {\em cpc}, \hyperlink{struct__LCI__collection}{LCI\_\-collection} $\ast$ {\em src}, unsigned {\em mode}, unsigned {\em mon})}}
\label{catechise_8c_a3}


Analyse the event collection and generate the histograms to encode against. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cpc}]Pointer to an LSEC\_\-compaction structure\item[{\em src}]Pointer to the source of data to compact (a collection)\item[{\em mode}]Calibration mode (ACD, CAL or TKR)\item[{\em mon}]Monitoring level - controls the diagnostic output\end{description}
\end{Desc}
\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em LCI\_\-SUCCESS}]If all goes well \item[{\em LCI\_\-NOTABLE}]If the compression is invoked with empty tables. \item[{\em LCI\_\-TYPE}]Returned (but not reported) if the configuration type is bad.\end{description}
\end{Desc}