Doxygen/html/classFluxHistoAction.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>PamCut: FluxHistoAction Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>FluxHistoAction Class Reference</h1><!-- doxytag: class="FluxHistoAction" --><!-- doxytag: inherits="CollectionAction" -->An action that fills a flux histogram.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for FluxHistoAction:</div>
<div class="dynsection">

<p><center><img src="classFluxHistoAction.png" usemap="#FluxHistoAction_map" border="0" alt=""></center>
<map name="FluxHistoAction_map">
<area href="classCollectionAction.html" alt="CollectionAction" shape="rect" coords="0,0,104,24">
</map>
</div>

<p>
<a href="classFluxHistoAction-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#2f215089b4dc3b414b29a88e32df820d">FluxHistoAction</a> (const char *actionName, TString outFileBase, TString rigBinsFile)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#2f215089b4dc3b414b29a88e32df820d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a38b72b56859e2f6eef38d800ca5c10"></a><!-- doxytag: member="FluxHistoAction::~FluxHistoAction" ref="2a38b72b56859e2f6eef38d800ca5c10" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#2a38b72b56859e2f6eef38d800ca5c10">~FluxHistoAction</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#363f9657ac69e1051449ec1907c04809">OnGood</a> (PamLevel2 *event)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills histogram with the selected event.  <a href="#363f9657ac69e1051449ec1907c04809"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#4565d0ea3ca0f895af489455dfd5ff04">Finalize</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes the histogram to the output files (ASCII and ROOT).  <a href="#4565d0ea3ca0f895af489455dfd5ff04"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An action that fills a flux histogram. 
<p>
This action reads a rigidity binning from a file and fills a flux histogram (text and ROOT format). Currently, it fills an event-count histogram: in future implementations, it could also read live time, efficiency and geometrical factor from external files and fill a true flux histogram. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2f215089b4dc3b414b29a88e32df820d"></a><!-- doxytag: member="FluxHistoAction::FluxHistoAction" ref="2f215089b4dc3b414b29a88e32df820d" args="(const char *actionName, TString outFileBase, TString rigBinsFile)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">FluxHistoAction::FluxHistoAction           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>actionName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TString&nbsp;</td>
          <td class="paramname"> <em>outFileBase</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TString&nbsp;</td>
          <td class="paramname"> <em>rigBinsFile</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<p>
