docs(ver): update documentation

hahnec · Dec 22, 2020 · bb2b63d · bb2b63d
1 parent 0a75820
commit bb2b63d
Show file tree

Hide file tree

Showing 11 changed files with 86 additions and 30 deletions.
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +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: b2de788a799a4014cbdc523d075e90d2
+config: bb9f2ef75feb7f4d789f5869d799261a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.3.3',
+    VERSION: '0.3.4',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/build/html/apidoc.html b/docs/build/html/apidoc.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>API documentation &#8212; color-matcher 0.3.3 documentation</title>
+    <title>API documentation &#8212; color-matcher 0.3.4 documentation</title>
     <link rel="stylesheet" href="_static/sphinxdoc.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>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="readme.html" title="color-matcher"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -155,7 +155,7 @@ <h2>Class hierarchy<a class="headerlink" href="#class-hierarchy" title="Permalin
 <dl class="method">
 <dt id="color_matcher.TransferMVGD.analytical_solver">
 <code class="descname">analytical_solver</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; numpy.ndarray<a class="headerlink" href="#color_matcher.TransferMVGD.analytical_solver" title="Permalink to this definition">¶</a></dt>
-<dd><p>An analytical solution to the linear equation system of MVGDs.</p>
+<dd><p>An analytical solution to the linear equation system of Multi-Variate Gaussian Distributions (MVGDs).</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns</dt>
 <dd class="field-odd"><p><strong>transfer_mat</strong>: Transfer matrix</p>
@@ -202,6 +202,28 @@ <h2>Class hierarchy<a class="headerlink" href="#class-hierarchy" title="Permalin
 </dl>
 </dd></dl>
 
+<dl class="staticmethod">
+<dt id="color_matcher.TransferMVGD.w2_dist">
+<em class="property">static </em><code class="descname">w2_dist</code><span class="sig-paren">(</span><em>mu_a: numpy.ndarray</em>, <em>mu_b: numpy.ndarray</em>, <em>cov_a: numpy.ndarray</em>, <em>cov_b: numpy.ndarray</em><span class="sig-paren">)</span> &#x2192; float<a class="headerlink" href="#color_matcher.TransferMVGD.w2_dist" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wasserstein-2 distance metric is a similarity measure for Gaussian distributions</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>mu_a</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Gaussian mean of distribution <em>a</em></p></li>
+<li><p><strong>mu_b</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Gaussian mean of distribution <em>b</em></p></li>
+<li><p><strong>cov_a</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Covariance matrix of distribution <em>a</em></p></li>
+<li><p><strong>cov_b</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Covariance matrix of distribution <em>b</em></p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p><strong>scalar</strong>: Wasserstein-2 metric as a scalar</p>
+</dd>
+<dt class="field-odd">Return type</dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)">float</a></p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 <dl class="class">
@@ -223,11 +245,11 @@ <h2>Class hierarchy<a class="headerlink" href="#class-hierarchy" title="Permalin
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>src</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Source image that requires transfer</p></li>
 <li><p><strong>ref</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Palette image which serves as reference</p></li>
-<li><p><strong>ref</strong> – Resulting image after the mapping</p></li>
+<li><p><strong>res</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Resulting image after the mapping</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
-<dd class="field-even"><p><strong>result</strong></p>
+<dd class="field-even"><p><strong>res</strong></p>
 </dd>
 <dt class="field-odd">Return type</dt>
 <dd class="field-odd"><p>np.ndarray</p>
@@ -281,7 +303,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="readme.html" title="color-matcher"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/build/html/color_matcher.html b/docs/build/html/color_matcher.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>color_matcher package &#8212; color-matcher 0.3.3 documentation</title>
+    <title>color_matcher package &#8212; color-matcher 0.3.4 documentation</title>
     <link rel="stylesheet" href="_static/sphinxdoc.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>
@@ -24,7 +24,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -177,7 +177,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <dl class="method">
 <dt id="color_matcher.mvgd_matcher.TransferMVGD.analytical_solver">
 <code class="descname">analytical_solver</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; numpy.ndarray<a class="headerlink" href="#color_matcher.mvgd_matcher.TransferMVGD.analytical_solver" title="Permalink to this definition">¶</a></dt>
-<dd><p>An analytical solution to the linear equation system of MVGDs.</p>
+<dd><p>An analytical solution to the linear equation system of Multi-Variate Gaussian Distributions (MVGDs).</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns</dt>
 <dd class="field-odd"><p><strong>transfer_mat</strong>: Transfer matrix</p>
@@ -224,6 +224,28 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </dl>
 </dd></dl>
 
