Doxygen/html/classTrkRigGeoCut.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: TrkRigGeoCut 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>TrkRigGeoCut Class Reference</h1><!-- doxytag: class="TrkRigGeoCut" --><!-- doxytag: inherits="PamCut" -->The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for TrkRigGeoCut:</div>
<div class="dynsection">

<p><center><img src="classTrkRigGeoCut.png" usemap="#TrkRigGeoCut_map" border="0" alt=""></center>
<map name="TrkRigGeoCut_map">
<area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,90,24">
</map>
</div>

<p>
<a href="classTrkRigGeoCut-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="classTrkRigGeoCut.html#00e54e0aade802c1c44fcfde47e905d6">TrkRigGeoCut</a> (const char *cutName, float thresholdCoeff)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#00e54e0aade802c1c44fcfde47e905d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="074e6ecf968a39447bc868a79da213c7"></a><!-- doxytag: member="TrkRigGeoCut::~TrkRigGeoCut" ref="074e6ecf968a39447bc868a79da213c7" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#074e6ecf968a39447bc868a79da213c7">~TrkRigGeoCut</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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#d334792be6ca66d01d75bb2f86a57382">Check</a> (PamLevel2 *event)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The rigidity check.  <a href="#d334792be6ca66d01d75bb2f86a57382"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b3e2d3037d140ae852bd02975842eb4"></a><!-- doxytag: member="TrkRigGeoCut::GetThresholdCoeff" ref="5b3e2d3037d140ae852bd02975842eb4" args="()" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#5b3e2d3037d140ae852bd02975842eb4">GetThresholdCoeff</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the threshold coefficient. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient. 
<p>
CUT DEPENDENCIES: TrkPhSin (since <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> assumes the existence of a single physical track) <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="00e54e0aade802c1c44fcfde47e905d6"></a><!-- doxytag: member="TrkRigGeoCut::TrkRigGeoCut" ref="00e54e0aade802c1c44fcfde47e905d6" args="(const char *cutName, float thresholdCoeff)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TrkRigGeoCut::TrkRigGeoCut           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>cutName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>thresholdCoeff</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<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>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em>&nbsp;</td><td>The threshold rigidity coefficient. </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d334792be6ca66d01d75bb2f86a57382"></a><!-- doxytag: member="TrkRigGeoCut::Check" ref="d334792be6ca66d01d75bb2f86a57382" args="(PamLevel2 *event)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int TrkRigGeoCut::Check           </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>
The rigidity check. 
<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 event to analyze. </td></tr>
  </table>
</dl>
<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 the rigidity modulus is greater than the geomagnetic cutoff rigidity times the threshold coefficient. <p>
0 otherwise. </dd></dl>

