\section{overlay\-:\-:F\-P\-C\-C\-D\-Overlay\-B\-X Class Reference}
\label{classoverlay_1_1FPCCDOverlayBX}\index{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X@{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X}}


\doxyref{F\-P\-C\-C\-D\-Overlay\-B\-X}{p.}{classoverlay_1_1FPCCDOverlayBX} processor for overlaying (pair) background from many bunch crossings.  




{\ttfamily \#include $<$F\-P\-C\-C\-D\-Overlay\-B\-X.\-h$>$}

Inheritance diagram for overlay\-:\-:F\-P\-C\-C\-D\-Overlay\-B\-X\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classoverlay_1_1FPCCDOverlayBX}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct {\bf Geo\-Data\-\_\-t}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual marlin\-::\-Processor $\ast$ {\bfseries new\-Processor} ()\label{classoverlay_1_1FPCCDOverlayBX_ad3dab0ed06fa35e7381cd701c5b304db}

\item 
virtual const std\-::string \& {\bfseries name} () const \label{classoverlay_1_1FPCCDOverlayBX_aa1f4c40288a4605ffe085377e197117e}

\item 
virtual void {\bfseries modify\-Event} (L\-C\-Event $\ast$evt)\label{classoverlay_1_1FPCCDOverlayBX_ad55fae4f4d0c2828f756390ddfe6f38b}

\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} (L\-C\-Run\-Header $\ast$run)\label{classoverlay_1_1FPCCDOverlayBX_a381b16823e272e7dd653a12f96cb2457}

\begin{DoxyCompactList}\small\item\em Called for every run. \end{DoxyCompactList}\item 
virtual void {\bfseries check} (L\-C\-Event $\ast$evt)\label{classoverlay_1_1FPCCDOverlayBX_ac49f8b25ab60805a967ec69a3d6554c5}

\item 
virtual void {\bf end} ()\label{classoverlay_1_1FPCCDOverlayBX_ad8adb06753dfb7a6f9f292de7f793a0c}

\begin{DoxyCompactList}\small\item\em Called after data processing for clean up. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Types}
\begin{DoxyCompactItemize}
\item 
typedef std\-::map$<$ std\-::string, \\*
std\-::string $>$ {\bfseries Str\-Map}\label{classoverlay_1_1FPCCDOverlayBX_a39fac8d1d2cea983f175a8b802a37a49}

\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
L\-C\-Event $\ast$ {\bf read\-Next\-Event} (int bx\-Num)
\begin{DoxyCompactList}\small\item\em helper function for (randomly) reading the next event \end{DoxyCompactList}\item 
void {\bf init\-\_\-geometry} ()\label{classoverlay_1_1FPCCDOverlayBX_aac3b73721bd2b9f93f2b982a1b44ffc0}

\begin{DoxyCompactList}\small\item\em helper function \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
String\-Vec {\bfseries \-\_\-input\-File\-Names}\label{classoverlay_1_1FPCCDOverlayBX_a31449270a5070676ce36dd9f05e9acdf}

\item 
String\-Vec {\bfseries \-\_\-tmp\-Input\-File\-Names}\label{classoverlay_1_1FPCCDOverlayBX_a175332b95ae5ee0672b1f4167f3212db}

\item 
int {\bfseries \-\_\-events\-Per\-B\-X}\label{classoverlay_1_1FPCCDOverlayBX_a5aa1e77884b6013f8b2fdb2c6f4ea754}

\item 
int {\bfseries \-\_\-num\-B\-X}\label{classoverlay_1_1FPCCDOverlayBX_a58a97b071c64f5d5c4ebfdcf0fd51d6d}

\item 
bool {\bfseries \-\_\-remove\-V\-T\-X}\label{classoverlay_1_1FPCCDOverlayBX_a9b7ae538acf451781545aa44b4265019}

\item 
std\-::string {\bfseries \-\_\-vxd\-Collection}\label{classoverlay_1_1FPCCDOverlayBX_aa77cc025767e10bc75e5c9c042ea3fae}

\item 
std\-::string {\bfseries \-\_\-vtx\-Pixel\-Hits\-Collection}\label{classoverlay_1_1FPCCDOverlayBX_ab6cc25a4ea75694b8066294255902c0c}

\item 
String\-Vec {\bfseries \-\_\-merge\-Collections}\label{classoverlay_1_1FPCCDOverlayBX_a9cb591909dc974675ec30364196f6f63}

