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

Diff of /PamCut/doc/Doxygen/html/classCaloTrackChi2Cut.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by pam-fi, Wed May 27 13:30:07 2009 UTC revision 1.2 by pam-fi, Fri Jun 5 13:15:58 2009 UTC
# Line 41  Inheritance diagram for CaloTrackChi2Cut Line 41  Inheritance diagram for CaloTrackChi2Cut
41  <a href="classCaloTrackChi2Cut-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">  <a href="classCaloTrackChi2Cut-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
42  <tr><td></td></tr>  <tr><td></td></tr>
43  <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>  <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="classCaloTrackChi2Cut.html#1712b4e3701101c9937236e7499d384f">CaloTrackChi2Cut</a> (const char *cutName, <a class="el" href="classCaloAxis.html">CaloAxis</a> *xCaloAxis, <a class="el" href="classCaloAxis.html">CaloAxis</a> *yCaloAxis, float maxChi2=0.03, float minChi2=0.005)</td></tr>  <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#1712b4e3701101c9937236e7499d384f">CaloTrackChi2Cut</a> (const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, float maxChi2=0.03, float minChi2=0.005)</td></tr>
45    
46  <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#1712b4e3701101c9937236e7499d384f"></a><br></td></tr>  <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#1712b4e3701101c9937236e7499d384f"></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="classCaloTrackChi2Cut.html#ffe40e5c6ec00d23fedd58a04470e5bc">~CaloTrackChi2Cut</a> ()</td></tr>  <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffe40e5c6ec00d23fedd58a04470e5bc"></a><!-- doxytag: member="CaloTrackChi2Cut::~CaloTrackChi2Cut" ref="ffe40e5c6ec00d23fedd58a04470e5bc" args="()" -->
48    &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#ffe40e5c6ec00d23fedd58a04470e5bc">~CaloTrackChi2Cut</a> ()</td></tr>
49    
50  <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#ffe40e5c6ec00d23fedd58a04470e5bc"></a><br></td></tr>  <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51  <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#63fe6418b40b1908a4a9df6ee2920909">Check</a> (PamLevel2 *event)</td></tr>  <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#63fe6418b40b1908a4a9df6ee2920909">Check</a> (PamLevel2 *event)</td></tr>
52    
53  <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The calorimeter chi2 quality check.  <a href="#63fe6418b40b1908a4a9df6ee2920909"></a><br></td></tr>  <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The calorimeter chi2 quality check.  <a href="#63fe6418b40b1908a4a9df6ee2920909"></a><br></td></tr>
 <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>  
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#3eae059e91c7b0a5933236ab4dbcc28d">_xCaloAxis</a></td></tr>  
   
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#2ea0c86a73873dc5ffec16299a31f9bd">_yCaloAxis</a></td></tr>  
   
 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#665b250f9e2d8b8568a7c639ec08d20b">_maxChi2</a></td></tr>  
   
 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloTrackChi2Cut.html#19e6c7d61a98be79c6e4328ef1a36447">_minChi2</a></td></tr>  
   
54  </table>  </table>
55  <hr><a name="_details"></a><h2>Detailed Description</h2>  <hr><a name="_details"></a><h2>Detailed Description</h2>
56  The calorimeter track chi2 quality cut.  The calorimeter track chi2 quality cut.
57  <p>  <p>
58  This cut performs a check on chi2 of the calorimeter track. The current implementation uses the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects; to save computing time, the class assumes that the track is externally computed for each event and stored in <a class="el" href="classCaloAxis.html">CaloAxis</a> objects; pointers to these objects are passed as arguments to the constructor. The Check method will then ignore the PamLevel2 *event and assume that the current content of the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects are relative to the current event. It is an user's task to ensure that these assumptions are fulfilled every time Check or ApplyCut are called.<p>  This cut performs a check on chi2 of the calorimeter track. The current implementation uses the CaloAxis objects; to save computing time, the class assumes that the track is externally computed for each event and stored in CaloAxis objects; pointers to these objects are passed as arguments to the constructor. The Check method will then ignore the PamLevel2 *event and assume that the current content of the CaloAxis objects are relative to the current event. It is an user's task to ensure that these assumptions are fulfilled every time Check or ApplyCut are called.<p>
59  CUT DEPENDENCIES: <a class="el" href="classCaloTrackCut.html" title="The calorimeter track cut. Checks for the existence of a track in the calorimeter...">CaloTrackCut</a> for the existence of the track (it can also provide the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects).  CUT DEPENDENCIES: <a class="el" href="classCaloTrackCut.html" title="The calorimeter track cut. Checks for the existence of a track in the calorimeter...">CaloTrackCut</a> for the existence of the track (it can also provide the CaloAxis objects). <hr><h2>Constructor &amp; Destructor Documentation</h2>
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00030">30</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
 <hr><h2>Constructor &amp; Destructor Documentation</h2>  
