\section{marlintpc\-:\-:Global\-Field\-Processor Class Reference}
\label{classmarlintpc_1_1GlobalFieldProcessor}\index{marlintpc\-::\-Global\-Field\-Processor@{marlintpc\-::\-Global\-Field\-Processor}}


\doxyref{Global\-Field\-Processor}{p.}{classmarlintpc_1_1GlobalFieldProcessor} \-: This processor manages the fields used in Marlin\-T\-P\-C.  




{\ttfamily \#include $<$Global\-Field\-Processor.\-h$>$}

Inheritance diagram for marlintpc\-:\-:Global\-Field\-Processor\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classmarlintpc_1_1GlobalFieldProcessor}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class {\bf Coil\-Position\-Notifier}
\item 
class {\bf Field\-Notifier}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Global\-Field\-Processor} ()\label{classmarlintpc_1_1GlobalFieldProcessor_a9fc2fa48f1640ae6a3ab00c7900c9bf8}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
virtual {\bf $\sim$\-Global\-Field\-Processor} ()\label{classmarlintpc_1_1GlobalFieldProcessor_a72c649d4453673ea19840d07d8daa5e4}

\begin{DoxyCompactList}\small\item\em destructor \end{DoxyCompactList}\item 
virtual Processor $\ast$ {\bf new\-Processor} ()\label{classmarlintpc_1_1GlobalFieldProcessor_ab366e8dc5af876a71b1d924d16f026e3}

\begin{DoxyCompactList}\small\item\em used by Marlin to create a new processor \end{DoxyCompactList}\item 
virtual void {\bf init} ()
\begin{DoxyCompactList}\small\item\em Called at the begin of the job before anything is read. \end{DoxyCompactList}\item 
virtual void {\bf process\-Run\-Header} (lcio\-::\-L\-C\-Run\-Header $\ast$run)\label{classmarlintpc_1_1GlobalFieldProcessor_a42e248fb3a7ea9f5d63db3aee9e3bf4c}

\begin{DoxyCompactList}\small\item\em Called for every run. \end{DoxyCompactList}\item 
virtual void {\bf process\-Event} (lcio\-::\-L\-C\-Event $\ast$evt)\label{classmarlintpc_1_1GlobalFieldProcessor_af7d0ef3052fa0a1cdd4555da344dec57}

\begin{DoxyCompactList}\small\item\em Called for every event -\/ the working horse. \end{DoxyCompactList}\item 
virtual void {\bf check} (lcio\-::\-L\-C\-Event $\ast$evt)\label{classmarlintpc_1_1GlobalFieldProcessor_a7ecca1de559d62e79b1d82e4e57bdfdc}

\begin{DoxyCompactList}\small\item\em Called after the event has been processed. \end{DoxyCompactList}\item 
virtual void {\bf end} ()\label{classmarlintpc_1_1GlobalFieldProcessor_aa6b6fd2b62be74581f36ff98d43c83af}

\begin{DoxyCompactList}\small\item\em Called after data processing for clean up. \end{DoxyCompactList}\item 
bool {\bf register\-\_\-field} ({\bf Field} $\ast$)\label{classmarlintpc_1_1GlobalFieldProcessor_ae09dce0494debafcba1c1d1fb591ad55}

\begin{DoxyCompactList}\small\item\em registers a field with the field manager \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep\-Vector {\bf get\-\_\-global\-\_\-magnetic\-\_\-field} (const C\-L\-H\-E\-P\-::\-Hep\-Vector \&x) const 
\begin{DoxyCompactList}\small\item\em Returns the magnetic field (in T) at a given point and time in the detector. \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-global\-\_\-magnetic\-\_\-field} (const C\-L\-H\-E\-P\-::\-Hep3\-Vector \&x) const \label{classmarlintpc_1_1GlobalFieldProcessor_a2653c0efd1bc0e1c4f9a4ff5f111ba63}

\begin{DoxyCompactList}\small\item\em Returns the magnetic field (in T) at a given point and time in the detector. \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-global\-\_\-magnetic\-\_\-field\-\_\-error} () const \label{classmarlintpc_1_1GlobalFieldProcessor_a00ea8b8e9d7277fa90ac1d12421e99c4}

\begin{DoxyCompactList}\small\item\em Returns the combined symmetric field errors (in T) of measured magnetic field maps. \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep\-Vector {\bf get\-\_\-global\-\_\-electric\-\_\-field} (const C\-L\-H\-E\-P\-::\-Hep\-Vector \&x) const 
\begin{DoxyCompactList}\small\item\em Returns the electric field (in V) at a given point and time in the detector. \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-global\-\_\-electric\-\_\-field} (const C\-L\-H\-E\-P\-::\-Hep3\-Vector \&x) const \label{classmarlintpc_1_1GlobalFieldProcessor_aaca5d9535425e2638209171ca39c678a}

