mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2025-04-22 03:40:04 +02:00
172 lines
7.8 KiB
TeX
172 lines
7.8 KiB
TeX
\hypertarget{classdetectorData}{
|
|
\subsection{detector\-Data Class Reference}
|
|
\label{classdetectorData}\index{detectorData@{detectorData}}
|
|
}
|
|
data structure to hold the detector data after postprocessing (e.g. to plot, store in a root tree etc.)
|
|
|
|
|
|
{\tt \#include $<$detector\-Data.h$>$}
|
|
|
|
\subsubsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
\hyperlink{classdetectorData_3f8538f5f634295fc40682b8aed47b31}{detector\-Data} (double $\ast$val=NULL, double $\ast$err=NULL, double $\ast$ang=NULL, double p\_\-ind=-1, const char $\ast$fname=\char`\"{}\char`\"{}, int np=-1, int ny=1)
|
|
\begin{CompactList}\small\item\em The constructor. \item\end{CompactList}\item
|
|
\hyperlink{classdetectorData_d32a037cc2bd6e8caf4556cbd4b88ec7}{$\sim$detector\-Data} ()
|
|
\begin{CompactList}\small\item\em The destructor deletes also the arrays pointing to data/errors/angles if not NULL. \item\end{CompactList}\end{CompactItemize}
|
|
\subsubsection*{Public Attributes}
|
|
\begin{CompactItemize}
|
|
\item
|
|
double $\ast$ \hyperlink{classdetectorData_0f4e31d65f9616e83a2e5521453d0364}{values}
|
|
\begin{CompactList}\small\item\em pointer to the data \item\end{CompactList}\item
|
|
double $\ast$ \hyperlink{classdetectorData_29cb1c6bb5635e918ae28505ccd0d8f9}{errors}
|
|
\begin{CompactList}\small\item\em pointer to the errors \item\end{CompactList}\item
|
|
double $\ast$ \hyperlink{classdetectorData_cc9f9708b9ff2d840208cae843fb4b7a}{angles}
|
|
\begin{CompactList}\small\item\em pointer to the angles (NULL if no angular conversion) \item\end{CompactList}\item
|
|
double \hyperlink{classdetectorData_976b3287d46aed032487bbeed74132da}{progress\-Index}
|
|
\begin{CompactList}\small\item\em file index \item\end{CompactList}\item
|
|
char \hyperlink{classdetectorData_91d1e3466878def295a531c01bdeef6b}{file\-Name} \mbox{[}1000\mbox{]}
|
|
\begin{CompactList}\small\item\em file name \item\end{CompactList}\item
|
|
int \hyperlink{classdetectorData_50aabf6f2c40587f8e915cf4913a2cfe}{npoints}
|
|
\begin{CompactList}\small\item\em number of points \item\end{CompactList}\item
|
|
int \hyperlink{classdetectorData_c289d259e7fd9445a9c04976a82cb324}{npy}
|
|
\begin{CompactList}\small\item\em dimensions in y coordinate \item\end{CompactList}\end{CompactItemize}
|
|
|
|
|
|
\subsubsection{Detailed Description}
|
|
data structure to hold the detector data after postprocessing (e.g. to plot, store in a root tree etc.)
|
|
|
|
|
|
|
|
Definition at line 9 of file detector\-Data.h.
|
|
|
|
\subsubsection{Constructor \& Destructor Documentation}
|
|
\hypertarget{classdetectorData_3f8538f5f634295fc40682b8aed47b31}{
|
|
\index{detectorData@{detector\-Data}!detectorData@{detectorData}}
|
|
\index{detectorData@{detectorData}!detectorData@{detector\-Data}}
|
|
\paragraph[detectorData]{\setlength{\rightskip}{0pt plus 5cm}detector\-Data::detector\-Data (double $\ast$ {\em val} = {\tt NULL}, double $\ast$ {\em err} = {\tt NULL}, double $\ast$ {\em ang} = {\tt NULL}, double {\em p\_\-ind} = {\tt -1}, const char $\ast$ {\em fname} = {\tt \char`\"{}\char`\"{}}, int {\em np} = {\tt -1}, int {\em ny} = {\tt 1})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}\hfill}
|
|
\label{classdetectorData_3f8538f5f634295fc40682b8aed47b31}
|
|
|
|
|
|
The constructor.
|
|
|
|
\begin{Desc}
|
|
\item[Parameters:]
|
|
\begin{description}
|
|
\item[{\em val}]pointer to the data \item[{\em err}]pointer to errors \item[{\em ang}]pointer to the angles \item[{\em f\_\-ind}]file index \item[{\em fname}]file name to which the data are saved \item[{\em np}]number of points in x coordinate defaults to the number of detector channels (1D detector) \item[{\em ny}]dimension in y (1D detector) \end{description}
|
|
\end{Desc}
|
|
|
|
|
|
Definition at line 20 of file detector\-Data.h.
|
|
|
|
References file\-Name.\hypertarget{classdetectorData_d32a037cc2bd6e8caf4556cbd4b88ec7}{
|
|
\index{detectorData@{detector\-Data}!~detectorData@{$\sim$detectorData}}
|
|
\index{~detectorData@{$\sim$detectorData}!detectorData@{detector\-Data}}
|
|
\paragraph[$\sim$detectorData]{\setlength{\rightskip}{0pt plus 5cm}detector\-Data::$\sim$detector\-Data ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}\hfill}
|
|
\label{classdetectorData_d32a037cc2bd6e8caf4556cbd4b88ec7}
|
|
|
|
|
|
The destructor deletes also the arrays pointing to data/errors/angles if not NULL.
|
|
|
|
|
|
|
|
Definition at line 25 of file detector\-Data.h.
|
|
|
|
References angles, errors, and values.
|
|
|
|
\subsubsection{Member Data Documentation}
|
|
\hypertarget{classdetectorData_cc9f9708b9ff2d840208cae843fb4b7a}{
|
|
\index{detectorData@{detector\-Data}!angles@{angles}}
|
|
\index{angles@{angles}!detectorData@{detector\-Data}}
|
|
\paragraph[angles]{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ \hyperlink{classdetectorData_cc9f9708b9ff2d840208cae843fb4b7a}{detector\-Data::angles}}\hfill}
|
|
\label{classdetectorData_cc9f9708b9ff2d840208cae843fb4b7a}
|
|
|
|
|
|
pointer to the angles (NULL if no angular conversion)
|
|
|
|
|
|
|
|
Definition at line 29 of file detector\-Data.h.
|
|
|
|
Referenced by $\sim$detector\-Data().\hypertarget{classdetectorData_29cb1c6bb5635e918ae28505ccd0d8f9}{
|
|
\index{detectorData@{detector\-Data}!errors@{errors}}
|
|
\index{errors@{errors}!detectorData@{detector\-Data}}
|
|
\paragraph[errors]{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ \hyperlink{classdetectorData_29cb1c6bb5635e918ae28505ccd0d8f9}{detector\-Data::errors}}\hfill}
|
|
\label{classdetectorData_29cb1c6bb5635e918ae28505ccd0d8f9}
|
|
|
|
|
|
pointer to the errors
|
|
|
|
|
|
|
|
Definition at line 28 of file detector\-Data.h.
|
|
|
|
Referenced by $\sim$detector\-Data().\hypertarget{classdetectorData_91d1e3466878def295a531c01bdeef6b}{
|
|
\index{detectorData@{detector\-Data}!fileName@{fileName}}
|
|
\index{fileName@{fileName}!detectorData@{detector\-Data}}
|
|
\paragraph[fileName]{\setlength{\rightskip}{0pt plus 5cm}char \hyperlink{classdetectorData_91d1e3466878def295a531c01bdeef6b}{detector\-Data::file\-Name}\mbox{[}1000\mbox{]}}\hfill}
|
|
\label{classdetectorData_91d1e3466878def295a531c01bdeef6b}
|
|
|
|
|
|
file name
|
|
|
|
|
|
|
|
Definition at line 31 of file detector\-Data.h.
|
|
|
|
Referenced by detector\-Data().\hypertarget{classdetectorData_50aabf6f2c40587f8e915cf4913a2cfe}{
|
|
\index{detectorData@{detector\-Data}!npoints@{npoints}}
|
|
\index{npoints@{npoints}!detectorData@{detector\-Data}}
|
|
\paragraph[npoints]{\setlength{\rightskip}{0pt plus 5cm}int \hyperlink{classdetectorData_50aabf6f2c40587f8e915cf4913a2cfe}{detector\-Data::npoints}}\hfill}
|
|
\label{classdetectorData_50aabf6f2c40587f8e915cf4913a2cfe}
|
|
|
|
|
|
number of points
|
|
|
|
|
|
|
|
Definition at line 32 of file detector\-Data.h.
|
|
|
|
Referenced by data\-Callback().\hypertarget{classdetectorData_c289d259e7fd9445a9c04976a82cb324}{
|
|
\index{detectorData@{detector\-Data}!npy@{npy}}
|
|
\index{npy@{npy}!detectorData@{detector\-Data}}
|
|
\paragraph[npy]{\setlength{\rightskip}{0pt plus 5cm}int \hyperlink{classdetectorData_c289d259e7fd9445a9c04976a82cb324}{detector\-Data::npy}}\hfill}
|
|
\label{classdetectorData_c289d259e7fd9445a9c04976a82cb324}
|
|
|
|
|
|
dimensions in y coordinate
|
|
|
|
|
|
|
|
Definition at line 33 of file detector\-Data.h.
|
|
|
|
Referenced by data\-Callback().\hypertarget{classdetectorData_976b3287d46aed032487bbeed74132da}{
|
|
\index{detectorData@{detector\-Data}!progressIndex@{progressIndex}}
|
|
\index{progressIndex@{progressIndex}!detectorData@{detector\-Data}}
|
|
\paragraph[progressIndex]{\setlength{\rightskip}{0pt plus 5cm}double \hyperlink{classdetectorData_976b3287d46aed032487bbeed74132da}{detector\-Data::progress\-Index}}\hfill}
|
|
\label{classdetectorData_976b3287d46aed032487bbeed74132da}
|
|
|
|
|
|
file index
|
|
|
|
|
|
|
|
Definition at line 30 of file detector\-Data.h.\hypertarget{classdetectorData_0f4e31d65f9616e83a2e5521453d0364}{
|
|
\index{detectorData@{detector\-Data}!values@{values}}
|
|
\index{values@{values}!detectorData@{detector\-Data}}
|
|
\paragraph[values]{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ \hyperlink{classdetectorData_0f4e31d65f9616e83a2e5521453d0364}{detector\-Data::values}}\hfill}
|
|
\label{classdetectorData_0f4e31d65f9616e83a2e5521453d0364}
|
|
|
|
|
|
pointer to the data
|
|
|
|
|
|
|
|
Definition at line 25 of file detector\-Data.h.
|
|
|
|
Referenced by $\sim$detector\-Data().
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
\hyperlink{detectorData_8h}{detector\-Data.h}\end{CompactItemize}
|