\section{marlintpc\-:\-:Pedestal\-Subtractor\-Processor Class Reference}
\label{classmarlintpc_1_1PedestalSubtractorProcessor}\index{marlintpc\-::\-Pedestal\-Subtractor\-Processor@{marlintpc\-::\-Pedestal\-Subtractor\-Processor}}


Pedestal subtracting processor of the Marlin\-T\-P\-C package.  




{\ttfamily \#include $<$Pedestal\-Subtractor\-Processor.\-h$>$}

Inheritance diagram for marlintpc\-:\-:Pedestal\-Subtractor\-Processor\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classmarlintpc_1_1PedestalSubtractorProcessor}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual Processor $\ast$ {\bfseries new\-Processor} ()\label{classmarlintpc_1_1PedestalSubtractorProcessor_ad7cedc49903ca2ede5bb3206d335057c}

\item 
virtual void {\bfseries init} ()\label{classmarlintpc_1_1PedestalSubtractorProcessor_a785f6712087455d10c86496193aae136}

\item 
virtual void {\bfseries process\-Run\-Header} (lcio\-::\-L\-C\-Run\-Header $\ast$run)\label{classmarlintpc_1_1PedestalSubtractorProcessor_ad20f9b721307567d94f588763384f6e4}

\item 
virtual void {\bfseries process\-Event} (lcio\-::\-L\-C\-Event $\ast$evt)\label{classmarlintpc_1_1PedestalSubtractorProcessor_ac2b2bb0605d0941bec6d23eb6a7ba1f2}

\item 
virtual void {\bfseries check} (lcio\-::\-L\-C\-Event $\ast$evt)\label{classmarlintpc_1_1PedestalSubtractorProcessor_a7aeecb77e821d8918f688a157140402f}

\item 
virtual void {\bfseries end} ()\label{classmarlintpc_1_1PedestalSubtractorProcessor_a63937b2a78bfddee1757eeedc19e9f3d}

\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
std\-::string {\bf \-\_\-input\-Col\-Name}\label{classmarlintpc_1_1PedestalSubtractorProcessor_a3fa120aa4f51b7e66987fe6423bf5b5d}

\begin{DoxyCompactList}\small\item\em the name of the input collection \end{DoxyCompactList}\item 
std\-::string {\bf \-\_\-output\-Col\-Name}\label{classmarlintpc_1_1PedestalSubtractorProcessor_abfbdfbe2e589c701ac0175581e535870}

\begin{DoxyCompactList}\small\item\em the name of the output collection \end{DoxyCompactList}\item 
std\-::string {\bf \-\_\-pedestal\-Col\-Name}\label{classmarlintpc_1_1PedestalSubtractorProcessor_abe2c665db50bf9c4d3d0193c1486bb27}

\begin{DoxyCompactList}\small\item\em the name of the pedestal collection \end{DoxyCompactList}\item 
std\-::string {\bf \-\_\-electr\-Para\-Obj\-Name}\label{classmarlintpc_1_1PedestalSubtractorProcessor_a9969570b77758cfc120d15a24a9f7728}

\begin{DoxyCompactList}\small\item\em the name of the collection with the read out electronics parameters \end{DoxyCompactList}\item 
std\-::string {\bf \-\_\-electr\-Para\-Col\-Name}\label{classmarlintpc_1_1PedestalSubtractorProcessor_ac5d3086b50afa5185c4526d3603b8de0}

\begin{DoxyCompactList}\small\item\em the name of the collection with the read out electronics parameters \end{DoxyCompactList}\item 
bool {\bf \-\_\-output\-Is\-Persistent}\label{classmarlintpc_1_1PedestalSubtractorProcessor_aec508bc35d0987930be768b7a1a44c8f}

\begin{DoxyCompactList}\small\item\em set the persistency flag of the output collection \end{DoxyCompactList}\item 
int {\bf \-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override}
\begin{DoxyCompactList}\small\item\em The maximum adc value, needed to determine if a pulse is maxed out. \end{DoxyCompactList}\item 
float {\bf \-\_\-pedestal\-\_\-value\-\_\-override}
\begin{DoxyCompactList}\small\item\em The pedestal value to be used for every hardware channel in every readout group. \end{DoxyCompactList}\item 
int {\bf \-\_\-missing\-Conditions\-Data\-Override\-Timespan}\label{classmarlintpc_1_1PedestalSubtractorProcessor_a0ff4232f96533f399048e1e49fd0e6ca}