outFileBase is the base name for output file: <a class="el" href="classFluxHistoAction.html#4565d0ea3ca0f895af489455dfd5ff04" title="Writes the histogram to the output files (ASCII and ROOT).">Finalize</a> will add .txt for ASCII output and .root for ROOT output. outFileBase has to contain the path (otherwise, files will be saved in the current directory). The file containing the rigidity bins must be a text file. It must contain both the lower and upper limits of the rigidity axis, so that if it contains N values it defines a set of N-1 bins.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>actionName</em>&nbsp;</td><td>The action's name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>outFileBase</em>&nbsp;</td><td>The output file base name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>rigBinsFile</em>&nbsp;</td><td>The file containing the rigidity bins </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4565d0ea3ca0f895af489455dfd5ff04"></a><!-- doxytag: member="FluxHistoAction::Finalize" ref="4565d0ea3ca0f895af489455dfd5ff04" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FluxHistoAction::Finalize           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Writes the histogram to the output files (ASCII and ROOT). 
<p>
The output consists of a text file and of a ROOT file where the 1-dimensional rigidity histogram (TH1F) is saved. The format of the text output is: (lower bin limit) (upper bin limit) (# of events). 
<p>Reimplemented from <a class="el" href="classCollectionAction.html#3644c42bef3002c44202b6e9630bc1a4">CollectionAction</a>.</p>

</div>
</div><p>
<a class="anchor" name="363f9657ac69e1051449ec1907c04809"></a><!-- doxytag: member="FluxHistoAction::OnGood" ref="363f9657ac69e1051449ec1907c04809" args="(PamLevel2 *event)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void FluxHistoAction::OnGood           </td>
          <td>(</td>
          <td class="paramtype">PamLevel2 *&nbsp;</td>
          <td class="paramname"> <em>event</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fills histogram with the selected event. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The selected event. </td></tr>
  </table>
</dl>

<p>Reimplemented from <a class="el" href="classCollectionAction.html#077319900b1cde36b6baca9e6699ec5a">CollectionAction</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>CollectionActions/FluxHistoAction/<a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a><li>CollectionActions/FluxHistoAction/<a class="el" href="FluxHistoAction_8cpp.html">FluxHistoAction.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:02 2009 for PamCut by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2	<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3	<title>PamCut: FluxHistoAction Class Reference</title>
4	<link href="tabs.css" rel="stylesheet" type="text/css">
5	<link href="doxygen.css" rel="stylesheet" type="text/css">
6	</head><body>
7	<!-- Generated by Doxygen 1.5.9 -->
8	<div class="navigation" id="top">
9	<div class="tabs">
10	<ul>
11	<li><a href="index.html"><span>Main Page</span></a></li>
12	<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13	<li><a href="files.html"><span>Files</span></a></li>
14	</ul>
15	</div>
16	<div class="tabs">
17	<ul>
18	<li><a href="annotated.html"><span>Class List</span></a></li>
19	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
20	<li><a href="functions.html"><span>Class Members</span></a></li>
21	</ul>
22	</div>
23	</div>
24	<div class="contents">
25	<h1>FluxHistoAction Class Reference</h1><!-- doxytag: class="FluxHistoAction" --><!-- doxytag: inherits="CollectionAction" -->An action that fills a flux histogram.
26	<a href="#_details">More...</a>
27	<p>
28	<code>#include <<a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>></code>
29	<p>
30	<div class="dynheader">
31	Inheritance diagram for FluxHistoAction:</div>
32	<div class="dynsection">
33
34	<p><center><img src="classFluxHistoAction.png" usemap="#FluxHistoAction_map" border="0" alt=""></center>
35	<map name="FluxHistoAction_map">
36	<area href="classCollectionAction.html" alt="CollectionAction" shape="rect" coords="0,0,104,24">
37	</map>
38	</div>
39
40	<p>
41	<a href="classFluxHistoAction-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
42	<tr><td></td></tr>
43	<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44	<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#2f215089b4dc3b414b29a88e32df820d">FluxHistoAction</a> (const char *actionName, TString outFileBase, TString rigBinsFile)</td></tr>
45
46	<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#2f215089b4dc3b414b29a88e32df820d"></a><br></td></tr>
47	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a38b72b56859e2f6eef38d800ca5c10"></a><!-- doxytag: member="FluxHistoAction::~FluxHistoAction" ref="2a38b72b56859e2f6eef38d800ca5c10" args="()" -->
48	</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#2a38b72b56859e2f6eef38d800ca5c10">~FluxHistoAction</a> ()</td></tr>
49
50	<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr>
51	<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#363f9657ac69e1051449ec1907c04809">OnGood</a> (PamLevel2 *event)</td></tr>
52
53	<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills histogram with the selected event. <a href="#363f9657ac69e1051449ec1907c04809"></a><br></td></tr>
54	<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#4565d0ea3ca0f895af489455dfd5ff04">Finalize</a> ()</td></tr>
55
56	<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes the histogram to the output files (ASCII and ROOT). <a href="#4565d0ea3ca0f895af489455dfd5ff04"></a><br></td></tr>
57	</table>
58	<hr><a name="_details"></a><h2>Detailed Description</h2>
59	An action that fills a flux histogram.
60	<p>
61	This action reads a rigidity binning from a file and fills a flux histogram (text and ROOT format). Currently, it fills an event-count histogram: in future implementations, it could also read live time, efficiency and geometrical factor from external files and fill a true flux histogram. <hr><h2>Constructor & Destructor Documentation</h2>
62	<a class="anchor" name="2f215089b4dc3b414b29a88e32df820d"></a><!-- doxytag: member="FluxHistoAction::FluxHistoAction" ref="2f215089b4dc3b414b29a88e32df820d" args="(const char *actionName, TString outFileBase, TString rigBinsFile)" -->
63	<div class="memitem">
64	<div class="memproto">
65	<table class="memname">
66	<tr>
67	<td class="memname">FluxHistoAction::FluxHistoAction </td>
68	<td>(</td>
69	<td class="paramtype">const char * </td>
70	<td class="paramname"> <em>actionName</em>, </td>
71	</tr>
72	<tr>
73	<td class="paramkey"></td>
74	<td></td>
75	<td class="paramtype">TString </td>
76	<td class="paramname"> <em>outFileBase</em>, </td>
77	</tr>
78	<tr>
79	<td class="paramkey"></td>
80	<td></td>
81	<td class="paramtype">TString </td>
82	<td class="paramname"> <em>rigBinsFile</em></td><td> </td>
83	</tr>
84	<tr>
85	<td></td>
86	<td>)</td>
87	<td></td><td></td><td></td>
88	</tr>
89	</table>
90	</div>
91	<div class="memdoc">
92
93	<p>
94	Constructor.
95	<p>
96	outFileBase is the base name for output file: <a class="el" href="classFluxHistoAction.html#4565d0ea3ca0f895af489455dfd5ff04" title="Writes the histogram to the output files (ASCII and ROOT).">Finalize</a> will add .txt for ASCII output and .root for ROOT output. outFileBase has to contain the path (otherwise, files will be saved in the current directory). The file containing the rigidity bins must be a text file. It must contain both the lower and upper limits of the rigidity axis, so that if it contains N values it defines a set of N-1 bins.<p>
97	<dl compact><dt><b>Parameters:</b></dt><dd>
98	<table border="0" cellspacing="2" cellpadding="0">
99	<tr><td valign="top"></td><td valign="top"><em>actionName</em> </td><td>The action's name. </td></tr>
100	<tr><td valign="top"></td><td valign="top"><em>outFileBase</em> </td><td>The output file base name. </td></tr>
101	<tr><td valign="top"></td><td valign="top"><em>rigBinsFile</em> </td><td>The file containing the rigidity bins </td></tr>
102	</table>
103	</dl>
104
105	</div>
106	</div><p>
107	<hr><h2>Member Function Documentation</h2>
108	<a class="anchor" name="4565d0ea3ca0f895af489455dfd5ff04"></a><!-- doxytag: member="FluxHistoAction::Finalize" ref="4565d0ea3ca0f895af489455dfd5ff04" args="()" -->
109	<div class="memitem">
110	<div class="memproto">
111	<table class="memname">
112	<tr>
113	<td class="memname">void FluxHistoAction::Finalize </td>
114	<td>(</td>
115	<td class="paramname"> </td>
116	<td> ) </td>
117	<td><code> [virtual]</code></td>
118	</tr>
119	</table>
120	</div>
121	<div class="memdoc">
122
123	<p>
124	Writes the histogram to the output files (ASCII and ROOT).
125	<p>
126	The output consists of a text file and of a ROOT file where the 1-dimensional rigidity histogram (TH1F) is saved. The format of the text output is: (lower bin limit) (upper bin limit) (# of events).
127	<p>Reimplemented from <a class="el" href="classCollectionAction.html#3644c42bef3002c44202b6e9630bc1a4">CollectionAction</a>.</p>
128
129	</div>
130	</div><p>
131	<a class="anchor" name="363f9657ac69e1051449ec1907c04809"></a><!-- doxytag: member="FluxHistoAction::OnGood" ref="363f9657ac69e1051449ec1907c04809" args="(PamLevel2 *event)" -->
132	<div class="memitem">
133	<div class="memproto">
134	<table class="memname">
135	<tr>
136	<td class="memname">void FluxHistoAction::OnGood </td>
137	<td>(</td>
138	<td class="paramtype">PamLevel2 * </td>
139	<td class="paramname"> <em>event</em> </td>
140	<td> ) </td>
141	<td><code> [virtual]</code></td>
142	</tr>
143	</table>
144	</div>
145	<div class="memdoc">
146
147	<p>
148	Fills histogram with the selected event.
149	<p>
150	<dl compact><dt><b>Parameters:</b></dt><dd>
151	<table border="0" cellspacing="2" cellpadding="0">
152	<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The selected event. </td></tr>
153	</table>
154	</dl>
155
156	<p>Reimplemented from <a class="el" href="classCollectionAction.html#077319900b1cde36b6baca9e6699ec5a">CollectionAction</a>.</p>
157
158	</div>
159	</div><p>
160	<hr>The documentation for this class was generated from the following files:<ul>
161	<li>CollectionActions/FluxHistoAction/<a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a><li>CollectionActions/FluxHistoAction/<a class="el" href="FluxHistoAction_8cpp.html">FluxHistoAction.cpp</a></ul>
162	</div>
163	<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:02 2009 for PamCut by
164	<a href="http://www.doxygen.org/index.html">
165	<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
166	</body>
167	</html>