aare/docs/latex/annotated.tex
2024-04-11 17:20:34 +02:00

32 lines
5.0 KiB
TeX

\doxysection{Data Structures}
Here are the data structures with brief descriptions\+:\begin{DoxyCompactList}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1CircularFifo}{aare\+::\+Circular\+Fifo$<$ Item\+Type $>$}} }{\pageref{classaare_1_1CircularFifo}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1ClusterFinder}{aare\+::\+Cluster\+Finder$<$ T $>$}} }{\pageref{classaare_1_1ClusterFinder}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1DType}{aare\+::\+DType}} }{\pageref{classaare_1_1DType}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1File}{aare\+::\+File}} \\*RAII \doxylink{classaare_1_1File_1_1File}{File} class for reading and writing image files in various formats wrapper on a \doxylink{classaare_1_1FileInterface}{File\+Interface} to abstract the underlying file format }{\pageref{classaare_1_1File}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1File_1_1File}{aare.\+File.\+File}} }{\pageref{classaare_1_1File_1_1File}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1FileConfig}{aare\+::\+File\+Config}} \\*\doxylink{structaare_1_1FileConfig}{File\+Config} structure to store the configuration of a file dtype\+: data type of the file rows\+: number of rows in the file cols\+: number of columns in the file geometry\+: geometry of the file }{\pageref{structaare_1_1FileConfig}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1FileInterface}{aare\+::\+File\+Interface}} \\*\doxylink{classaare_1_1FileInterface}{File\+Interface} class to define the interface for file operations }{\pageref{classaare_1_1FileInterface}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1Frame}{aare\+::\+Frame}} }{\pageref{classaare_1_1Frame}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1Frame_1_1Frame}{aare.\+Frame.\+Frame}} }{\pageref{classaare_1_1Frame_1_1Frame}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1ClusterFinder_1_1Hit}{aare\+::\+Cluster\+Finder$<$ T $>$\+::\+Hit}} }{\pageref{structaare_1_1ClusterFinder_1_1Hit}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1logger_1_1Logger}{aare\+::logger\+::\+Logger}} }{\pageref{classaare_1_1logger_1_1Logger}}{}
\item\contentsline{section}{\mbox{\hyperlink{structMoveOnlyInt}{Move\+Only\+Int}} }{\pageref{structMoveOnlyInt}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1NDArray}{aare\+::\+NDArray$<$ T, Ndim $>$}} }{\pageref{classaare_1_1NDArray}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1NDView}{aare\+::\+NDView$<$ T, Ndim $>$}} }{\pageref{classaare_1_1NDView}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1network__io_1_1NetworkError}{aare\+::network\+\_\+io\+::\+Network\+Error}} \\*\doxylink{classaare_1_1network__io_1_1NetworkError}{Network\+Error} exception class }{\pageref{classaare_1_1network__io_1_1NetworkError}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1NumpyFile}{aare\+::\+Numpy\+File}} \\*\doxylink{classaare_1_1NumpyFile}{Numpy\+File} class to read and write numpy files }{\pageref{classaare_1_1NumpyFile}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1NumpyHeader}{aare\+::\+Numpy\+Header}} }{\pageref{structaare_1_1NumpyHeader}}{}
\item\contentsline{section}{\mbox{\hyperlink{structfolly_1_1ProducerConsumerQueue}{folly\+::\+Producer\+Consumer\+Queue$<$ T $>$}} }{\pageref{structfolly_1_1ProducerConsumerQueue}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1RawFile}{aare\+::\+Raw\+File}} \\*\doxylink{classaare_1_1RawFile}{Raw\+File} class to read .raw and .json files }{\pageref{classaare_1_1RawFile}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1RawFileConfig}{aare\+::\+Raw\+File\+Config}} }{\pageref{structaare_1_1RawFileConfig}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1sls__detector__header}{aare\+::sls\+\_\+detector\+\_\+header}} }{\pageref{structaare_1_1sls__detector__header}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1SubFile}{aare\+::\+Sub\+File}} \\*Class to read a subfile from a \doxylink{classaare_1_1RawFile}{Raw\+File} }{\pageref{classaare_1_1SubFile}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1xy}{aare\+::xy}} }{\pageref{structaare_1_1xy}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1ZmqFrame}{aare\+::\+Zmq\+Frame}} \\*\doxylink{structaare_1_1ZmqFrame}{Zmq\+Frame} structure wrapper class to contain a \doxylink{structaare_1_1ZmqHeader}{Zmq\+Header} and a \doxylink{classaare_1_1Frame}{Frame} }{\pageref{structaare_1_1ZmqFrame}}{}
\item\contentsline{section}{\mbox{\hyperlink{structaare_1_1ZmqHeader}{aare\+::\+Zmq\+Header}} }{\pageref{structaare_1_1ZmqHeader}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1ZmqSocket}{aare\+::\+Zmq\+Socket}} }{\pageref{classaare_1_1ZmqSocket}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1ZmqSocketReceiver}{aare\+::\+Zmq\+Socket\+Receiver}} }{\pageref{classaare_1_1ZmqSocketReceiver}}{}
\item\contentsline{section}{\mbox{\hyperlink{classaare_1_1ZmqSocketSender}{aare\+::\+Zmq\+Socket\+Sender}} }{\pageref{classaare_1_1ZmqSocketSender}}{}
\end{DoxyCompactList}