60  <a class="anchor" name="1712b4e3701101c9937236e7499d384f"></a><!-- doxytag: member="CaloTrackChi2Cut::CaloTrackChi2Cut" ref="1712b4e3701101c9937236e7499d384f" args="(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, float maxChi2=0.03, float minChi2=0.005)" -->  <a class="anchor" name="1712b4e3701101c9937236e7499d384f"></a><!-- doxytag: member="CaloTrackChi2Cut::CaloTrackChi2Cut" ref="1712b4e3701101c9937236e7499d384f" args="(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, float maxChi2=0.03, float minChi2=0.005)" -->
61  <div class="memitem">  <div class="memitem">
62  <div class="memproto">  <div class="memproto">
# Line 80  CUT DEPENDENCIES: <a class="el" href="cl Line 70  CUT DEPENDENCIES: <a class="el" href="cl
70          <tr>          <tr>
71            <td class="paramkey"></td>            <td class="paramkey"></td>
72            <td></td>            <td></td>
73            <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>            <td class="paramtype">CaloAxis *&nbsp;</td>
74            <td class="paramname"> <em>xCaloAxis</em>, </td>            <td class="paramname"> <em>xCaloAxis</em>, </td>
75          </tr>          </tr>
76          <tr>          <tr>
77            <td class="paramkey"></td>            <td class="paramkey"></td>
78            <td></td>            <td></td>
79            <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>            <td class="paramtype">CaloAxis *&nbsp;</td>
80            <td class="paramname"> <em>yCaloAxis</em>, </td>            <td class="paramname"> <em>yCaloAxis</em>, </td>
81          </tr>          </tr>
82          <tr>          <tr>
# Line 113  CUT DEPENDENCIES: <a class="el" href="cl Line 103  CUT DEPENDENCIES: <a class="el" href="cl
103  <p>  <p>
104  Constructor.  Constructor.
105  <p>  <p>
106  The <a class="el" href="classCaloAxis.html">CaloAxis</a> arguments are pointers to objects which contain the calorimeter track information for current event.<p>  The CaloAxis arguments are pointers to objects which contain the calorimeter track information for current event.<p>
107  <dl compact><dt><b>Parameters:</b></dt><dd>  <dl compact><dt><b>Parameters:</b></dt><dd>
108    <table border="0" cellspacing="2" cellpadding="0">    <table border="0" cellspacing="2" cellpadding="0">
109      <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut name. </td></tr>      <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut name. </td></tr>
110      <tr><td valign="top"></td><td valign="top"><em>xCaloAxis</em>&nbsp;</td><td>Pointer to the <a class="el" href="classCaloAxis.html">CaloAxis</a> object for X axis. </td></tr>      <tr><td valign="top"></td><td valign="top"><em>xCaloAxis</em>&nbsp;</td><td>Pointer to the CaloAxis object for X axis. </td></tr>
111      <tr><td valign="top"></td><td valign="top"><em>yCaloAxis</em>&nbsp;</td><td>Pointer to the <a class="el" href="classCaloAxis.html">CaloAxis</a> object for Y axis. </td></tr>      <tr><td valign="top"></td><td valign="top"><em>yCaloAxis</em>&nbsp;</td><td>Pointer to the CaloAxis object for Y axis. </td></tr>
112      <tr><td valign="top"></td><td valign="top"><em>maxChi2</em>&nbsp;</td><td>The maximum allowed Chi2. </td></tr>      <tr><td valign="top"></td><td valign="top"><em>maxChi2</em>&nbsp;</td><td>The maximum allowed Chi2. </td></tr>
113      <tr><td valign="top"></td><td valign="top"><em>minChi2</em>&nbsp;</td><td>The minimum allowed Chi2. </td></tr>      <tr><td valign="top"></td><td valign="top"><em>minChi2</em>&nbsp;</td><td>The minimum allowed Chi2. </td></tr>
114    </table>    </table>
115  </dl>  </dl>
116    
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00044">44</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
   
 </div>  
 </div><p>  
 <a class="anchor" name="ffe40e5c6ec00d23fedd58a04470e5bc"></a><!-- doxytag: member="CaloTrackChi2Cut::~CaloTrackChi2Cut" ref="ffe40e5c6ec00d23fedd58a04470e5bc" args="()" -->  
 <div class="memitem">  
 <div class="memproto">  
       <table class="memname">  
         <tr>  
           <td class="memname">CaloTrackChi2Cut::~CaloTrackChi2Cut           </td>  
           <td>(</td>  
           <td class="paramname">          </td>  
           <td>&nbsp;)&nbsp;</td>  
           <td><code> [inline]</code></td>  
         </tr>  
       </table>  
 </div>  
 <div class="memdoc">  
   
 <p>  
 Destructor.  
 <p>  
   
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00048">48</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
   
