\section{marlintpc\-:\-:Cylindrical2\-D\-Magnetic\-Field Class Reference}
\label{classmarlintpc_1_1Cylindrical2DMagneticField}\index{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field@{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field}}


\doxyref{Cylindrical2\-D\-Magnetic\-Field}{p.}{classmarlintpc_1_1Cylindrical2DMagneticField} \-: A magnetic field from a cylindrical 2d field map (r and z)  




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

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

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

\begin{DoxyCompactList}\small\item\em destructor \end{DoxyCompactList}\item 
void {\bf init} (double, double, double, double, double)\label{classmarlintpc_1_1Cylindrical2DMagneticField_aef692621127bf1b9db6d75fc1866188a}

\begin{DoxyCompactList}\small\item\em initialize function -- if one copies the marlin registration process it might be better to do it right I know this is a mess, but it needs a complete redesign \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 (could be anything... \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_1Cylindrical2DMagneticField_ae22832d27b3a8f91353a20be9a6fa43f}

\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{Cylindrical2\-D\-Magnetic\-Field}{p.}{classmarlintpc_1_1Cylindrical2DMagneticField} \-: A magnetic field from a cylindrical 2d field map (r and z) 

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


\subsection{Member Function Documentation}
\index{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field@{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field}!construct@{construct}}
\index{construct@{construct}!marlintpc::Cylindrical2DMagneticField@{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field}}
\subsubsection[{construct}]{\setlength{\rightskip}{0pt plus 5cm}bool marlintpc\-::\-Cylindrical2\-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_1Cylindrical2DMagneticField_a099b4012648c1b07fc7deb46b03edb7f}


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\-::\-Cylindrical2\-D\-Magnetic\-Field@{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field}!new\-\_\-field@{new\-\_\-field}}
\index{new\-\_\-field@{new\-\_\-field}!marlintpc::Cylindrical2DMagneticField@{marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field}}
\subsubsection[{new\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Field} $\ast$ marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field\-::new\-\_\-field (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1Cylindrical2DMagneticField_a6465515ae104fd1107790f3ff0598d40}


returns a new field... 

similar to how the Marlin processor registration works 

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



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



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