1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview — PyWavelets Documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '#',
VERSION: '0.2.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="top" title="PyWavelets Documentation" href="index.html" />
<link rel="next" title="API Reference" href="ref/index.html" />
<link rel="prev" title="PyWavelets - Discrete Wavelet Transform in Python" href="index.html" />
<meta name="description" content="PyWavelets is a scientific Python module for Wavelet Transform calculations." />
<meta name="keywords" content="PyWavelets, wavelets, Python, wavelet transform, discrete wavelet transform, dwt, idwt, swt, wavelet packets, stationary wavelet transform, pywt, Filip Wasilewski" />
<meta name="author" content="Filip Wasilewski" />
<meta name="Distribution" content="Global" />
<meta name="Robots" content="INDEX,FOLLOW" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="ref/index.html" title="API Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="PyWavelets - Discrete Wavelet Transform in Python"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PyWavelets Documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<span class="target" id="ref-overview"></span><span class="target" id="module-pywt"></span><div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p><cite>PyWavelets</cite> is a free Open Source wavelet transform software for <a class="reference external" href="http://python.org/">Python</a>
programming language. It is written in Python, Pyrex/Cython and C for a mix
of easy and powerful high-level interface and the best performance.</p>
<p><cite>PyWavelets</cite> is very easy to start with and use. Just install the package, open
the Python interactive shell and type:</p>
<blockquote>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pywt</span>
<span class="gp">>>> </span><span class="n">cA</span><span class="p">,</span> <span class="n">cD</span> <span class="o">=</span> <span class="n">pywt</span><span class="o">.</span><span class="n">dwt</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">],</span> <span class="s">'db1'</span><span class="p">)</span>
</pre></div>
</div>
</blockquote>
<p>Voilà! Computing wavelet transforms never before has been so simple :)</p>
<div class="section" id="main-features">
<h2>Main features<a class="headerlink" href="#main-features" title="Permalink to this headline">¶</a></h2>
<p>The main features of <cite>PyWavelets</cite> are:</p>
<blockquote>
<ul class="simple">
<li>1D and 2D Forward and Inverse Discrete Wavelet Transform (DWT and IDWT)</li>
<li>1D and 2D Stationary Wavelet Transform (Undecimated Wavelet Transform)</li>
<li>1D and 2D Wavelet Packet decomposition and reconstruction</li>
<li>Approximating wavelet and scaling functions</li>
<li>Over seventy built-in wavelet filters and custom wavelets supported</li>
<li>Single and double precision calculations supported</li>
<li>Results compatibility with Matlab Wavelet Toolbox™</li>
</ul>
</blockquote>
</div>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p><cite>PyWavelets</cite> is a Python programming language package and requires <a class="reference external" href="http://python.org/">Python</a>
2.4, 2.5 or 2.6 installed. The only external requirement is a recent version of
<a class="reference external" href="http://www.scipy.org/">NumPy</a> numeric array module.</p>
</div>
<div class="section" id="download">
<h2>Download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2>
<p>Current release, including source and binary release for Windows, is
available for download from the Python Package Index at:</p>
<blockquote>
<a class="reference external" href="http://pypi.python.org/pypi/PyWavelets/">http://pypi.python.org/pypi/PyWavelets/</a></blockquote>
<p>The latest <em>development</em> version can be found in the wavelets.scipy.org’s SVN
<a class="reference external" href="http://wavelets.scipy.org/svn/multiresolution/pywt/trunk">source code repository</a>:</p>
<div class="highlight-python"><pre>svn co http://wavelets.scipy.org/svn/multiresolution/pywt/trunk pywt</pre>
</div>
</div>
<div class="section" id="install">
<h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
<p>The most convenient way to install <cite>PyWavelets</cite> is to use the
<a class="reference external" href="http://peak.telecommunity.com/DevCenter/setuptools">setuptools</a>‘
<a class="reference external" href="http://peak.telecommunity.com/DevCenter/EasyInstall#using-easy-install">Easy Install</a>
manager:</p>
<div class="highlight-python"><pre>easy_install -U PyWavelets</pre>
</div>
<p>In order to build <cite>PyWavelets</cite> from source, a working C compiler and a recent version
of <a class="reference external" href="http://www.cython.org/">Cython</a> is required.</p>
<p>After completing the build environment, open the shell prompt, go to the
<cite>PyWavelets</cite> source code directory and type:</p>
<div class="highlight-python"><pre>python setup.py install</pre>
</div>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference external" href="dev/index.html#dev-index"><em>Development notes</em></a> section contains more
information on building from source code.</p>
</div>
<p>For Windows users there is a standard binary installer available for
download from the <a class="reference external" href="http://pypi.python.org/pypi/PyWavelets/">Python Package Index</a>.
Just execute it to install the package on your computer.</p>
<p>Also binary packages for several Linux distributors are
<a class="reference external" href="http://wavelets.scipy.org/moin/Download">maintained</a> by
Open Source community contributors. Please consult your favourite package
manager tool for <cite>python-wavelets</cite>, <cite>python-pywt</cite> or similar package name.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you happen to maintain a <cite>PyWavelets</cite> Linux binary package please
put information and your name on the
<a class="reference external" href="http://wavelets.scipy.org/moin/Download">wiki download page</a>
or contact me and I will update the page. Thanks for help!</p>
</div>
<p>To verify the installation process try running tests and examples from the
<a class="reference external" href="http://projects.scipy.org/wavelets/browser/pywt/trunk/tests/">tests</a>
and <a class="reference external" href="http://projects.scipy.org/wavelets/browser/pywt/trunk/demo/">demo</a>
directories included in the source distribution.
Note that most of the examples relies on the
<a class="reference external" href="http://matplotlib.sourceforge.net">matplotlib</a> plotting package.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p><cite>PyWavelets</cite> is a free Open Source software available under the
<a href="_downloads/COPYING.txt"><strong class="xref">MIT license terms</strong></a>.</p>
</div>
<div class="section" id="contact">
<h2>Contact<a class="headerlink" href="#contact" title="Permalink to this headline">¶</a></h2>
<p>Post your suggestions and guestions to
<a class="reference external" href="http://groups.google.com/group/pywavelets">PyWavelets discussions group</a>
(<a class="reference external" href="mailto:pywavelets%40googlegroups.com">pywavelets<span>@</span>googlegroups<span>.</span>com</a>). You can also contact me directly
at <a class="reference external" href="mailto:en%40ig.ma">en<span>@</span>ig<span>.</span>ma</a>. Comments, bug reports and fixes are welcome.</p>
<p>There’s also a wiki and trac system available at the <a class="reference external" href="http://wavelets.scipy.org">wavelets.scipy.org</a>
site to improve documentation, post cookbook recipes or submit
enhancement proposals and bug reports.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference external" href="#">Overview</a><ul>
<li><a class="reference external" href="#main-features">Main features</a></li>
<li><a class="reference external" href="#requirements">Requirements</a></li>
<li><a class="reference external" href="#download">Download</a></li>
<li><a class="reference external" href="#install">Install</a></li>
<li><a class="reference external" href="#license">License</a></li>
<li><a class="reference external" href="#contact">Contact</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">PyWavelets - Discrete Wavelet Transform in Python</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ref/index.html"
title="next chapter">API Reference</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/overview.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<div>
<h3>Quick links</h3>
<ul>
<li><a href="http://groups.google.com/group/pywavelets"><img src="_static/comments.png" height="16" width="16" alt="" /> Visit Discussion Group</a></li>
<li><a href="http://wavelets.scipy.org/moin/"><img src="_static/page_edit.png" height="16" width="16" alt="" /> View Wiki Page</a></li>
<li><a href="http://projects.scipy.org/wavelets/browser/pywt/trunk/"><img src="_static/cog.png" height="16" width="16" alt="" /> Browse Source Code</a></li>
<li><a href="http://wavelets.pybytes.com/"><img src="_static/wave.png" height="16" width="16" alt="" /> Explore Wavelets</a></li>
<li><a href="http://delicious.com/save" onclick="window.open('http://delicious.com/save?v=5&noui&jump=close&url='+encodeURIComponent('http://www.pybytes.com/pywavelets/')+'&title='+encodeURIComponent('PyWavelets - Discrete Wavelet Transform in Python'), 'delicious','toolbar=no,width=550,height=550'); return false;"><img src="_static/delicious.png" height="12" width="12" alt="Delicious" style="margin: 0 2px 0 2px;" /> Bookmark with Delicious</a></li>
<li><a href="http://twitter.com/filipwasilewski"><img src="_static/twitter.png" height="16" width="16" alt="" /> Follow on Twitter</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ref/index.html" title="API Reference"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="PyWavelets - Discrete Wavelet Transform in Python"
>previous</a> |</li>
<li><a href="index.html">PyWavelets Documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2006-2010, <a href="http://filipwasilewski.pl/">Filip Wasilewski</a>.
Last updated on Mar 16, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3396395-3");
pageTracker._initData();
pageTracker._trackPageview();
</script>
</body>
</html>
|