117  </div>  </div>
118  </div><p>  </div><p>
119  <hr><h2>Member Function Documentation</h2>  <hr><h2>Member Function Documentation</h2>
# Line 176  The calorimeter chi2 quality check. Line 141  The calorimeter chi2 quality check.
141      <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>      <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
142    </table>    </table>
143  </dl>  </dl>
144  <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="CommonDefs_8h.html#c857f4b76ae431837cbf61fd74863b6c" title="The implementations of PamCut::Check() must return this value if the event satisfy...">CUTOK</a> if Chi2 from <a class="el" href="classCaloAxis.html">CaloAxis</a> is strictly greater than minChi2 and strictly lesser than maxChi2. <p>  <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="CommonDefs_8h.html#c857f4b76ae431837cbf61fd74863b6c" title="The implementations of PamCut::Check() must return this value if the event satisfy...">CUTOK</a> if Chi2 from CaloAxis is strictly greater than minChi2 and strictly lesser than maxChi2. <p>
145  0 otherwise </dd></dl>  0 otherwise </dd></dl>
146    
147  <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>  <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
148    
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8cpp_source.html#l00012">12</a> of file <a class="el" href="CaloTrackChi2Cut_8cpp_source.html">CaloTrackChi2Cut.cpp</a>.</p>  
   
 <p>References <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00061">_maxChi2</a>, <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00061">_minChi2</a>, <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00060">_xCaloAxis</a>, <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00060">_yCaloAxis</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, and <a class="el" href="CaloAxis2_8h_source.html#l00280">CaloAxis::GetChi2()</a>.</p>  
   
 </div>  
 </div><p>  
 <hr><h2>Member Data Documentation</h2>  
 <a class="anchor" name="665b250f9e2d8b8568a7c639ec08d20b"></a><!-- doxytag: member="CaloTrackChi2Cut::_maxChi2" ref="665b250f9e2d8b8568a7c639ec08d20b" args="" -->  
 <div class="memitem">  
 <div class="memproto">  
       <table class="memname">  
         <tr>  
           <td class="memname">float <a class="el" href="classCaloTrackChi2Cut.html#665b250f9e2d8b8568a7c639ec08d20b">CaloTrackChi2Cut::_maxChi2</a><code> [private]</code>          </td>  
         </tr>  
       </table>  
 </div>  
 <div class="memdoc">  
   
 <p>  
   
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00061">61</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
   
 <p>Referenced by <a class="el" href="CaloTrackChi2Cut_8cpp_source.html#l00012">Check()</a>.</p>  
   
 </div>  
 </div><p>  
 <a class="anchor" name="19e6c7d61a98be79c6e4328ef1a36447"></a><!-- doxytag: member="CaloTrackChi2Cut::_minChi2" ref="19e6c7d61a98be79c6e4328ef1a36447" args="" -->  
 <div class="memitem">  
 <div class="memproto">  
       <table class="memname">  
         <tr>  
           <td class="memname">float <a class="el" href="classCaloTrackChi2Cut.html#19e6c7d61a98be79c6e4328ef1a36447">CaloTrackChi2Cut::_minChi2</a><code> [private]</code>          </td>  
         </tr>  
       </table>  
 </div>  
 <div class="memdoc">  
   
 <p>  
   
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00061">61</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
   
 <p>Referenced by <a class="el" href="CaloTrackChi2Cut_8cpp_source.html#l00012">Check()</a>.</p>  
   
 </div>  
 </div><p>  
 <a class="anchor" name="3eae059e91c7b0a5933236ab4dbcc28d"></a><!-- doxytag: member="CaloTrackChi2Cut::_xCaloAxis" ref="3eae059e91c7b0a5933236ab4dbcc28d" args="" -->  
 <div class="memitem">  
 <div class="memproto">  
       <table class="memname">  
         <tr>  
           <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a>* <a class="el" href="classCaloTrackChi2Cut.html#3eae059e91c7b0a5933236ab4dbcc28d">CaloTrackChi2Cut::_xCaloAxis</a><code> [private]</code>          </td>  
         </tr>  
       </table>  
 </div>  
 <div class="memdoc">  
   
 <p>  
   
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00060">60</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
   
 <p>Referenced by <a class="el" href="CaloTrackChi2Cut_8cpp_source.html#l00012">Check()</a>.</p>  
   
 </div>  
 </div><p>  
 <a class="anchor" name="2ea0c86a73873dc5ffec16299a31f9bd"></a><!-- doxytag: member="CaloTrackChi2Cut::_yCaloAxis" ref="2ea0c86a73873dc5ffec16299a31f9bd" args="" -->  
 <div class="memitem">  
 <div class="memproto">  
       <table class="memname">  
         <tr>  
           <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a> * <a class="el" href="classCaloTrackChi2Cut.html#2ea0c86a73873dc5ffec16299a31f9bd">CaloTrackChi2Cut::_yCaloAxis</a><code> [private]</code>          </td>  
         </tr>  
       </table>  
 </div>  
 <div class="memdoc">  
   
 <p>  
   
 <p>Definition at line <a class="el" href="CaloTrackChi2Cut_8h_source.html#l00060">60</a> of file <a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a>.</p>  
   
 <p>Referenced by <a class="el" href="CaloTrackChi2Cut_8cpp_source.html#l00012">Check()</a>.</p>  
   
149  </div>  </div>
150  </div><p>  </div><p>
151  <hr>The documentation for this class was generated from the following files:<ul>  <hr>The documentation for this class was generated from the following files:<ul>
152  <li>CaloCuts/CaloTrackChi2Cut/<a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a><li>CaloCuts/CaloTrackChi2Cut/<a class="el" href="CaloTrackChi2Cut_8cpp_source.html">CaloTrackChi2Cut.cpp</a></ul>  <li>CaloCuts/CaloTrackChi2Cut/<a class="el" href="CaloTrackChi2Cut_8h_source.html">CaloTrackChi2Cut.h</a><li>CaloCuts/CaloTrackChi2Cut/<a class="el" href="CaloTrackChi2Cut_8cpp.html">CaloTrackChi2Cut.cpp</a></ul>
153  </div>  </div>
154  <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:34 2009 for PamCut by&nbsp;  <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:01 2009 for PamCut by&nbsp;
155  <a href="http://www.doxygen.org/index.html">  <a href="http://www.doxygen.org/index.html">
156  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
157  </body>  </body>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.23