deploy: ebdec3d

Author: stefmolin

dev/_modules/data_morph/data/stats.html

@@ -518,41 +518,67 @@
   <h1>Source code for data_morph.data.stats</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Utility functions for calculating summary statistics.&quot;&quot;&quot;</span>
 
-<span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">namedtuple</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
 
-<span class="kn">import</span><span class="w"> </span><span class="nn">pandas</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pd</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">NamedTuple</span>
+
+<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
+    <span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Generator</span>
+
+    <span class="kn">import</span><span class="w"> </span><span class="nn">pandas</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">pd</span>
+
+
+<div class="viewcode-block" id="SummaryStatistics">
+<a class="viewcode-back" href="../../../api/data_morph.data.stats.SummaryStatistics.html#data_morph.data.stats.SummaryStatistics">[docs]</a>
+<span class="k">class</span><span class="w"> </span><span class="nc">SummaryStatistics</span><span class="p">(</span><span class="n">NamedTuple</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;Named tuple containing the summary statistics for plotting/analysis.&quot;&quot;&quot;</span>
+
+    <span class="n">x_mean</span><span class="p">:</span> <span class="nb">float</span>
+    <span class="n">y_mean</span><span class="p">:</span> <span class="nb">float</span>
+
+    <span class="n">x_stdev</span><span class="p">:</span> <span class="nb">float</span>
+    <span class="n">y_stdev</span><span class="p">:</span> <span class="nb">float</span>
+
+    <span class="n">correlation</span><span class="p">:</span> <span class="nb">float</span>
+
+    <span class="n">x_median</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span>
+    <span class="n">y_median</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span>
+
+    <span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Generator</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">]:</span>
+        <span class="k">for</span> <span class="n">statistic</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_fields</span><span class="p">:</span>
+            <span class="k">if</span> <span class="p">(</span><span class="n">value</span> <span class="o">:=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">statistic</span><span class="p">))</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+                <span class="k">yield</span> <span class="n">value</span></div>
 
-<span class="n">SummaryStatistics</span> <span class="o">=</span> <span class="n">namedtuple</span><span class="p">(</span>
-    <span class="s1">&#39;SummaryStatistics&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s1">&#39;x_mean&#39;</span><span class="p">,</span> <span class="s1">&#39;y_mean&#39;</span><span class="p">,</span> <span class="s1">&#39;x_stdev&#39;</span><span class="p">,</span> <span class="s1">&#39;y_stdev&#39;</span><span class="p">,</span> <span class="s1">&#39;correlation&#39;</span><span class="p">]</span>
-<span class="p">)</span>
-<span class="n">SummaryStatistics</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s1">&#39;Named tuple containing the summary statistics for plotting/analysis.&#39;</span>
-<span class="p">)</span>
 
 
 <div class="viewcode-block" id="get_summary_statistics">
 <a class="viewcode-back" href="../../../api/data_morph.data.stats.get_summary_statistics.html#data_morph.data.stats.get_summary_statistics">[docs]</a>
-<span class="k">def</span><span class="w"> </span><span class="nf">get_summary_statistics</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SummaryStatistics</span><span class="p">:</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">get_summary_statistics</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">,</span> <span class="n">with_median</span><span class="p">:</span> <span class="nb">bool</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">SummaryStatistics</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Calculate the summary statistics for the given set of points.</span>
 
 <span class="sd">    Parameters</span>
 <span class="sd">    ----------</span>
 <span class="sd">    data : pandas.DataFrame</span>
-<span class="sd">        A dataset with columns x and y.</span>
+<span class="sd">        A dataset with columns ``x`` and ``y``.</span>
+<span class="sd">    with_median : bool</span>
+<span class="sd">        Whether to include the median of ``x`` and ``y``.</span>
 
 <span class="sd">    Returns</span>
 <span class="sd">    -------</span>
 <span class="sd">    SummaryStatistics</span>
-<span class="sd">        Named tuple consisting of mean and standard deviations of x and y,</span>
-<span class="sd">        along with the Pearson correlation coefficient between the two.</span>
+<span class="sd">        Named tuple consisting of mean and standard deviations of ``x`` and ``y``,</span>
+<span class="sd">        along with the Pearson correlation coefficient between the two, and optionally,</span>
+<span class="sd">        the median of ``x`` and ``y``.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="n">SummaryStatistics</span><span class="p">(</span>
-        <span class="n">data</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">mean</span><span class="p">(),</span>
-        <span class="n">data</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">mean</span><span class="p">(),</span>
-        <span class="n">data</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">std</span><span class="p">(),</span>
-        <span class="n">data</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">std</span><span class="p">(),</span>
-        <span class="n">data</span><span class="o">.</span><span class="n">corr</span><span class="p">()</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="p">,</span>
+        <span class="n">x_mean</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">mean</span><span class="p">(),</span>
+        <span class="n">y_mean</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">mean</span><span class="p">(),</span>
+        <span class="n">x_stdev</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">std</span><span class="p">(),</span>
+        <span class="n">y_stdev</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">std</span><span class="p">(),</span>
+        <span class="n">correlation</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">corr</span><span class="p">()</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">y</span><span class="p">,</span>
+        <span class="n">x_median</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">x</span><span class="o">.</span><span class="n">median</span><span class="p">()</span> <span class="k">if</span> <span class="n">with_median</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
+        <span class="n">y_median</span><span class="o">=</span><span class="n">data</span><span class="o">.</span><span class="n">y</span><span class="o">.</span><span class="n">median</span><span class="p">()</span> <span class="k">if</span> <span class="n">with_median</span> <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
     <span class="p">)</span></div>
 
 </pre></div>

dev/_modules/data_morph/morpher.html

@@ -580,6 +580,9 @@ <h1>Source code for data_morph.morpher</h1><div class="highlight"><pre>
 <span class="sd">    forward_only_animation : bool, default ``False``</span>
 <span class="sd">        Whether to generate the animation in the forward direction only.</span>
 <span class="sd">        By default, the animation will play forward and then reverse.</span>
+<span class="sd">    with_median : bool, default ``False``</span>
+<span class="sd">        Whether to preserve the median in addition to the other summary statistics.</span>
+<span class="sd">        Note that this will be a little slower.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
@@ -594,6 +597,7 @@ <h1>Source code for data_morph.morpher</h1><div class="highlight"><pre>
         <span class="n">num_frames</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">100</span><span class="p">,</span>
         <span class="n">keep_frames</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
         <span class="n">forward_only_animation</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
+        <span class="n">with_median</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_rng</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">default_rng</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
 
@@ -649,6 +653,8 @@ <h1>Source code for data_morph.morpher</h1><div class="highlight"><pre>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_ProgressTracker</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">DataMorphProgress</span><span class="p">,</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_in_notebook</span><span class="p">)</span>
 
+        <span class="bp">self</span><span class="o">.</span><span class="n">_with_median</span> <span class="o">=</span> <span class="n">with_median</span>
+
     <span class="k">def</span><span class="w"> </span><span class="nf">_select_frames</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span> <span class="n">iterations</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">ease_in</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">ease_out</span><span class="p">:</span> <span class="nb">bool</span><span class="p">,</span> <span class="n">freeze_for</span><span class="p">:</span> <span class="nb">int</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">:</span>
@@ -742,6 +748,7 @@ <h1>Source code for data_morph.morpher</h1><div class="highlight"><pre>
                 <span class="n">decimals</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">decimals</span><span class="p">,</span>
                 <span class="n">x_bounds</span><span class="o">=</span><span class="n">bounds</span><span class="o">.</span><span class="n">x_bounds</span><span class="p">,</span>
                 <span class="n">y_bounds</span><span class="o">=</span><span class="n">bounds</span><span class="o">.</span><span class="n">y_bounds</span><span class="p">,</span>
+                <span class="n">with_median</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_with_median</span><span class="p">,</span>
                 <span class="n">dpi</span><span class="o">=</span><span class="mi">150</span><span class="p">,</span>
             <span class="p">)</span>
         <span class="k">if</span> <span class="p">(</span>
@@ -773,7 +780,12 @@ <h1>Source code for data_morph.morpher</h1><div class="highlight"><pre>
                 <span class="n">np</span><span class="o">.</span><span class="n">subtract</span><span class="p">(</span>
                     <span class="o">*</span><span class="p">(</span>
                         <span class="n">np</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span>
-                            <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">get_summary_statistics</span><span class="p">(</span><span class="n">data</span><span class="p">))</span> <span class="o">*</span> <span class="mi">10</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">decimals</span>
+                            <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span>
+                                <span class="n">get_summary_statistics</span><span class="p">(</span>
+                                    <span class="n">data</span><span class="p">,</span> <span class="n">with_median</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_with_median</span>
+                                <span class="p">)</span>
+                            <span class="p">)</span>
+                            <span class="o">*</span> <span class="mi">10</span><span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">decimals</span>
                         <span class="p">)</span>
                         <span class="k">for</span> <span class="n">data</span> <span class="ow">in</span> <span class="p">[</span><span class="n">df1</span><span class="p">,</span> <span class="n">df2</span><span class="p">]</span>
                     <span class="p">)</span>