+<dl class="staticmethod">
+<dt id="color_matcher.mvgd_matcher.TransferMVGD.w2_dist">
+<em class="property">static </em><code class="descname">w2_dist</code><span class="sig-paren">(</span><em>mu_a: numpy.ndarray</em>, <em>mu_b: numpy.ndarray</em>, <em>cov_a: numpy.ndarray</em>, <em>cov_b: numpy.ndarray</em><span class="sig-paren">)</span> &#x2192; float<a class="headerlink" href="#color_matcher.mvgd_matcher.TransferMVGD.w2_dist" title="Permalink to this definition">¶</a></dt>
+<dd><p>Wasserstein-2 distance metric is a similarity measure for Gaussian distributions</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters</dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>mu_a</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Gaussian mean of distribution <em>a</em></p></li>
+<li><p><strong>mu_b</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Gaussian mean of distribution <em>b</em></p></li>
+<li><p><strong>cov_a</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Covariance matrix of distribution <em>a</em></p></li>
+<li><p><strong>cov_b</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.19)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – Covariance matrix of distribution <em>b</em></p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p><strong>scalar</strong>: Wasserstein-2 metric as a scalar</p>
+</dd>
+<dt class="field-odd">Return type</dt>
+<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.9)">float</a></p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 </div>
@@ -318,7 +340,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -5,7 +5,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>Index &#8212; color-matcher 0.3.3 documentation</title>
+    <title>Index &#8212; color-matcher 0.3.4 documentation</title>
     <link rel="stylesheet" href="_static/sphinxdoc.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>
@@ -25,7 +25,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -64,6 +64,7 @@ <h1 id="index">Index</h1>
  | <a href="#T"><strong>T</strong></a>
  | <a href="#U"><strong>U</strong></a>
  | <a href="#V"><strong>V</strong></a>
+ | <a href="#W"><strong>W</strong></a>
 
 </div>
 <h2 id="_">_</h2>
@@ -280,6 +281,18 @@ <h2 id="V">V</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="color_matcher.html#color_matcher.mvgd_matcher.TransferMVGD.w2_dist">w2_dist() (color_matcher.mvgd_matcher.TransferMVGD static method)</a>
+
+      <ul>
+        <li><a href="apidoc.html#color_matcher.TransferMVGD.w2_dist">(color_matcher.TransferMVGD static method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
 
 
           </div>
@@ -296,7 +309,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>color-matcher reference document &#8212; color-matcher 0.3.3 documentation</title>
+    <title>color-matcher reference document &#8212; color-matcher 0.3.4 documentation</title>
     <link rel="stylesheet" href="_static/sphinxdoc.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>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="readme.html" title="color-matcher"
              accesskey="N">next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -101,7 +101,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="readme.html" title="color-matcher"
              >next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
@@ -2,5 +2,4 @@
 # Project: color-matcher
 # Version: 
 # The remainder of this file is compressed using zlib.
-xڭ�K�� ����ګ��Z����CV������F���6���!;�������������	��h�j� 5�f2ڵ�K'Ż`��g��o�Ҷ6g`mv�Ař�A|[�&�+��ǀ��,N/���wn�.��/�s"�b��#X#(�g�B�<�K�9\1��C���.B� ����âs{!��Y.�Ў@�2��������c���Ӄ�s�� V��Pf��k*���U�N���l���R*�m�~p_N���]Ӆܬ��!M��pG��$2פ�D�'<#�B�gt�=�����k��B���P u���2h-�-��⪘ÔM��Wo2Z�Ùp$2o���"�:x~Lb*m��v��|F��z��R�;�k{��K�ܮBҚ��\����#�g�������q"�>����J^=�F`�r�Y��߼w]�>=?f�QKT���wޕ]��]Y�
-\�9ÿ{���/?��c�wuv���g�G�A_4PQ<E��pS��!p6a-��I�z=.W���@�������N�?��
+xڭ�M�� ����ګ�nU���+�{H�j�^�,Ll�|X��M}qȇ�ة1>%0��f`�j���h�&�v�R�Z`�.�]˺tR�	��m����/mks�P�fwT�iķUkB�⎐}�J������~������R9'�+F�;�5�r�!��s�TΙ���8$a-�"4.¸���@�J0,zm/�s>�%���_�ݢ����0=��jN�==(;�)b�hG��|I%�Cc����O�Z�u��4���V�N���N Ơ��:����~psO��Ō�Յ�,	�!M,pGJ�$2פ�D�'<#�Bۯ�{�nkE�*>���c�@�!�Ue�ZR[4��⪘ÔM����-��L($����%>Rp��E(�9^�&��6���X�Ѣ�g���8ü���m���*$�i)`͕���8��L��ؠ��'���..�	���pn}�u���{�����c��D��I��λ�k~�+���@��}�`�g/����ˏ�A���]��|tF����m�#�(��]��pS��!p6!�C��$v=���+�`�%�G}a��`j����&

diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>Python Module Index &#8212; color-matcher 0.3.3 documentation</title>
+    <title>Python Module Index &#8212; color-matcher 0.3.4 documentation</title>
     <link rel="stylesheet" href="_static/sphinxdoc.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>
@@ -27,7 +27,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -120,7 +120,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/build/html/readme.html b/docs/build/html/readme.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>color-matcher &#8212; color-matcher 0.3.3 documentation</title>
+    <title>color-matcher &#8212; color-matcher 0.3.4 documentation</title>
     <link rel="stylesheet" href="_static/sphinxdoc.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>
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="color-matcher reference document"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
@@ -216,7 +216,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="color-matcher reference document"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.3 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">color-matcher 0.3.4 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">