\begin{DoxyCompactList}\small\item\em Returns the electric field (in V) at a given point and time in the detector. \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-global\-\_\-electric\-\_\-field\-\_\-error} () const \label{classmarlintpc_1_1GlobalFieldProcessor_add502bf24031505b754c5e03208d9a31}

\begin{DoxyCompactList}\small\item\em Returns the combined symmetric field errors (in T) of measured electric field maps. \end{DoxyCompactList}\item 
double {\bf get\-\_\-main\-\_\-crossing\-\_\-angle} () const \label{classmarlintpc_1_1GlobalFieldProcessor_ad242792967c797b114f5192c14495f7f}

\begin{DoxyCompactList}\small\item\em returns the main crossing angle of the I\-L\-C model \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static {\bf Global\-Field\-Processor} \& {\bf get\-\_\-instance} ()\label{classmarlintpc_1_1GlobalFieldProcessor_a18ec25375b64171505b943f80135d483}

\begin{DoxyCompactList}\small\item\em return the instance of the global field processor \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\doxyref{Global\-Field\-Processor}{p.}{classmarlintpc_1_1GlobalFieldProcessor} \-: This processor manages the fields used in Marlin\-T\-P\-C. 

\begin{DoxyAuthor}{Author}
J. Abernathy (U\-Vic)\par
 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\index{marlintpc\-::\-Global\-Field\-Processor@{marlintpc\-::\-Global\-Field\-Processor}!get\-\_\-global\-\_\-electric\-\_\-field@{get\-\_\-global\-\_\-electric\-\_\-field}}
\index{get\-\_\-global\-\_\-electric\-\_\-field@{get\-\_\-global\-\_\-electric\-\_\-field}!marlintpc::GlobalFieldProcessor@{marlintpc\-::\-Global\-Field\-Processor}}
\subsubsection[{get\-\_\-global\-\_\-electric\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}C\-L\-H\-E\-P\-::\-Hep\-Vector marlintpc\-::\-Global\-Field\-Processor\-::get\-\_\-global\-\_\-electric\-\_\-field (
\begin{DoxyParamCaption}
\item[{const C\-L\-H\-E\-P\-::\-Hep\-Vector \&}]{x}
\end{DoxyParamCaption}
) const}\label{classmarlintpc_1_1GlobalFieldProcessor_a5383912267fd37e37fc450b773ae0e5d}


Returns the electric field (in V) at a given point and time in the detector. 

\begin{DoxyRefDesc}{Deprecated}
\item[{\bf Deprecated}]replaced by get\-\_\-global\-\_\-electric\-\_\-field(const C\-L\-H\-E\-P\-::\-Hep3\-Vector\&) \end{DoxyRefDesc}


Referenced by marlintpc\-::\-Electron\-Cloud\-Drifter\-Processor\-::ion\-\_\-drift\-\_\-derivative().

\index{marlintpc\-::\-Global\-Field\-Processor@{marlintpc\-::\-Global\-Field\-Processor}!get\-\_\-global\-\_\-magnetic\-\_\-field@{get\-\_\-global\-\_\-magnetic\-\_\-field}}
\index{get\-\_\-global\-\_\-magnetic\-\_\-field@{get\-\_\-global\-\_\-magnetic\-\_\-field}!marlintpc::GlobalFieldProcessor@{marlintpc\-::\-Global\-Field\-Processor}}
\subsubsection[{get\-\_\-global\-\_\-magnetic\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}C\-L\-H\-E\-P\-::\-Hep\-Vector marlintpc\-::\-Global\-Field\-Processor\-::get\-\_\-global\-\_\-magnetic\-\_\-field (
\begin{DoxyParamCaption}
\item[{const C\-L\-H\-E\-P\-::\-Hep\-Vector \&}]{x}
\end{DoxyParamCaption}
) const}\label{classmarlintpc_1_1GlobalFieldProcessor_a60c169684fc185e0704c44b56c872860}


Returns the magnetic field (in T) at a given point and time in the detector. 

\begin{DoxyRefDesc}{Deprecated}
\item[{\bf Deprecated}]replaced by get\-\_\-global\-\_\-magnetic\-\_\-field(const C\-L\-H\-E\-P\-::\-Hep3\-Vector\&) \end{DoxyRefDesc}
\index{marlintpc\-::\-Global\-Field\-Processor@{marlintpc\-::\-Global\-Field\-Processor}!init@{init}}
\index{init@{init}!marlintpc::GlobalFieldProcessor@{marlintpc\-::\-Global\-Field\-Processor}}
\subsubsection[{init}]{\setlength{\rightskip}{0pt plus 5cm}void marlintpc\-::\-Global\-Field\-Processor\-::init (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1GlobalFieldProcessor_a4eab9280f238f5d8725bca446261b303}


Called at the begin of the job before anything is read. 

Use to initialize the processor, e.\-g. book histograms. 

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