<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Reference — PyWavelets Documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within PyWavelets Documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Wavelets" href="wavelets.html" />
<link rel="prev" title="Installing" href="../install.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"/>
<meta name="author" content="Filip Wasilewski"/>
<meta name="Distribution" content="Global"/>
<meta name="Robots" content="INDEX,FOLLOW"/>
<script type="text/javascript">
(function ($) {
$(document).ready(function () {
$("#toggle-edit-info").click(function (e) {
e.preventDefault();
$("#edit-info").toggle();
});
});
})(jQuery);
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-3396395-3']);
_gaq.push(['_trackPageview']);
(function () {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
</script>
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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="wavelets.html" title="Wavelets"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../install.html" title="Installing"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Home »</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="api-reference">
<span id="ref-index"></span><h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">ΒΆ</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="wavelets.html">Wavelets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="wavelets.html#wavelet-families">Wavelet <code class="docutils literal notranslate"><span class="pre">families()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="wavelets.html#built-in-wavelets-wavelist">Built-in wavelets - <code class="docutils literal notranslate"><span class="pre">wavelist()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="wavelets.html#wavelet-object"><code class="docutils literal notranslate"><span class="pre">Wavelet</span></code> object</a></li>
<li class="toctree-l2"><a class="reference internal" href="wavelets.html#custom-wavelets">Using custom wavelets</a></li>
<li class="toctree-l2"><a class="reference internal" href="wavelets.html#continuouswavelet-object"><code class="docutils literal notranslate"><span class="pre">ContinuousWavelet</span></code> object</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="signal-extension-modes.html">Signal extension modes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="signal-extension-modes.html#naming-conventions">Naming Conventions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dwt-discrete-wavelet-transform.html">Discrete Wavelet Transform (DWT)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dwt-discrete-wavelet-transform.html#single-level-dwt">Single level <code class="docutils literal notranslate"><span class="pre">dwt</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-discrete-wavelet-transform.html#multilevel-decomposition-using-wavedec">Multilevel decomposition using <code class="docutils literal notranslate"><span class="pre">wavedec</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-discrete-wavelet-transform.html#partial-discrete-wavelet-transform-data-decomposition-downcoef">Partial Discrete Wavelet Transform data decomposition <code class="docutils literal notranslate"><span class="pre">downcoef</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-discrete-wavelet-transform.html#maximum-decomposition-level-dwt-max-level-dwtn-max-level">Maximum decomposition level - <code class="docutils literal notranslate"><span class="pre">dwt_max_level</span></code>, <code class="docutils literal notranslate"><span class="pre">dwtn_max_level</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-discrete-wavelet-transform.html#result-coefficients-length-dwt-coeff-len">Result coefficients length - <code class="docutils literal notranslate"><span class="pre">dwt_coeff_len</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="idwt-inverse-discrete-wavelet-transform.html">Inverse Discrete Wavelet Transform (IDWT)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="idwt-inverse-discrete-wavelet-transform.html#single-level-idwt">Single level <code class="docutils literal notranslate"><span class="pre">idwt</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="2d-decompositions-overview.html">Overview of multilevel wavelet decompositions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="2d-decompositions-overview.html#multilevel-discrete-wavelet-transform">Multilevel Discrete Wavelet Transform</a></li>
<li class="toctree-l2"><a class="reference internal" href="2d-decompositions-overview.html#fully-seperable-discrete-wavelet-transform">Fully Seperable Discrete Wavelet Transform</a></li>
<li class="toctree-l2"><a class="reference internal" href="2d-decompositions-overview.html#wavelet-packet-transform">Wavelet Packet Transform</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="2d-dwt-and-idwt.html">2D Forward and Inverse Discrete Wavelet Transform</a><ul>
<li class="toctree-l2"><a class="reference internal" href="2d-dwt-and-idwt.html#single-level-dwt2">Single level <code class="docutils literal notranslate"><span class="pre">dwt2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="2d-dwt-and-idwt.html#single-level-idwt2">Single level <code class="docutils literal notranslate"><span class="pre">idwt2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="2d-dwt-and-idwt.html#d-multilevel-decomposition-using-wavedec2">2D multilevel decomposition using <code class="docutils literal notranslate"><span class="pre">wavedec2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="2d-dwt-and-idwt.html#d-multilevel-reconstruction-using-waverec2">2D multilevel reconstruction using <code class="docutils literal notranslate"><span class="pre">waverec2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="2d-dwt-and-idwt.html#d-coordinate-conventions">2D coordinate conventions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nd-dwt-and-idwt.html">nD Forward and Inverse Discrete Wavelet Transform</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#single-level-dwtn">Single level - <code class="docutils literal notranslate"><span class="pre">dwtn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#single-level-idwtn">Single level - <code class="docutils literal notranslate"><span class="pre">idwtn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#multilevel-decomposition-wavedecn">Multilevel decomposition - <code class="docutils literal notranslate"><span class="pre">wavedecn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#multilevel-reconstruction-waverecn">Multilevel reconstruction - <code class="docutils literal notranslate"><span class="pre">waverecn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#multilevel-fully-separable-decomposition-fswavedecn">Multilevel fully separable decomposition - <code class="docutils literal notranslate"><span class="pre">fswavedecn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#multilevel-fully-separable-reconstruction-fswaverecn">Multilevel fully separable reconstruction - <code class="docutils literal notranslate"><span class="pre">fswaverecn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nd-dwt-and-idwt.html#multilevel-fully-separable-reconstruction-coeffs-fswavedecnresult">Multilevel fully separable reconstruction coeffs - <code class="docutils literal notranslate"><span class="pre">FswavedecnResult</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dwt-coefficient-handling.html">Handling DWT Coefficients</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dwt-coefficient-handling.html#concatenating-all-coefficients-into-a-single-n-d-array">Concatenating all coefficients into a single n-d array</a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-coefficient-handling.html#splitting-concatenated-coefficient-array-back-into-its-components">Splitting concatenated coefficient array back into its components</a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-coefficient-handling.html#raveling-and-unraveling-coefficients-to-from-a-1d-array">Raveling and unraveling coefficients to/from a 1D array</a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-coefficient-handling.html#multilevel-total-size-of-all-coefficients-wavedecn-size">Multilevel: Total size of all coefficients - <code class="docutils literal notranslate"><span class="pre">wavedecn_size</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="dwt-coefficient-handling.html#multilevel-n-d-coefficient-shapes-wavedecn-shapes">Multilevel: n-d coefficient shapes - <code class="docutils literal notranslate"><span class="pre">wavedecn_shapes</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="swt-stationary-wavelet-transform.html">Stationary Wavelet Transform</a><ul>
<li class="toctree-l2"><a class="reference internal" href="swt-stationary-wavelet-transform.html#multilevel-1d-swt">Multilevel 1D <code class="docutils literal notranslate"><span class="pre">swt</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="swt-stationary-wavelet-transform.html#multilevel-2d-swt2">Multilevel 2D <code class="docutils literal notranslate"><span class="pre">swt2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="swt-stationary-wavelet-transform.html#multilevel-n-dimensional-swtn">Multilevel n-dimensional <code class="docutils literal notranslate"><span class="pre">swtn</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="swt-stationary-wavelet-transform.html#maximum-decomposition-level-swt-max-level">Maximum decomposition level - <code class="docutils literal notranslate"><span class="pre">swt_max_level</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="iswt-inverse-stationary-wavelet-transform.html">Inverse Stationary Wavelet Transform</a><ul>
<li class="toctree-l2"><a class="reference internal" href="iswt-inverse-stationary-wavelet-transform.html#multilevel-1d-iswt">Multilevel 1D <code class="docutils literal notranslate"><span class="pre">iswt</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="iswt-inverse-stationary-wavelet-transform.html#multilevel-2d-iswt2">Multilevel 2D <code class="docutils literal notranslate"><span class="pre">iswt2</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="iswt-inverse-stationary-wavelet-transform.html#multilevel-n-dimensional-iswtn">Multilevel n-dimensional <code class="docutils literal notranslate"><span class="pre">iswtn</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="wavelet-packets.html">Wavelet Packets</a><ul>
<li class="toctree-l2"><a class="reference internal" href="wavelet-packets.html#basenode-a-common-interface-of-waveletpacket-and-waveletpacket2d">BaseNode - a common interface of WaveletPacket and WaveletPacket2D</a></li>
<li class="toctree-l2"><a class="reference internal" href="wavelet-packets.html#waveletpacket-and-waveletpacket-tree-node">WaveletPacket and WaveletPacket tree Node</a></li>
<li class="toctree-l2"><a class="reference internal" href="wavelet-packets.html#waveletpacket2d-and-waveletpacket2d-tree-node2d">WaveletPacket2D and WaveletPacket2D tree Node2D</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cwt.html">Continuous Wavelet Transform (CWT)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cwt.html#single-level-cwt">Single level - <code class="docutils literal notranslate"><span class="pre">cwt</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cwt.html#continuous-wavelet-families">Continuous Wavelet Families</a></li>
<li class="toctree-l2"><a class="reference internal" href="cwt.html#choosing-the-scales-for-cwt">Choosing the scales for <code class="docutils literal notranslate"><span class="pre">cwt</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="thresholding-functions.html">Thresholding functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="thresholding-functions.html#thresholding">Thresholding</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="other-functions.html">Other functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="other-functions.html#integrating-wavelet-functions">Integrating wavelet functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="other-functions.html#central-frequency-of-psi-wavelet-function">Central frequency of <code class="docutils literal notranslate"><span class="pre">psi</span></code> wavelet function</a></li>
<li class="toctree-l2"><a class="reference internal" href="other-functions.html#quadrature-mirror-filter">Quadrature Mirror Filter</a></li>
<li class="toctree-l2"><a class="reference internal" href="other-functions.html#orthogonal-filter-banks">Orthogonal Filter Banks</a></li>
<li class="toctree-l2"><a class="reference internal" href="other-functions.html#example-datasets">Example Datasets</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="../install.html"
title="previous chapter">Installing</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="wavelets.html"
title="next chapter">Wavelets</a></p><div>
<h3>Quick links</h3>
<ul>
<li><a href="https://github.com/PyWavelets/pywt"><img src="../_static/github.png" height="16" width="16" alt="" /> Fork on Github</a></li>
<li><a href="http://groups.google.com/group/pywavelets"><img src="../_static/comments.png" height="16" width="16" alt="" /> Discussion Group</a></li>
<li><a href="http://wavelets.pybytes.com/"><img src="../_static/wave.png" height="16" width="16" alt="" /> Explore Wavelets</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<div id="edit-instructions">
<h3>Edit this document</h3>
<p>
<a href="#" id="toggle-edit-info">
<img src="../_static/page_edit.png" height="16" width="16" alt="" />
The source code of this file is hosted on GitHub. Everyone can
update and fix errors in this document with few clicks -
no downloads needed.
</a>
</p>
<ol id="edit-info" style="display: none;">
<li>
Go to
<i><a href="https://github.com/PyWavelets/pywt/blob/master/doc/source/ref/index.rst" target="_blank">
API Reference
</a></i> on GitHub.
</li>
<li>
Press <b>Edit this file</b> button.
</li>
<li>
Edit file contents using GitHub's text editor in your web browser
</li>
<li>
Fill in the <b>Commit message</b> text box at the end of the page
telling <i>why</i> you did the changes.
Press <b>Propose file change</b> button next to it when done.
</li>
<li>
On <i>Send a pull request</i> page you don't need to fill in text
anymore. Just press <b>Send pull request</b> button.
</li>
<li>
Your changes are now queued for review under project's
<a href="https://github.com/PyWavelets/pywt/pulls" target="_blank">Pull requests</a> tab
on Github.
</li>
</ol>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="wavelets.html" title="Wavelets"
>next</a> |</li>
<li class="right" >
<a href="../install.html" title="Installing"
>previous</a> |</li>
<li><a href="../index.html">Home »</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2006-2019, The PyWavelets Developers.
Last updated on Jan 12, 2019.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
</div>
</body>
</html>
