Skip to content

Commit 7061d33

Browse files
actions-useractions-user
committed
Update Sphinx documentation
1 parent ec2d037 commit 7061d33

File tree

199 files changed

+16206
-9
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+16206
-9
lines changed

‎docs/pages/Abstract.html‎

Lines changed: 179 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="./">
5+
<head>
6+
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9+
<title>Abstract &mdash; findpeaks findpeaks documentation</title>
10+
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=03e43079" />
11+
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
12+
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=e0179649" />
13+
14+
15+
<script src="_static/jquery.js?v=5d32c60e"></script>
16+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
17+
<script src="_static/documentation_options.js?v=816012cb"></script>
18+
<script src="_static/doctools.js?v=9bcbadda"></script>
19+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
20+
<script src="_static/js/theme.js"></script>
21+
<link rel="index" title="Index" href="genindex.html" />
22+
<link rel="search" title="Search" href="search.html" />
23+
<link rel="next" title="Quickstart" href="Installation.html" />
24+
<link rel="prev" title="findpeaks’s documentation!" href="index.html" />
25+
</head>
26+
27+
<body class="wy-body-for-nav">
28+
<div class="wy-grid-for-nav">
29+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
30+
<div class="wy-side-scroll">
31+
<div class="wy-side-nav-search" >
32+
33+
34+
35+
<a href="index.html" class="icon icon-home">
36+
findpeaks
37+
</a>
38+
<div role="search">
39+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
40+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
41+
<input type="hidden" name="check_keywords" value="yes" />
42+
<input type="hidden" name="area" value="default" />
43+
</form>
44+
</div>
45+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
46+
47+
<p class="caption" role="heading"><span class="caption-text">Background</span></p>
48+
<ul class="current">
49+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Abstract</a></li>
50+
</ul>
51+
<p class="caption" role="heading"><span class="caption-text">Installation</span></p>
52+
<ul>
53+
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Quickstart</a></li>
54+
<li class="toctree-l1"><a class="reference internal" href="Installation.html#installation">Installation</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="Installation.html#uninstalling">Uninstalling</a></li>
56+
</ul>
57+
<p class="caption" role="heading"><span class="caption-text">Algorithms</span></p>
58+
<ul>
59+
<li class="toctree-l1"><a class="reference internal" href="Topology.html">Topology</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="Mask.html">Mask</a></li>
61+
<li class="toctree-l1"><a class="reference internal" href="Peakdetect.html">Peakdetect</a></li>
62+
<li class="toctree-l1"><a class="reference internal" href="Caerus.html">Caerus</a></li>
63+
<li class="toctree-l1"><a class="reference internal" href="Performance.html">Performance</a></li>
64+
</ul>
65+
<p class="caption" role="heading"><span class="caption-text">Pre-processing</span></p>
66+
<ul>
67+
<li class="toctree-l1"><a class="reference internal" href="Pre-processing.html">Pre-processing</a></li>
68+
<li class="toctree-l1"><a class="reference internal" href="Pre-processing.html#interpolation-and-imputation">Interpolation and imputation</a></li>
69+
<li class="toctree-l1"><a class="reference internal" href="Pre-processing.html#image-resizing">Image resizing</a></li>
70+
<li class="toctree-l1"><a class="reference internal" href="Pre-processing.html#image-scaling">Image scaling</a></li>
71+
<li class="toctree-l1"><a class="reference internal" href="Pre-processing.html#grayscale-conversion">Grayscale conversion</a></li>
72+
<li class="toctree-l1"><a class="reference internal" href="Pre-processing.html#comprehensive-preprocessing-pipeline">Comprehensive preprocessing pipeline</a></li>
73+
<li class="toctree-l1"><a class="reference internal" href="Denoise.html">Denoise</a></li>
74+
</ul>
75+
<p class="caption" role="heading"><span class="caption-text">Plots</span></p>
76+
<ul>
77+
<li class="toctree-l1"><a class="reference internal" href="Plots.html">Plots</a></li>
78+
<li class="toctree-l1"><a class="reference internal" href="Plots.html#pre-processing-visualization">Pre-processing visualization</a></li>
79+
<li class="toctree-l1"><a class="reference internal" href="Plots.html#persistence-diagram">Persistence diagram</a></li>
80+
<li class="toctree-l1"><a class="reference internal" href="Plots.html#d-pre-processing-visualization">2D Pre-processing visualization</a></li>
81+
<li class="toctree-l1"><a class="reference internal" href="Plots.html#persistence-diagram-for-2d-data">Persistence diagram for 2D data</a></li>
82+
<li class="toctree-l1"><a class="reference internal" href="Plots.html#d-mesh-visualization">3D mesh visualization</a></li>
83+
</ul>
84+
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
85+
<ul>
86+
<li class="toctree-l1"><a class="reference internal" href="Examples.html">Quick Examples</a></li>
87+
<li class="toctree-l1"><a class="reference internal" href="Use-cases.html">Stock Markets</a></li>
88+
<li class="toctree-l1"><a class="reference internal" href="Use-cases.html#sar">SAR</a></li>
89+
</ul>
90+
<p class="caption" role="heading"><span class="caption-text">Documentation</span></p>
91+
<ul>
92+
<li class="toctree-l1"><a class="reference internal" href="Documentation.html">Sponsor</a></li>
93+
<li class="toctree-l1"><a class="reference internal" href="Documentation.html#medium-blog">Medium Blog</a></li>
94+
<li class="toctree-l1"><a class="reference internal" href="Documentation.html#github">Github</a></li>
95+
<li class="toctree-l1"><a class="reference internal" href="Documentation.html#colab-notebook">Colab Notebook</a></li>
96+
<li class="toctree-l1"><a class="reference internal" href="Documentation.html#citing">Citing</a></li>
97+
<li class="toctree-l1"><a class="reference internal" href="Function_Reference.html">Function Reference</a></li>
98+
<li class="toctree-l1"><a class="reference internal" href="Coding%20quality.html">Coding Quality</a></li>
99+
</ul>
100+
101+
<a href= "genindex.html">Index</a>
102+
103+
</div>
104+
</div>
105+
</nav>
106+
107+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
108+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
109+
<a href="index.html">findpeaks</a>
110+
</nav>
111+
112+
<div class="wy-nav-content">
113+
<div class="rst-content">
114+
<div role="navigation" aria-label="Page navigation">
115+
<ul class="wy-breadcrumbs">
116+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
117+
<li class="breadcrumb-item active">Abstract</li>
118+
<li class="wy-breadcrumbs-aside">
119+
<a href="_sources/Abstract.rst.txt" rel="nofollow"> View page source</a>
120+
</li>
121+
</ul>
122+
<hr/>
123+
</div>
124+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
125+
<div itemprop="articleBody">
126+
127+
<section id="abstract">
128+
<h1>Abstract<a class="headerlink" href="#abstract" title="Link to this heading"></a></h1>
129+
<dl class="simple">
130+
<dt>Background</dt><dd><p>The detection of peaks is a well known challange across various domains. Peaks indicate significant events such as sudden increase in price/volume, sharp rise in demand, bursts in data traffic. Most routinely used detection methods do not employ any assumption for peak shapes or baseline noise. All the information these peak detection methods use is that peak is a signal that goes up and comes down. A peak is detected when a threshold is exceeded[1].</p>
131+
</dd>
132+
<dt>Aim</dt><dd><p>This library aims to detect peaks in both a 1-dimensional vector and 2-dimensional arrays (images) without making any assumption on the peak shape or baseline noise.
133+
To make sure that peaks can be detected across global and local heights, and in noisy data, multiple pre-processing and denoising methods are implemented or utilized.</p>
134+
</dd>
135+
<dt>Results</dt><dd><p>Three peak-detection methods are incorporated into this package, namely <em>Topology</em>, <em>Mask</em> and <em>Peakdetect</em>. The peaks can be ranked with among others <strong>persistence</strong> scores. The pre-processing approaches are among others, <strong>denoising</strong> methods, <strong>interpolation</strong> and <strong>smoothing</strong>, <strong>resizing</strong> and <strong>normalizing</strong> methods. In addition various plots are implemented to easily intepretate the results, such as the conversion of 2d-images to <strong>3d-mesh</strong> plots, <strong>persistence</strong> plot, and <strong>peak detection</strong> plots.</p>
136+
</dd>
137+
</dl>
138+
<p>[1] Peak detection. Data Analysis and Signal Processing in Chromatography, <a class="reference external" href="https://doi.org/10.1016/S0922-3487(98)80027-0">https://doi.org/10.1016/S0922-3487(98)80027-0</a>, Volume 21, 1998, Pages 183-190</p>
139+
<hr>
140+
<center>
141+
<script async src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script>
142+
<!-- Show an image ad -->
143+
<!-- <div data-ea-publisher="erdogantgithubio" data-ea-type="image"></div> -->
144+
<div data-ea-publisher="erdogantgithubio" data-ea-type="image" data-ea-style="stickybox"></div>
145+
</center>
146+
<hr></section>
147+
148+
149+
</div>
150+
</div>
151+
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
152+
<a href="index.html" class="btn btn-neutral float-left" title="findpeaks’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
153+
<a href="Installation.html" class="btn btn-neutral float-right" title="Quickstart" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
154+
</div>
155+
156+
<hr/>
157+
158+
<div role="contentinfo">
159+
<p>&#169; Copyright 2020, Erdogan Taskesen.</p>
160+
</div>
161+
162+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
163+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
164+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
165+
166+
167+
</footer>
168+
</div>
169+
</div>
170+
</section>
171+
</div>
172+
<script>
173+
jQuery(function () {
174+
SphinxRtdTheme.Navigation.enable(true);
175+
});
176+
</script>
177+
178+
</body>
179+
</html>

0 commit comments

Comments
 (0)