<p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>TrkCuts/TrkRigGeoCut/<a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a><li>TrkCuts/TrkRigGeoCut/<a class="el" href="TrkRigGeoCut_8cpp.html">TrkRigGeoCut.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:09 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: TrkRigGeoCut 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>TrkRigGeoCut Class Reference</h1><!-- doxytag: class="TrkRigGeoCut" --><!-- doxytag: inherits="PamCut" -->The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient.
26	<a href="#_details">More...</a>
27	<p>
28	<code>#include <<a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>></code>
29	<p>
30	<div class="dynheader">
31	Inheritance diagram for TrkRigGeoCut:</div>
32	<div class="dynsection">
33
34	<p><center><img src="classTrkRigGeoCut.png" usemap="#TrkRigGeoCut_map" border="0" alt=""></center>
35	<map name="TrkRigGeoCut_map">
36	<area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,90,24">
37	</map>
38	</div>
39
40	<p>
41	<a href="classTrkRigGeoCut-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="classTrkRigGeoCut.html#00e54e0aade802c1c44fcfde47e905d6">TrkRigGeoCut</a> (const char *cutName, float thresholdCoeff)</td></tr>
45
46	<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#00e54e0aade802c1c44fcfde47e905d6"></a><br></td></tr>
47	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="074e6ecf968a39447bc868a79da213c7"></a><!-- doxytag: member="TrkRigGeoCut::~TrkRigGeoCut" ref="074e6ecf968a39447bc868a79da213c7" args="()" -->
48	</td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#074e6ecf968a39447bc868a79da213c7">~TrkRigGeoCut</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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#d334792be6ca66d01d75bb2f86a57382">Check</a> (PamLevel2 *event)</td></tr>
52
53	<tr><td class="mdescLeft"> </td><td class="mdescRight">The rigidity check. <a href="#d334792be6ca66d01d75bb2f86a57382"></a><br></td></tr>
54	<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b3e2d3037d140ae852bd02975842eb4"></a><!-- doxytag: member="TrkRigGeoCut::GetThresholdCoeff" ref="5b3e2d3037d140ae852bd02975842eb4" args="()" -->
55	float </td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#5b3e2d3037d140ae852bd02975842eb4">GetThresholdCoeff</a> ()</td></tr>
56
57	<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the threshold coefficient. <br></td></tr>
58	</table>
59	<hr><a name="_details"></a><h2>Detailed Description</h2>
60	The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient.
61	<p>
62	CUT DEPENDENCIES: TrkPhSin (since <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> assumes the existence of a single physical track) <hr><h2>Constructor & Destructor Documentation</h2>
63	<a class="anchor" name="00e54e0aade802c1c44fcfde47e905d6"></a><!-- doxytag: member="TrkRigGeoCut::TrkRigGeoCut" ref="00e54e0aade802c1c44fcfde47e905d6" args="(const char *cutName, float thresholdCoeff)" -->
64	<div class="memitem">
65	<div class="memproto">
66	<table class="memname">
67	<tr>
68	<td class="memname">TrkRigGeoCut::TrkRigGeoCut </td>
69	<td>(</td>
70	<td class="paramtype">const char * </td>
71	<td class="paramname"> <em>cutName</em>, </td>
72	</tr>
73	<tr>
74	<td class="paramkey"></td>
75	<td></td>
76	<td class="paramtype">float </td>
77	<td class="paramname"> <em>thresholdCoeff</em></td><td> </td>
78	</tr>
79	<tr>
80	<td></td>
81	<td>)</td>
82	<td></td><td></td><td><code> [inline]</code></td>
83	</tr>
84	</table>
85	</div>
86	<div class="memdoc">
87
88	<p>
89	Constructor.
90	<p>
91	<dl compact><dt><b>Parameters:</b></dt><dd>
92	<table border="0" cellspacing="2" cellpadding="0">
93	<tr><td valign="top"></td><td valign="top"><em>cutName</em> </td><td>The cut's name. </td></tr>
94	<tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em> </td><td>The threshold rigidity coefficient. </td></tr>
95	</table>
96	</dl>
97
98	</div>
99	</div><p>
100	<hr><h2>Member Function Documentation</h2>
101	<a class="anchor" name="d334792be6ca66d01d75bb2f86a57382"></a><!-- doxytag: member="TrkRigGeoCut::Check" ref="d334792be6ca66d01d75bb2f86a57382" args="(PamLevel2 *event)" -->
102	<div class="memitem">
103	<div class="memproto">
104	<table class="memname">
105	<tr>
106	<td class="memname">int TrkRigGeoCut::Check </td>
107	<td>(</td>
108	<td class="paramtype">PamLevel2 * </td>
109	<td class="paramname"> <em>event</em> </td>
110	<td> ) </td>
111	<td><code> [virtual]</code></td>
112	</tr>
113	</table>
114	</div>
115	<div class="memdoc">
116
117	<p>
118	The rigidity check.
119	<p>
120	<dl compact><dt><b>Parameters:</b></dt><dd>
121	<table border="0" cellspacing="2" cellpadding="0">
122	<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The event to analyze. </td></tr>
123	</table>
124	</dl>
125	<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 the rigidity modulus is greater than the geomagnetic cutoff rigidity times the threshold coefficient. <p>
126	0 otherwise. </dd></dl>
127
128	<p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
129
130	</div>
131	</div><p>
132	<hr>The documentation for this class was generated from the following files:<ul>
133	<li>TrkCuts/TrkRigGeoCut/<a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a><li>TrkCuts/TrkRigGeoCut/<a class="el" href="TrkRigGeoCut_8cpp.html">TrkRigGeoCut.cpp</a></ul>
134	</div>
135	<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:09 2009 for PamCut by
136	<a href="http://www.doxygen.org/index.html">
137	<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
138	</body>
139	</html>