/[PAMELA software]/PamCut/doc/Doxygen/html/classFluxHistoAction.html
ViewVC logotype

Contents of /PamCut/doc/Doxygen/html/classFluxHistoAction.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1.1.1 - (show annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:08 2009 UTC (15 years, 10 months ago) by pam-fi
Branch: DEV
CVS Tags: v0r00
Changes since 1.1: +0 -0 lines
File MIME type: text/html
Error occurred while calculating annotation data. 
First import
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&nbsp;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&nbsp;List</span></a></li>
19 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20 <li><a href="functions.html"><span>Class&nbsp;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 &lt;<a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>&gt;</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">&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>
45
46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#2f215089b4dc3b414b29a88e32df820d"></a><br></td></tr>
47 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#2a38b72b56859e2f6eef38d800ca5c10">~FluxHistoAction</a> ()</td></tr>
48
49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#2a38b72b56859e2f6eef38d800ca5c10"></a><br></td></tr>
50 <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>
51
52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fills histogram with the selected event. <a href="#363f9657ac69e1051449ec1907c04809"></a><br></td></tr>
53 <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>
54
55 <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>
56 <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
57 <tr><td class="memItemLeft" nowrap align="right" valign="top">TString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#aa222dff82e9c14a330f95a9fc51d142">_outFileBase</a></td></tr>
58
59 <tr><td class="memItemLeft" nowrap align="right" valign="top">vector&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#c739385ec91f9a66caa36af6da127aa1">_bins</a></td></tr>
60
61 <tr><td class="memItemLeft" nowrap align="right" valign="top">TH1I&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#ece98abe4d37ec7b9e872143203bc613">_rootHisto</a></td></tr>
62
63 <tr><td class="memItemLeft" nowrap align="right" valign="top">vector&lt; uint64_t &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFluxHistoAction.html#39cb52b179b2d169f39d692ca3f077ce">_textHisto</a></td></tr>
64
65 </table>
66 <hr><a name="_details"></a><h2>Detailed Description</h2>
67 An action that fills a flux histogram.
68 <p>
69 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.
70 <p>Definition at line <a class="el" href="FluxHistoAction_8h_source.html#l00024">24</a> of file <a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>.</p>
71 <hr><h2>Constructor &amp; Destructor Documentation</h2>
72 <a class="anchor" name="2f215089b4dc3b414b29a88e32df820d"></a><!-- doxytag: member="FluxHistoAction::FluxHistoAction" ref="2f215089b4dc3b414b29a88e32df820d" args="(const char *actionName, TString outFileBase, TString rigBinsFile)" -->
73 <div class="memitem">
74 <div class="memproto">
75 <table class="memname">
76 <tr>
77 <td class="memname">FluxHistoAction::FluxHistoAction </td>
78 <td>(</td>
79 <td class="paramtype">const char *&nbsp;</td>
80 <td class="paramname"> <em>actionName</em>, </td>
81 </tr>
82 <tr>
83 <td class="paramkey"></td>
84 <td></td>
85 <td class="paramtype">TString&nbsp;</td>
86 <td class="paramname"> <em>outFileBase</em>, </td>
87 </tr>
88 <tr>
89 <td class="paramkey"></td>
90 <td></td>
91 <td class="paramtype">TString&nbsp;</td>
92 <td class="paramname"> <em>rigBinsFile</em></td><td>&nbsp;</td>
93 </tr>
94 <tr>
95 <td></td>
96 <td>)</td>
97 <td></td><td></td><td></td>
98 </tr>
99 </table>
100 </div>
101 <div class="memdoc">
102
103 <p>
104 Constructor.
105 <p>
106 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>
107 <dl compact><dt><b>Parameters:</b></dt><dd>
108 <table border="0" cellspacing="2" cellpadding="0">
109 <tr><td valign="top"></td><td valign="top"><em>actionName</em>&nbsp;</td><td>The action's name. </td></tr>
110 <tr><td valign="top"></td><td valign="top"><em>outFileBase</em>&nbsp;</td><td>The output file base name. </td></tr>
111 <tr><td valign="top"></td><td valign="top"><em>rigBinsFile</em>&nbsp;</td><td>The file containing the rigidity bins </td></tr>
112 </table>
113 </dl>
114
115 <p>Definition at line <a class="el" href="FluxHistoAction_8cpp_source.html#l00012">12</a> of file <a class="el" href="FluxHistoAction_8cpp_source.html">FluxHistoAction.cpp</a>.</p>
116
117 <p>References <a class="el" href="FluxHistoAction_8h_source.html#l00062">_bins</a>, <a class="el" href="FluxHistoAction_8h_source.html#l00063">_rootHisto</a>, and <a class="el" href="FluxHistoAction_8h_source.html#l00064">_textHisto</a>.</p>
118
119 </div>
120 </div><p>
121 <a class="anchor" name="2a38b72b56859e2f6eef38d800ca5c10"></a><!-- doxytag: member="FluxHistoAction::~FluxHistoAction" ref="2a38b72b56859e2f6eef38d800ca5c10" args="()" -->
122 <div class="memitem">
123 <div class="memproto">
124 <table class="memname">
125 <tr>
126 <td class="memname">FluxHistoAction::~FluxHistoAction </td>
127 <td>(</td>
128 <td class="paramname"> </td>
129 <td>&nbsp;)&nbsp;</td>
130 <td><code> [inline]</code></td>
131 </tr>
132 </table>
133 </div>
134 <div class="memdoc">
135
136 <p>
137 Destructor.
138 <p>
139
140 <p>Definition at line <a class="el" href="FluxHistoAction_8h_source.html#l00043">43</a> of file <a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>.</p>
141
142 </div>
143 </div><p>
144 <hr><h2>Member Function Documentation</h2>
145 <a class="anchor" name="4565d0ea3ca0f895af489455dfd5ff04"></a><!-- doxytag: member="FluxHistoAction::Finalize" ref="4565d0ea3ca0f895af489455dfd5ff04" args="()" -->
146 <div class="memitem">
147 <div class="memproto">
148 <table class="memname">
149 <tr>
150 <td class="memname">void FluxHistoAction::Finalize </td>
151 <td>(</td>
152 <td class="paramname"> </td>
153 <td>&nbsp;)&nbsp;</td>
154 <td><code> [virtual]</code></td>
155 </tr>
156 </table>
157 </div>
158 <div class="memdoc">
159
160 <p>
161 Writes the histogram to the output files (ASCII and ROOT).
162 <p>
163 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).
164 <p>Implements <a class="el" href="classCollectionAction.html#c32b42fc08bc1be7b003579b633de041">CollectionAction</a>.</p>
165
166 <p>Definition at line <a class="el" href="FluxHistoAction_8cpp_source.html#l00079">79</a> of file <a class="el" href="FluxHistoAction_8cpp_source.html">FluxHistoAction.cpp</a>.</p>
167
168 <p>References <a class="el" href="FluxHistoAction_8h_source.html#l00062">_bins</a>, <a class="el" href="FluxHistoAction_8h_source.html#l00061">_outFileBase</a>, <a class="el" href="FluxHistoAction_8h_source.html#l00063">_rootHisto</a>, <a class="el" href="FluxHistoAction_8h_source.html#l00064">_textHisto</a>, and <a class="el" href="CollectionAction_8h_source.html#l00089">CollectionAction::GetName()</a>.</p>
169
170 </div>
171 </div><p>
172 <a class="anchor" name="363f9657ac69e1051449ec1907c04809"></a><!-- doxytag: member="FluxHistoAction::OnGood" ref="363f9657ac69e1051449ec1907c04809" args="(PamLevel2 *event)" -->
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
176 <tr>
177 <td class="memname">void FluxHistoAction::OnGood </td>
178 <td>(</td>
179 <td class="paramtype">PamLevel2 *&nbsp;</td>
180 <td class="paramname"> <em>event</em> </td>
181 <td>&nbsp;)&nbsp;</td>
182 <td><code> [virtual]</code></td>
183 </tr>
184 </table>
185 </div>
186 <div class="memdoc">
187
188 <p>
189 Fills histogram with the selected event.
190 <p>
191 <dl compact><dt><b>Parameters:</b></dt><dd>
192 <table border="0" cellspacing="2" cellpadding="0">
193 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The selected event. </td></tr>
194 </table>
195 </dl>
196
197 <p>Implements <a class="el" href="classCollectionAction.html#801dd664020b71e8a3232e5a584d96a0">CollectionAction</a>.</p>
198
199 <p>Definition at line <a class="el" href="FluxHistoAction_8cpp_source.html#l00050">50</a> of file <a class="el" href="FluxHistoAction_8cpp_source.html">FluxHistoAction.cpp</a>.</p>
200
201 <p>References <a class="el" href="FluxHistoAction_8h_source.html#l00062">_bins</a>, <a class="el" href="FluxHistoAction_8h_source.html#l00063">_rootHisto</a>, and <a class="el" href="FluxHistoAction_8h_source.html#l00064">_textHisto</a>.</p>
202
203 </div>
204 </div><p>
205 <hr><h2>Member Data Documentation</h2>
206 <a class="anchor" name="c739385ec91f9a66caa36af6da127aa1"></a><!-- doxytag: member="FluxHistoAction::_bins" ref="c739385ec91f9a66caa36af6da127aa1" args="" -->
207 <div class="memitem">
208 <div class="memproto">
209 <table class="memname">
210 <tr>
211 <td class="memname">vector&lt;float&gt; <a class="el" href="classFluxHistoAction.html#c739385ec91f9a66caa36af6da127aa1">FluxHistoAction::_bins</a><code> [private]</code> </td>
212 </tr>
213 </table>
214 </div>
215 <div class="memdoc">
216
217 <p>
218
219 <p>Definition at line <a class="el" href="FluxHistoAction_8h_source.html#l00062">62</a> of file <a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>.</p>
220
221 <p>Referenced by <a class="el" href="FluxHistoAction_8cpp_source.html#l00079">Finalize()</a>, <a class="el" href="FluxHistoAction_8cpp_source.html#l00012">FluxHistoAction()</a>, and <a class="el" href="FluxHistoAction_8cpp_source.html#l00050">OnGood()</a>.</p>
222
223 </div>
224 </div><p>
225 <a class="anchor" name="aa222dff82e9c14a330f95a9fc51d142"></a><!-- doxytag: member="FluxHistoAction::_outFileBase" ref="aa222dff82e9c14a330f95a9fc51d142" args="" -->
226 <div class="memitem">
227 <div class="memproto">
228 <table class="memname">
229 <tr>
230 <td class="memname">TString <a class="el" href="classFluxHistoAction.html#aa222dff82e9c14a330f95a9fc51d142">FluxHistoAction::_outFileBase</a><code> [private]</code> </td>
231 </tr>
232 </table>
233 </div>
234 <div class="memdoc">
235
236 <p>
237
238 <p>Definition at line <a class="el" href="FluxHistoAction_8h_source.html#l00061">61</a> of file <a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>.</p>
239
240 <p>Referenced by <a class="el" href="FluxHistoAction_8cpp_source.html#l00079">Finalize()</a>.</p>
241
242 </div>
243 </div><p>
244 <a class="anchor" name="ece98abe4d37ec7b9e872143203bc613"></a><!-- doxytag: member="FluxHistoAction::_rootHisto" ref="ece98abe4d37ec7b9e872143203bc613" args="" -->
245 <div class="memitem">
246 <div class="memproto">
247 <table class="memname">
248 <tr>
249 <td class="memname">TH1I <a class="el" href="classFluxHistoAction.html#ece98abe4d37ec7b9e872143203bc613">FluxHistoAction::_rootHisto</a><code> [private]</code> </td>
250 </tr>
251 </table>
252 </div>
253 <div class="memdoc">
254
255 <p>
256
257 <p>Definition at line <a class="el" href="FluxHistoAction_8h_source.html#l00063">63</a> of file <a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>.</p>
258
259 <p>Referenced by <a class="el" href="FluxHistoAction_8cpp_source.html#l00079">Finalize()</a>, <a class="el" href="FluxHistoAction_8cpp_source.html#l00012">FluxHistoAction()</a>, and <a class="el" href="FluxHistoAction_8cpp_source.html#l00050">OnGood()</a>.</p>
260
261 </div>
262 </div><p>
263 <a class="anchor" name="39cb52b179b2d169f39d692ca3f077ce"></a><!-- doxytag: member="FluxHistoAction::_textHisto" ref="39cb52b179b2d169f39d692ca3f077ce" args="" -->
264 <div class="memitem">
265 <div class="memproto">
266 <table class="memname">
267 <tr>
268 <td class="memname">vector&lt;uint64_t&gt; <a class="el" href="classFluxHistoAction.html#39cb52b179b2d169f39d692ca3f077ce">FluxHistoAction::_textHisto</a><code> [private]</code> </td>
269 </tr>
270 </table>
271 </div>
272 <div class="memdoc">
273
274 <p>
275
276 <p>Definition at line <a class="el" href="FluxHistoAction_8h_source.html#l00064">64</a> of file <a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a>.</p>
277
278 <p>Referenced by <a class="el" href="FluxHistoAction_8cpp_source.html#l00079">Finalize()</a>, <a class="el" href="FluxHistoAction_8cpp_source.html#l00012">FluxHistoAction()</a>, and <a class="el" href="FluxHistoAction_8cpp_source.html#l00050">OnGood()</a>.</p>
279
280 </div>
281 </div><p>
282 <hr>The documentation for this class was generated from the following files:<ul>
283 <li>CollectionActions/FluxHistoAction/<a class="el" href="FluxHistoAction_8h_source.html">FluxHistoAction.h</a><li>CollectionActions/FluxHistoAction/<a class="el" href="FluxHistoAction_8cpp_source.html">FluxHistoAction.cpp</a></ul>
284 </div>
285 <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:38 2009 for PamCut by&nbsp;
286 <a href="http://www.doxygen.org/index.html">
287 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
288 </body>
289 </html>
  ViewVC Help
Powered by ViewVC 1.1.23