\item 
int {\bfseries \-\_\-n\-Layer}\label{classoverlay_1_1FPCCDOverlayBX_a3fc1ec55d0ee8722d5bb6694a96f9982}

\item 
int {\bfseries \-\_\-max\-Ladder}\label{classoverlay_1_1FPCCDOverlayBX_a663149ec168606b7cf11ffb9c17f0291}

\item 
Str\-Map {\bfseries \-\_\-col\-Map}\label{classoverlay_1_1FPCCDOverlayBX_a4aba7601e298235c78cba07df2cb478a}

\item 
std\-::vector$<$ L\-C\-Reader $\ast$ $>$ {\bfseries \-\_\-lc\-Readers}\label{classoverlay_1_1FPCCDOverlayBX_ae3303342d58f380439539f3257f7fd9c}

\item 
int {\bfseries \-\_\-max\-B\-Xs}\label{classoverlay_1_1FPCCDOverlayBX_a2a9414b2fa6b9d10f84bdc02ff30c73b}

\item 
int {\bfseries \-\_\-n\-Run}\label{classoverlay_1_1FPCCDOverlayBX_a5ec08c29890368a5c4119dc5d77f1451}

\item 
int {\bfseries \-\_\-n\-Evt}\label{classoverlay_1_1FPCCDOverlayBX_acc91b97e88653b0884fe4e35ddb7341c}

\item 
std\-::vector$<$ {\bf Geo\-Data\-\_\-t} $>$ {\bfseries \-\_\-geodata}\label{classoverlay_1_1FPCCDOverlayBX_a49d936fa7111a819506ad8919a22f2f4}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\doxyref{F\-P\-C\-C\-D\-Overlay\-B\-X}{p.}{classoverlay_1_1FPCCDOverlayBX} processor for overlaying (pair) background from many bunch crossings. 

Only V\-T\-X\-Pixel\-Hits which is output of F\-P\-C\-C\-D\-Digitizer are overlayed for the number of bunchcrossings that will be visible for a given physics events. {\bfseries Note\-: code assumes that background files contain exactly one bunch crossing -\/ this is necesassary as guineapig files are ordered.}

\begin{DoxyAuthor}{Author}
D. Kamai Tohoku univ. (based on \doxyref{Overlay\-B\-X}{p.}{classoverlay_1_1OverlayBX} processor by F. Geade)
\end{DoxyAuthor}

\begin{DoxyParams}{Parameters}
{\em Background\-File\-Names} & (String\-Vec) The names (with absolute or relative pathes) of the files from which the background should be read. Events are read in order from the last of strings. The Duplication will not be occured.\\
\hline
{\em Number\-Of\-Bunch\-Crossing} & (int) The number of bunch crossings will be merged.\\
\hline
{\em Merge\-Collections} & (String\-Vec) Pairs of collection names from detectors that will have one bunch crossing of beam background overlayd. The input collection (given first) will be merged into the output collection. If the output collectiondoes not exist, it will be created.\\
\hline
{\em Max\-Number\-Of\-Events\-Per\-File} & (int) Maximum number of background events to be read from one file. Default\-: -\/1, i.\-e. read one file per B\-X. This option is essentially for testing. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\index{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X@{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X}!init@{init}}
\index{init@{init}!overlay::FPCCDOverlayBX@{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X}}
\subsubsection[{init}]{\setlength{\rightskip}{0pt plus 5cm}void overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X\-::init (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classoverlay_1_1FPCCDOverlayBX_a4c443d6999eda606c73829f6792edb73}


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

Use to initialize the processor, e.\-g. book histograms. \index{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X@{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X}!read\-Next\-Event@{read\-Next\-Event}}
\index{read\-Next\-Event@{read\-Next\-Event}!overlay::FPCCDOverlayBX@{overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X}}
\subsubsection[{read\-Next\-Event}]{\setlength{\rightskip}{0pt plus 5cm}L\-C\-Event $\ast$ overlay\-::\-F\-P\-C\-C\-D\-Overlay\-B\-X\-::read\-Next\-Event (
\begin{DoxyParamCaption}
\item[{int}]{bx\-Num}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [protected]}}\label{classoverlay_1_1FPCCDOverlayBX_a671e45ec06324a2621f125ddb22316c2}


helper function for (randomly) reading the next event 

helper function for reading the next event of B\-X bx\-Num 

The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
F\-P\-C\-C\-D\-Overlay\-B\-X.\-h\item 
F\-P\-C\-C\-D\-Overlay\-B\-X.\-cc\end{DoxyCompactItemize}