\begin{DoxyCompactList}\small\item\em The timepan in seconds for which the last valid collection will be used if no conditions data are available via L\-C\-C\-D. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Pedestal subtracting processor of the Marlin\-T\-P\-C package. 

This processor subtracts pedestals provided via L\-C\-C\-D (simple file, database file or database).

\subparagraph*{Input -\/ Prerequisites}

Collection of Tracker\-Data

\subparagraph*{Output}

Collection of Tracker\-Data.


\begin{DoxyParams}{Parameters}
{\em Input\-Collection\-Name} & Name of input data collection \\
\hline
{\em Output\-Collection\-Name} & Name of output data collection \\
\hline
{\em Write\-Output\-To\-Storage\-:bool} & output collection will be written if set to true (which is the default) \\
\hline
{\em Pedestal\-Collection\-Name} & Name of the collection containing the pedestals \\
\hline
{\em Maximum\-A\-D\-C\-Value\-Override} & Maximum A\-D\-C Value of the read-\/out electronic to detect overflow samples, if this parameter is set it overides condition information and no condition listener is used (optional parameter, if not set conditions data is used) \\
\hline
{\em Pedestal\-Value\-Override} & Pedestal of the read-\/out electronic to detect overflow samples, if this parameter is set it overides condition information and no condition listener is used (optional parameter, if not set, conditions data is used) \\
\hline
{\em Missing\-Conditions\-Data\-Override\-Timespan} & Sets the time in seconds that missing conditions data will be ignored by using the last valid conditions data collection (optional parameter, if not set, processing stops if no conditions data available for event time) \\
\hline
{\em Electronics\-Parameters\-Object\-Name} & Name of the conditions object in which the parameters of the read out electronics is stored. For example \char`\"{}\-Generic\-A\-D\-C\-Electronics\-Parameters\char`\"{}. \\
\hline
{\em Electronics\-Parameters\-Collection\-Name} & Name of the conditions collection in which the parameters of the read out electronics is stored\\
\hline
\end{DoxyParams}
\begin{DoxyAuthor}{Author}
M. E. Janssen, D\-E\-S\-Y; R. Diener, D\-E\-S\-Y 
\end{DoxyAuthor}


\subsection{Member Data Documentation}
\index{marlintpc\-::\-Pedestal\-Subtractor\-Processor@{marlintpc\-::\-Pedestal\-Subtractor\-Processor}!\-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override@{\-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override}}
\index{\-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override@{\-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override}!marlintpc::PedestalSubtractorProcessor@{marlintpc\-::\-Pedestal\-Subtractor\-Processor}}
\subsubsection[{\-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override}]{\setlength{\rightskip}{0pt plus 5cm}int marlintpc\-::\-Pedestal\-Subtractor\-Processor\-::\-\_\-maximum\-\_\-\-A\-D\-C\-\_\-value\-\_\-override\hspace{0.3cm}{\ttfamily [protected]}}\label{classmarlintpc_1_1PedestalSubtractorProcessor_aae17636f25c9e752d3f378c69a79e305}


The maximum adc value, needed to determine if a pulse is maxed out. 

This overrides any information provided by L\-C\-C\-D \index{marlintpc\-::\-Pedestal\-Subtractor\-Processor@{marlintpc\-::\-Pedestal\-Subtractor\-Processor}!\-\_\-pedestal\-\_\-value\-\_\-override@{\-\_\-pedestal\-\_\-value\-\_\-override}}
\index{\-\_\-pedestal\-\_\-value\-\_\-override@{\-\_\-pedestal\-\_\-value\-\_\-override}!marlintpc::PedestalSubtractorProcessor@{marlintpc\-::\-Pedestal\-Subtractor\-Processor}}
\subsubsection[{\-\_\-pedestal\-\_\-value\-\_\-override}]{\setlength{\rightskip}{0pt plus 5cm}float marlintpc\-::\-Pedestal\-Subtractor\-Processor\-::\-\_\-pedestal\-\_\-value\-\_\-override\hspace{0.3cm}{\ttfamily [protected]}}\label{classmarlintpc_1_1PedestalSubtractorProcessor_a2869c2397334da956640b4a1f7b0027c}


The pedestal value to be used for every hardware channel in every readout group. 

This overrides any information provided by L\-C\-C\-D 

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