| 1 |
pam-fi |
1.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: RigFillCut 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>RigFillCut Class Reference</h1><!-- doxytag: class="RigFillCut" --><!-- doxytag: inherits="PamCut" -->The rigidity vs threshold rigidity histogram filling. |
| 26 |
|
|
<a href="#_details">More...</a> |
| 27 |
|
|
<p> |
| 28 |
|
|
<code>#include <<a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>></code> |
| 29 |
|
|
<p> |
| 30 |
|
|
<div class="dynheader"> |
| 31 |
|
|
Inheritance diagram for RigFillCut:</div> |
| 32 |
|
|
<div class="dynsection"> |
| 33 |
|
|
|
| 34 |
|
|
<p><center><img src="classRigFillCut.png" usemap="#RigFillCut_map" border="0" alt=""></center> |
| 35 |
|
|
<map name="RigFillCut_map"> |
| 36 |
|
|
<area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,66,24"> |
| 37 |
|
|
</map> |
| 38 |
|
|
</div> |
| 39 |
|
|
|
| 40 |
|
|
<p> |
| 41 |
|
|
<a href="classRigFillCut-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="classRigFillCut.html#db50b4fec5f11499db9039baea8a4392">RigFillCut</a> (const char *cutName, std::vector< float > binning, float thresholdCoeff)</td></tr> |
| 45 |
|
|
|
| 46 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#db50b4fec5f11499db9039baea8a4392"></a><br></td></tr> |
| 47 |
pam-fi |
1.2 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e1f3f9df6e8c684060ccd76da9edaad"></a><!-- doxytag: member="RigFillCut::~RigFillCut" ref="3e1f3f9df6e8c684060ccd76da9edaad" args="()" --> |
| 48 |
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classRigFillCut.html#3e1f3f9df6e8c684060ccd76da9edaad">~RigFillCut</a> ()</td></tr> |
| 49 |
pam-fi |
1.1 |
|
| 50 |
pam-fi |
1.2 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr> |
| 51 |
pam-fi |
1.1 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRigFillCut.html#5441206a7a24f1f5d19dc1a64685fcd4">Check</a> (PamLevel2 *event)</td></tr> |
| 52 |
|
|
|
| 53 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The rigidity and cutoff rigidity check. <a href="#5441206a7a24f1f5d19dc1a64685fcd4"></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="classRigFillCut.html#537f1b31f208ebe8f190f254be1fdc6c">OnGood</a> (PamLevel2 *event)</td></tr> |
| 55 |
|
|
|
| 56 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The histogram filling. <a href="#537f1b31f208ebe8f190f254be1fdc6c"></a><br></td></tr> |
| 57 |
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>< UInt_t > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRigFillCut.html#532f3bb2e39f3c9da3a70e72eae8389d">GetHisto</a> ()</td></tr> |
| 58 |
|
|
|
| 59 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the histogram. <a href="#532f3bb2e39f3c9da3a70e72eae8389d"></a><br></td></tr> |
| 60 |
|
|
</table> |
| 61 |
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 62 |
|
|
The rigidity vs threshold rigidity histogram filling. |
| 63 |
|
|
<p> |
| 64 |
|
|
This class checks the events and builds a 2D histogram binned in rigidity modulus and threshold rigidity. Each 2D bin will contain the number of events whose rigidity modulus and threshold rigidity (eg., Stoermer cutoff rigidity times a threshold coefficient) lie in that bin. Note that the meaning of this threshold coefficient is the same as in <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a>, so it must have the same value used for <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> (consider using <a class="el" href="classTrkRigGeoCut.html#5b3e2d3037d140ae852bd02975842eb4" title="Returns the threshold coefficient.">TrkRigGeoCut::GetThresholdCoeff()</a> to retrieve its value). Events are discarded only if their rigidity modulus or cutoff rigidity lies outside the histogram bounds.<p> |
| 65 |
pam-fi |
1.2 |
CUT DEPENDECIES: <a class="el" href="classTrkPhSinCut.html" title="The single physical track cut. Only events with a single physical track (selected...">TrkPhSinCut</a> for single physical track, <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> for galactic event. <hr><h2>Constructor & Destructor Documentation</h2> |
| 66 |
pam-fi |
1.1 |
<a class="anchor" name="db50b4fec5f11499db9039baea8a4392"></a><!-- doxytag: member="RigFillCut::RigFillCut" ref="db50b4fec5f11499db9039baea8a4392" args="(const char *cutName, std::vector< float > binning, float thresholdCoeff)" --> |
| 67 |
|
|
<div class="memitem"> |
| 68 |
|
|
<div class="memproto"> |
| 69 |
|
|
<table class="memname"> |
| 70 |
|
|
<tr> |
| 71 |
|
|
<td class="memname">RigFillCut::RigFillCut </td> |
| 72 |
|
|
<td>(</td> |
| 73 |
|
|
<td class="paramtype">const char * </td> |
| 74 |
|
|
<td class="paramname"> <em>cutName</em>, </td> |
| 75 |
|
|
</tr> |
| 76 |
|
|
<tr> |
| 77 |
|
|
<td class="paramkey"></td> |
| 78 |
|
|
<td></td> |
| 79 |
|
|
<td class="paramtype">std::vector< float > </td> |
| 80 |
|
|
<td class="paramname"> <em>binning</em>, </td> |
| 81 |
|
|
</tr> |
| 82 |
|
|
<tr> |
| 83 |
|
|
<td class="paramkey"></td> |
| 84 |
|
|
<td></td> |
| 85 |
|
|
<td class="paramtype">float </td> |
| 86 |
|
|
<td class="paramname"> <em>thresholdCoeff</em></td><td> </td> |
| 87 |
|
|
</tr> |
| 88 |
|
|
<tr> |
| 89 |
|
|
<td></td> |
| 90 |
|
|
<td>)</td> |
| 91 |
|
|
<td></td><td></td><td><code> [inline]</code></td> |
| 92 |
|
|
</tr> |
| 93 |
|
|
</table> |
| 94 |
|
|
</div> |
| 95 |
|
|
<div class="memdoc"> |
| 96 |
|
|
|
| 97 |
|
|
<p> |
| 98 |
|
|
Constructor. |
| 99 |
|
|
<p> |
| 100 |
|
|
The binning vectors must contain both the upper and lower limits, and the elements must be ordered (ie., lowest value in the first element and so on) and positive, so that charge sign will be irrelevant.<p> |
| 101 |
|
|
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 102 |
|
|
<table border="0" cellspacing="2" cellpadding="0"> |
| 103 |
|
|
<tr><td valign="top"></td><td valign="top"><em>cutName</em> </td><td>The cut's name. </td></tr> |
| 104 |
|
|
<tr><td valign="top"></td><td valign="top"><em>binning</em> </td><td>A vector containing the histogram binning in rigidity modulus (X axis) and cutoff rigidity (Y axis). </td></tr> |
| 105 |
|
|
<tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em> </td><td>The threshold rigidity coefficient for the event selection. </td></tr> |
| 106 |
|
|
</table> |
| 107 |
|
|
</dl> |
| 108 |
|
|
|
| 109 |
|
|
</div> |
| 110 |
|
|
</div><p> |
| 111 |
|
|
<hr><h2>Member Function Documentation</h2> |
| 112 |
|
|
<a class="anchor" name="5441206a7a24f1f5d19dc1a64685fcd4"></a><!-- doxytag: member="RigFillCut::Check" ref="5441206a7a24f1f5d19dc1a64685fcd4" args="(PamLevel2 *event)" --> |
| 113 |
|
|
<div class="memitem"> |
| 114 |
|
|
<div class="memproto"> |
| 115 |
|
|
<table class="memname"> |
| 116 |
|
|
<tr> |
| 117 |
|
|
<td class="memname">int RigFillCut::Check </td> |
| 118 |
|
|
<td>(</td> |
| 119 |
|
|
<td class="paramtype">PamLevel2 * </td> |
| 120 |
|
|
<td class="paramname"> <em>event</em> </td> |
| 121 |
|
|
<td> ) </td> |
| 122 |
|
|
<td><code> [virtual]</code></td> |
| 123 |
|
|
</tr> |
| 124 |
|
|
</table> |
| 125 |
|
|
</div> |
| 126 |
|
|
<div class="memdoc"> |
| 127 |
|
|
|
| 128 |
|
|
<p> |
| 129 |
|
|
The rigidity and cutoff rigidity check. |
| 130 |
|
|
<p> |
| 131 |
|
|
The event is discarded if its rigidity modulus or threshold rigidity are outside the limits of the binnings. Please note that only absolute rigidity is considered.<p> |
| 132 |
|
|
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 133 |
|
|
<table border="0" cellspacing="2" cellpadding="0"> |
| 134 |
|
|
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The event to analyze. </td></tr> |
| 135 |
|
|
</table> |
| 136 |
|
|
</dl> |
| 137 |
|
|
<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 both rigidity modulus and threshold rigidity is contained in the histogram limits. <p> |
| 138 |
|
|
0 otherwise. </dd></dl> |
| 139 |
|
|
|
| 140 |
|
|
<p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p> |
| 141 |
|
|
|
| 142 |
|
|
</div> |
| 143 |
|
|
</div><p> |
| 144 |
|
|
<a class="anchor" name="532f3bb2e39f3c9da3a70e72eae8389d"></a><!-- doxytag: member="RigFillCut::GetHisto" ref="532f3bb2e39f3c9da3a70e72eae8389d" args="()" --> |
| 145 |
|
|
<div class="memitem"> |
| 146 |
|
|
<div class="memproto"> |
| 147 |
|
|
<table class="memname"> |
| 148 |
|
|
<tr> |
| 149 |
|
|
<td class="memname"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a><UInt_t>& RigFillCut::GetHisto </td> |
| 150 |
|
|
<td>(</td> |
| 151 |
|
|
<td class="paramname"> </td> |
| 152 |
|
|
<td> ) </td> |
| 153 |
|
|
<td><code> [inline]</code></td> |
| 154 |
|
|
</tr> |
| 155 |
|
|
</table> |
| 156 |
|
|
</div> |
| 157 |
|
|
<div class="memdoc"> |
| 158 |
|
|
|
| 159 |
|
|
<p> |
| 160 |
|
|
Returns the histogram. |
| 161 |
|
|
<p> |
| 162 |
|
|
This method returns a <a class="el" href="classSimpleMatrix.html" title="A simple matrix class.">SimpleMatrix</a>. Its [i][j] element contain the number of analyzed events whose rigidity modulus falls in the i-th rigidity bin and whose threshold rigidity falls in the j-th rigidity bin.<p> |
| 163 |
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The rigidity modulus - threshold rigidity 2D histogram </dd></dl> |
| 164 |
|
|
|
| 165 |
|
|
</div> |
| 166 |
|
|
</div><p> |
| 167 |
|
|
<a class="anchor" name="537f1b31f208ebe8f190f254be1fdc6c"></a><!-- doxytag: member="RigFillCut::OnGood" ref="537f1b31f208ebe8f190f254be1fdc6c" args="(PamLevel2 *event)" --> |
| 168 |
|
|
<div class="memitem"> |
| 169 |
|
|
<div class="memproto"> |
| 170 |
|
|
<table class="memname"> |
| 171 |
|
|
<tr> |
| 172 |
|
|
<td class="memname">void RigFillCut::OnGood </td> |
| 173 |
|
|
<td>(</td> |
| 174 |
|
|
<td class="paramtype">PamLevel2 * </td> |
| 175 |
|
|
<td class="paramname"> <em>event</em> </td> |
| 176 |
|
|
<td> ) </td> |
| 177 |
|
|
<td><code> [virtual]</code></td> |
| 178 |
|
|
</tr> |
| 179 |
|
|
</table> |
| 180 |
|
|
</div> |
| 181 |
|
|
<div class="memdoc"> |
| 182 |
|
|
|
| 183 |
|
|
<p> |
| 184 |
|
|
The histogram filling. |
| 185 |
|
|
<p> |
| 186 |
|
|
The method fills the histogram with the currently selected event.<p> |
| 187 |
|
|
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 188 |
|
|
<table border="0" cellspacing="2" cellpadding="0"> |
| 189 |
|
|
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The currently selected event. </td></tr> |
| 190 |
|
|
</table> |
| 191 |
|
|
</dl> |
| 192 |
|
|
|
| 193 |
|
|
<p>Reimplemented from <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985">PamCut</a>.</p> |
| 194 |
|
|
|
| 195 |
|
|
</div> |
| 196 |
|
|
</div><p> |
| 197 |
|
|
<hr>The documentation for this class was generated from the following files:<ul> |
| 198 |
pam-fi |
1.2 |
<li>TrkCuts/RigFillCut/<a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a><li>TrkCuts/RigFillCut/<a class="el" href="RigFillCut_8cpp.html">RigFillCut.cpp</a></ul> |
| 199 |
pam-fi |
1.1 |
</div> |
| 200 |
pam-fi |
1.2 |
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:04 2009 for PamCut by |
| 201 |
pam-fi |
1.1 |
<a href="http://www.doxygen.org/index.html"> |
| 202 |
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 203 |
|
|
</body> |
| 204 |
|
|
</html> |
Parent Directory
| 
Revision Log