\section{marlintpc\-:\-:Cylindrical3\-D\-Magnetic\-Field Class Reference}
\label{classmarlintpc_1_1Cylindrical3DMagneticField}\index{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field@{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field}}


\doxyref{Cylindrical3\-D\-Magnetic\-Field}{p.}{classmarlintpc_1_1Cylindrical3DMagneticField} \-: A magnetic field from a cylindrical 3d field map (r, phi and z)  




{\ttfamily \#include $<$Cylindrical3\-D\-Magnetic\-Field.\-h$>$}

Inheritance diagram for marlintpc\-:\-:Cylindrical3\-D\-Magnetic\-Field\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classmarlintpc_1_1Cylindrical3DMagneticField}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct {\bf Field\-Map\-Entry}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Cylindrical3\-D\-Magnetic\-Field} ()\label{classmarlintpc_1_1Cylindrical3DMagneticField_a0a3ee9c8ce9fc81938194c5e9fe98d4a}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
virtual {\bf $\sim$\-Cylindrical3\-D\-Magnetic\-Field} ()\label{classmarlintpc_1_1Cylindrical3DMagneticField_aababa6888ff15a2f9090466b3c149620}

\begin{DoxyCompactList}\small\item\em destructor \end{DoxyCompactList}\item 
virtual {\bf Field} $\ast$ {\bf new\-\_\-field} (void)
\begin{DoxyCompactList}\small\item\em returns a new field... \end{DoxyCompactList}\item 
virtual bool {\bf construct} (E\-V\-E\-N\-T\-::\-L\-C\-Collection $\ast$)
\begin{DoxyCompactList}\small\item\em constructs the field from an L\-C\-Collection of data objects \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-field\-\_\-value\-\_\-coil\-\_\-coordinates} (const C\-L\-H\-E\-P\-::\-Hep3\-Vector \&)\label{classmarlintpc_1_1Cylindrical3DMagneticField_a01c383ceea728995f7047f9045911289}

\begin{DoxyCompactList}\small\item\em gets the field value at a point given in coil coordinates \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\doxyref{Cylindrical3\-D\-Magnetic\-Field}{p.}{classmarlintpc_1_1Cylindrical3DMagneticField} \-: A magnetic field from a cylindrical 3d field map (r, phi and z) 

\begin{DoxyAuthor}{Author}
Christian Grefe \par
 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\index{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field@{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field}!construct@{construct}}
\index{construct@{construct}!marlintpc::Cylindrical3DMagneticField@{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field}}
\subsubsection[{construct}]{\setlength{\rightskip}{0pt plus 5cm}bool marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field\-::construct (
\begin{DoxyParamCaption}
\item[{E\-V\-E\-N\-T\-::\-L\-C\-Collection $\ast$}]{collection}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1Cylindrical3DMagneticField_a8f377adf276fed555868b9ef510eb183}


constructs the field from an L\-C\-Collection of data objects 

constructs the field from an L\-C\-Collection of data objects (could be anything...

field bin values or just parameters) 

Implements {\bf marlintpc\-::\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1MagneticField_a204827dce8fb23808f887d822eaf1fe2}.

\index{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field@{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field}!new\-\_\-field@{new\-\_\-field}}
\index{new\-\_\-field@{new\-\_\-field}!marlintpc::Cylindrical3DMagneticField@{marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field}}
\subsubsection[{new\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Field} $\ast$ marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field\-::new\-\_\-field (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1Cylindrical3DMagneticField_a4422cefd0a36a05631f514591efc26f6}


returns a new field... 

similar to how the Marlin processor registration works 

Implements {\bf marlintpc\-::\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1MagneticField_a77c3c5349528ec2aac1bf59cbdfd60cd}.



References Cylindrical3\-D\-Magnetic\-Field().



The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
Cylindrical3\-D\-Magnetic\-Field.\-h\item 
Cylindrical3\-D\-Magnetic\-Field.\-cc\end{DoxyCompactItemize}
