\hypertarget{catechise_8h}{
\section{catechise.h File Reference}
\label{catechise_8h}\index{catechise.h@{catechise.h}}
}
The the catechise routine creates the histograms against which the event data will be encoded. 

{\tt \#include \char`\"{}collect.h\char`\"{}}\par
{\tt \#include \char`\"{}LSEC/compact.h\char`\"{}}\par


Include dependency graph for catechise.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=193pt]{catechise_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=157pt]{catechise_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
unsigned \hyperlink{catechise_8h_a0}{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}
The the catechise routine creates the histograms against which the event data will be encoded. 

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{catechise_8h}{catechise.h},v 1.6 2007/06/12 23:52:02 saxton Exp \end{Desc}


\subsection{Function Documentation}
\hypertarget{catechise_8h_a0}{
\index{catechise.h@{catechise.h}!LCI_catechise@{LCI\_\-catechise}}
\index{LCI_catechise@{LCI\_\-catechise}!catechise.h@{catechise.h}}
\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_8h_a0}


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}