API documentation

meinardmueller · Apr 23, 2021 · f75d3ca · f75d3ca
1 parent f87d4f9
commit f75d3ca
Show file tree

Hide file tree

Showing 184 changed files with 51,540 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@
 build/
 dist/
 libfmp.egg-info/
+
+# do not ignore build of docs
+!docs/build/
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/.gitkeep b/docs/build/.gitkeep
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/genindex.doctree b/docs/build/doctrees/genindex.doctree
diff --git a/docs/build/doctrees/getting_started.doctree b/docs/build/doctrees/getting_started.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/index_b.doctree b/docs/build/doctrees/index_b.doctree
diff --git a/docs/build/doctrees/index_c1.doctree b/docs/build/doctrees/index_c1.doctree
diff --git a/docs/build/doctrees/index_c2.doctree b/docs/build/doctrees/index_c2.doctree
diff --git a/docs/build/doctrees/index_c3.doctree b/docs/build/doctrees/index_c3.doctree
diff --git a/docs/build/doctrees/index_c4.doctree b/docs/build/doctrees/index_c4.doctree
diff --git a/docs/build/doctrees/index_c5.doctree b/docs/build/doctrees/index_c5.doctree
diff --git a/docs/build/doctrees/index_c6.doctree b/docs/build/doctrees/index_c6.doctree
diff --git a/docs/build/doctrees/index_c7.doctree b/docs/build/doctrees/index_c7.doctree
diff --git a/docs/build/doctrees/index_c8.doctree b/docs/build/doctrees/index_c8.doctree
diff --git a/docs/build/doctrees/py-modindex.doctree b/docs/build/doctrees/py-modindex.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ae132c943bae29b527a4e49860516f8c
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -0,0 +1,266 @@
+
+
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+  <title>Overview: module code &mdash; libfmp 1.1.1 documentation</title>
+
+
+
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+
+
+
+
+
+
+
+
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+
+      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+        <script src="../_static/jquery.js"></script>
+        <script src="../_static/underscore.js"></script>
+        <script src="../_static/doctools.js"></script>
+
+    <script type="text/javascript" src="../_static/js/theme.js"></script>
+
+
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav">
+
+
+  <div class="wy-grid-for-nav">
+
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+            <a href="../index.html">
+
+
+
+
+            <img src="../_static/Logo_libfmp.png" class="logo" alt="Logo"/>
+
+          </a>
+
+
+
+
+              <div class="version">
+                1.1.1
+              </div>
+
+
+
+
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+
+
+        </div>
+
+
+        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
+
+
+
+
+
+
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
+</ul>
+<p class="caption"><span class="caption-text">API Documentation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../index_b.html">Basics (libfmp.b)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c1.html">Music Representations (libfmp.c1)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c2.html">Fourier Analysis of Signals (libfmp.c2)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c3.html">Music Synchronization (libfmp.c3)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c4.html">Music Structure Analysis (libfmp.c4)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c5.html">Chord Recognition (libfmp.c5)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c6.html">Tempo and Beat Tracking (libfmp.c6)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c7.html">Content-Based Audio Retrieval (libfmp.c7)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_c8.html">Musically Informed Audio Decomposition (libfmp.c8)</a></li>
+</ul>
+<p class="caption"><span class="caption-text">Reference</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../py-modindex.html">Module Index</a></li>
+</ul>
+
+
+
+        </div>
+
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+      <nav class="wy-nav-top" aria-label="top navigation">
+
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">libfmp</a>
+
+      </nav>
+
+
+      <div class="wy-nav-content">
+
+        <div class="rst-content">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<div role="navigation" aria-label="breadcrumbs navigation">
+
+  <ul class="wy-breadcrumbs">
+
+      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
+
+      <li>Overview: module code</li>
+
+
+      <li class="wy-breadcrumbs-aside">
+
+      </li>
+
+  </ul>
+
+
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="libfmp/b/b_annotation.html">libfmp.b.b_annotation</a></li>
+<li><a href="libfmp/b/b_audio.html">libfmp.b.b_audio</a></li>
+<li><a href="libfmp/b/b_layout.html">libfmp.b.b_layout</a></li>
+<li><a href="libfmp/b/b_plot.html">libfmp.b.b_plot</a></li>
+<li><a href="libfmp/b/b_sonification.html">libfmp.b.b_sonification</a></li>
+<li><a href="libfmp/b/b_test_module.html">libfmp.b.b_test_module</a></li>
+<li><a href="libfmp/c1/c1s1_sheet_music.html">libfmp.c1.c1s1_sheet_music</a></li>
+<li><a href="libfmp/c1/c1s2_symbolic_rep.html">libfmp.c1.c1s2_symbolic_rep</a></li>
+<li><a href="libfmp/c1/c1s3_audio_rep.html">libfmp.c1.c1s3_audio_rep</a></li>
+<li><a href="libfmp/c2/c2_complex.html">libfmp.c2.c2_complex</a></li>
+<li><a href="libfmp/c2/c2_digitization.html">libfmp.c2.c2_digitization</a></li>
+<li><a href="libfmp/c2/c2_fourier.html">libfmp.c2.c2_fourier</a></li>
+<li><a href="libfmp/c2/c2_interference.html">libfmp.c2.c2_interference</a></li>
+<li><a href="libfmp/c2/c2_interpolation.html">libfmp.c2.c2_interpolation</a></li>
+<li><a href="libfmp/c3/c3s1_audio_feature.html">libfmp.c3.c3s1_audio_feature</a></li>
+<li><a href="libfmp/c3/c3s1_post_processing.html">libfmp.c3.c3s1_post_processing</a></li>
+<li><a href="libfmp/c3/c3s1_transposition_tuning.html">libfmp.c3.c3s1_transposition_tuning</a></li>
+<li><a href="libfmp/c3/c3s2_dtw.html">libfmp.c3.c3s2_dtw</a></li>
+<li><a href="libfmp/c3/c3s2_dtw_plot.html">libfmp.c3.c3s2_dtw_plot</a></li>
+<li><a href="libfmp/c3/c3s3_tempo_curve.html">libfmp.c3.c3s3_tempo_curve</a></li>
+<li><a href="libfmp/c4/c4s1_annotation.html">libfmp.c4.c4s1_annotation</a></li>
+<li><a href="libfmp/c4/c4s2_ssm.html">libfmp.c4.c4s2_ssm</a></li>
+<li><a href="libfmp/c4/c4s2_synthetic_ssm.html">libfmp.c4.c4s2_synthetic_ssm</a></li>
+<li><a href="libfmp/c4/c4s2_threshold.html">libfmp.c4.c4s2_threshold</a></li>
+<li><a href="libfmp/c4/c4s3_thumbnail.html">libfmp.c4.c4s3_thumbnail</a></li>
+<li><a href="libfmp/c4/c4s4_novelty_kernel.html">libfmp.c4.c4s4_novelty_kernel</a></li>
+<li><a href="libfmp/c4/c4s4_structure_feature.html">libfmp.c4.c4s4_structure_feature</a></li>
+<li><a href="libfmp/c4/c4s5_evaluation.html">libfmp.c4.c4s5_evaluation</a></li>
+<li><a href="libfmp/c5/c5s1_basic_theory_harmony.html">libfmp.c5.c5s1_basic_theory_harmony</a></li>
+<li><a href="libfmp/c5/c5s2_chord_rec_template.html">libfmp.c5.c5s2_chord_rec_template</a></li>
+<li><a href="libfmp/c5/c5s3_chord_rec_hmm.html">libfmp.c5.c5s3_chord_rec_hmm</a></li>
+<li><a href="libfmp/c6/c6s1_onset_detection.html">libfmp.c6.c6s1_onset_detection</a></li>
+<li><a href="libfmp/c6/c6s1_peak_picking.html">libfmp.c6.c6s1_peak_picking</a></li>
+<li><a href="libfmp/c6/c6s2_tempo_analysis.html">libfmp.c6.c6s2_tempo_analysis</a></li>
+<li><a href="libfmp/c6/c6s3_adaptive_windowing.html">libfmp.c6.c6s3_adaptive_windowing</a></li>
+<li><a href="libfmp/c6/c6s3_beat_tracking.html">libfmp.c6.c6s3_beat_tracking</a></li>
+<li><a href="libfmp/c7/c7s1_audio_id.html">libfmp.c7.c7s1_audio_id</a></li>
+<li><a href="libfmp/c7/c7s2_audio_matching.html">libfmp.c7.c7s2_audio_matching</a></li>
+<li><a href="libfmp/c7/c7s3_version_id.html">libfmp.c7.c7s3_version_id</a></li>
+<li><a href="libfmp/c8/c8s1_hps.html">libfmp.c8.c8s1_hps</a></li>
+<li><a href="libfmp/c8/c8s2_f0.html">libfmp.c8.c8s2_f0</a></li>
+<li><a href="libfmp/c8/c8s2_salience.html">libfmp.c8.c8s2_salience</a></li>
+<li><a href="libfmp/c8/c8s3_nmf.html">libfmp.c8.c8s3_nmf</a></li>
+</ul>
+
+           </div>
+
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>
+        &#169; Copyright 2021, Meinard Müller and Frank Zalkow.
+
+    </p>
+  </div>
+
+
+
+    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+
+    provided by <a href="https://readthedocs.org">Read the Docs</a>. 
+
+</footer>
+        </div>
+      </div>
+
+    </section>
+
+  </div>
+
+
+  <script type="text/javascript">
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script>
+
+
+
+
+
+
+</body>
+</html>