Debian Codegraph @

doc/artificialFastqGenerator/CoverageStatisticsCalculator.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc (version 1.7.0_51) on Wed Oct 01 16:41:56 BST 2014 -->
6 <title>CoverageStatisticsCalculator</title>
7 <meta name="date" content="2014-10-01">
8 <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
9 </head>
10 <body>
11 <script type="text/javascript"><!--
12 if (location.href.indexOf('is-external=true') == -1) {
13 parent.document.title="CoverageStatisticsCalculator";
14 }
15 //-->
16 </script>
17 <noscript>
18 <div>JavaScript is disabled on your browser.</div>
19 </noscript>
20 <!-- ========= START OF TOP NAVBAR ======= -->
21 <div class="topNav"><a name="navbar_top">
22 <!-- -->
23 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24 <!-- -->
25 </a>
26 <ul class="navList" title="Navigation">
27 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
28 <li class="navBarCell1Rev">Class</li>
29 <li><a href="class-use/CoverageStatisticsCalculator.html">Use</a></li>
30 <li><a href="package-tree.html">Tree</a></li>
31 <li><a href="../deprecated-list.html">Deprecated</a></li>
32 <li><a href="../index-files/index-1.html">Index</a></li>
33 <li><a href="../help-doc.html">Help</a></li>
34 </ul>
35 </div>
36 <div class="subNav">
37 <ul class="navList">
38 <li><a href="../artificialFastqGenerator/BriefLogFormatter.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
39 <li><a href="../artificialFastqGenerator/Genomes.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li>
40 </ul>
41 <ul class="navList">
42 <li><a href="../index.html?artificialFastqGenerator/CoverageStatisticsCalculator.html" target="_top">Frames</a></li>
43 <li><a href="CoverageStatisticsCalculator.html" target="_top">No Frames</a></li>
44 </ul>
45 <ul class="navList" id="allclasses_navbar_top">
46 <li><a href="../allclasses-noframe.html">All Classes</a></li>
47 </ul>
48 <div>
49 <script type="text/javascript"><!--
50 allClassesLink = document.getElementById("allclasses_navbar_top");
51 if(window==top) {
52 allClassesLink.style.display = "block";
53 }
54 else {
55 allClassesLink.style.display = "none";
56 }
57 //-->
58 </script>
59 </div>
60 <div>
61 <ul class="subNavList">
62 <li>Summary:&nbsp;</li>
63 <li>Nested&nbsp;|&nbsp;</li>
64 <li>Field&nbsp;|&nbsp;</li>
65 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
66 <li><a href="#method_summary">Method</a></li>
67 </ul>
68 <ul class="subNavList">
69 <li>Detail:&nbsp;</li>
70 <li>Field&nbsp;|&nbsp;</li>
71 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
72 <li><a href="#method_detail">Method</a></li>
73 </ul>
74 </div>
75 <a name="skip-navbar_top">
76 <!-- -->
77 </a></div>
78 <!-- ========= END OF TOP NAVBAR ========= -->
79 <!-- ======== START OF CLASS DATA ======== -->
80 <div class="header">
81 <div class="subTitle">artificialFastqGenerator</div>
82 <h2 title="Class CoverageStatisticsCalculator" class="title">Class CoverageStatisticsCalculator</h2>
83 </div>
84 <div class="contentContainer">
85 <ul class="inheritance">
86 <li>java.lang.Object</li>
87 <li>
88 <ul class="inheritance">
89 <li>artificialFastqGenerator.CoverageStatisticsCalculator</li>
90 </ul>
91 </li>
92 </ul>
93 <div class="description">
94 <ul class="blockList">
95 <li class="blockList">
96 <hr>
97 <br>
98 <pre>public class <span class="strong">CoverageStatisticsCalculator</span>
99 extends java.lang.Object</pre>
100 <div class="block">Instances of this class calculate regional and overall coverage statistics for nucleobases.
101
102 Copyright (C) 2012 The Institute of Cancer Research (ICR).
103
104 This file is part of ArtificialFastqGenerator v1.0.0.
105
106 ArtificialFastqGenerator is free software: you can redistribute it and/or modify it under the terms of the GNU General
107 Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any
108 later version.
109
110 This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY; without even the implied warranty
111 of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
112
113 You should have received a copy of the GNU Public License along with this program. If not, see
114 <http://www.gnu.org/licenses/>
115
116 Authour's contact email: [email protected]</div>
117 </li>
118 </ul>
119 </div>
120 <div class="summary">
121 <ul class="blockList">
122 <li class="blockList">
123 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
124 <ul class="blockList">
125 <li class="blockList"><a name="constructor_summary">
126 <!-- -->
127 </a>
128 <h3>Constructor Summary</h3>
129 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
130 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
131 <tr>
132 <th class="colOne" scope="col">Constructor and Description</th>
133 </tr>
134 <tr class="altColor">
135 <td class="colOne"><code><strong><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html#CoverageStatisticsCalculator()">CoverageStatisticsCalculator</a></strong>()</code>
136 <div class="block">Initialise a new CoverageStatisticsCalculator object.</div>
137 </td>
138 </tr>
139 </table>
140 </li>
141 </ul>
142 <!-- ========== METHOD SUMMARY =========== -->
143 <ul class="blockList">
144 <li class="blockList"><a name="method_summary">
145 <!-- -->
146 </a>
147 <h3>Method Summary</h3>
148 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
149 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
150 <tr>
151 <th class="colFirst" scope="col">Modifier and Type</th>
152 <th class="colLast" scope="col">Method and Description</th>
153 </tr>
154 <tr class="altColor">
155 <td class="colFirst"><code>void</code></td>
156 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html#logCoverageStatsHeader()">logCoverageStatsHeader</a></strong>()</code>
157 <div class="block">Log the coverage statistics header.</div>
158 </td>
159 </tr>
160 <tr class="rowColor">
161 <td class="colFirst"><code>void</code></td>
162 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html#logOverallStats()">logOverallStats</a></strong>()</code>
163 <div class="block">Log the overall coverage and error statistics.</div>
164 </td>
165 </tr>
166 <tr class="altColor">
167 <td class="colFirst"><code>void</code></td>
168 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html#logRegionStats()">logRegionStats</a></strong>()</code>
169 <div class="block">Log the region coverage statistics.</div>
170 </td>
171 </tr>
172 <tr class="rowColor">
173 <td class="colFirst"><code>void</code></td>
174 <td class="colLast"><code><strong><a href="../artificialFastqGenerator/CoverageStatisticsCalculator.html#updateRegionStatsFrom1Nucleobase(artificialFastqGenerator.Nucleobase)">updateRegionStatsFrom1Nucleobase</a></strong>(<a href="../artificialFastqGenerator/Nucleobase.html" title="class in artificialFastqGenerator">Nucleobase</a>&nbsp;nucleobase)</code>
175 <div class="block">Update the region coverage statistics from the coverage statistics for 1
176 nucleobase in that region.</div>
177 </td>
178 </tr>
179 </table>
180 <ul class="blockList">
181 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
182 <!-- -->
183 </a>
184 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
185 <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
186 </ul>
187 </li>
188 </ul>
189 </li>
190 </ul>
191 </div>
192 <div class="details">
193 <ul class="blockList">
194 <li class="blockList">
195 <!-- ========= CONSTRUCTOR DETAIL ======== -->
196 <ul class="blockList">
197 <li class="blockList"><a name="constructor_detail">
198 <!-- -->
199 </a>
200 <h3>Constructor Detail</h3>
201 <a name="CoverageStatisticsCalculator()">
202 <!-- -->
203 </a>
204 <ul class="blockListLast">
205 <li class="blockList">
206 <h4>CoverageStatisticsCalculator</h4>
207 <pre>public&nbsp;CoverageStatisticsCalculator()</pre>
208 <div class="block">Initialise a new CoverageStatisticsCalculator object.</div>
209 </li>
210 </ul>
211 </li>
212 </ul>
213 <!-- ============ METHOD DETAIL ========== -->
214 <ul class="blockList">
215 <li class="blockList"><a name="method_detail">
216 <!-- -->
217 </a>
218 <h3>Method Detail</h3>
219 <a name="logCoverageStatsHeader()">
220 <!-- -->
221 </a>
222 <ul class="blockList">
223 <li class="blockList">
224 <h4>logCoverageStatsHeader</h4>
225 <pre>public&nbsp;void&nbsp;logCoverageStatsHeader()</pre>
226 <div class="block">Log the coverage statistics header.</div>
227 </li>
228 </ul>
229 <a name="updateRegionStatsFrom1Nucleobase(artificialFastqGenerator.Nucleobase)">
230 <!-- -->
231 </a>
232 <ul class="blockList">
233 <li class="blockList">
234 <h4>updateRegionStatsFrom1Nucleobase</h4>
235 <pre>public&nbsp;void&nbsp;updateRegionStatsFrom1Nucleobase(<a href="../artificialFastqGenerator/Nucleobase.html" title="class in artificialFastqGenerator">Nucleobase</a>&nbsp;nucleobase)</pre>
236 <div class="block">Update the region coverage statistics from the coverage statistics for 1
237 nucleobase in that region.</div>
238 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>nucleobase</code> - - nucleobase from which to update region stats.</dd></dl>
239 </li>
240 </ul>
241 <a name="logRegionStats()">
242 <!-- -->
243 </a>
244 <ul class="blockList">
245 <li class="blockList">
246 <h4>logRegionStats</h4>
247 <pre>public&nbsp;void&nbsp;logRegionStats()</pre>
248 <div class="block">Log the region coverage statistics.</div>
249 </li>
250 </ul>
251 <a name="logOverallStats()">
252 <!-- -->
253 </a>
254 <ul class="blockListLast">
255 <li class="blockList">
256 <h4>logOverallStats</h4>
257 <pre>public&nbsp;void&nbsp;logOverallStats()</pre>
258 <div class="block">Log the overall coverage and error statistics.</div>
259 </li>
260 </ul>
261 </li>
262 </ul>
263 </li>
264 </ul>
265 </div>
266 </div>
267 <!-- ========= END OF CLASS DATA ========= -->
268 <!-- ======= START OF BOTTOM NAVBAR ====== -->
269 <div class="bottomNav"><a name="navbar_bottom">
270 <!-- -->
271 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
272 <!-- -->
273 </a>
274 <ul class="navList" title="Navigation">
275 <li><a href="../artificialFastqGenerator/package-summary.html">Package</a></li>
276 <li class="navBarCell1Rev">Class</li>
277 <li><a href="class-use/CoverageStatisticsCalculator.html">Use</a></li>
278 <li><a href="package-tree.html">Tree</a></li>
279 <li><a href="../deprecated-list.html">Deprecated</a></li>
280 <li><a href="../index-files/index-1.html">Index</a></li>
281 <li><a href="../help-doc.html">Help</a></li>
282 </ul>
283 </div>
284 <div class="subNav">
285 <ul class="navList">
286 <li><a href="../artificialFastqGenerator/BriefLogFormatter.html" title="class in artificialFastqGenerator"><span class="strong">Prev Class</span></a></li>
287 <li><a href="../artificialFastqGenerator/Genomes.html" title="class in artificialFastqGenerator"><span class="strong">Next Class</span></a></li>
288 </ul>
289 <ul class="navList">
290 <li><a href="../index.html?artificialFastqGenerator/CoverageStatisticsCalculator.html" target="_top">Frames</a></li>
291 <li><a href="CoverageStatisticsCalculator.html" target="_top">No Frames</a></li>
292 </ul>
293 <ul class="navList" id="allclasses_navbar_bottom">
294 <li><a href="../allclasses-noframe.html">All Classes</a></li>
295 </ul>
296 <div>
297 <script type="text/javascript"><!--
298 allClassesLink = document.getElementById("allclasses_navbar_bottom");
299 if(window==top) {
300 allClassesLink.style.display = "block";
301 }
302 else {
303 allClassesLink.style.display = "none";
304 }
305 //-->
306 </script>
307 </div>
308 <div>
309 <ul class="subNavList">
310 <li>Summary:&nbsp;</li>
311 <li>Nested&nbsp;|&nbsp;</li>
312 <li>Field&nbsp;|&nbsp;</li>
313 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
314 <li><a href="#method_summary">Method</a></li>
315 </ul>
316 <ul class="subNavList">
317 <li>Detail:&nbsp;</li>
318 <li>Field&nbsp;|&nbsp;</li>
319 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
320 <li><a href="#method_detail">Method</a></li>
321 </ul>
322 </div>
323 <a name="skip-navbar_bottom">
324 <!-- -->
325 </a></div>
326 <!-- ======== END OF BOTTOM NAVBAR ======= -->
327 </body>
328 </html>