Documentation updated

This commit is contained in:
fjosw 2023-03-09 15:33:57 +00:00
parent 6fbf4d30c4
commit a2dc5f38d0

View file

@ -466,11 +466,11 @@
</span><span id="L-358"><a href="#L-358"><span class="linenos">358</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">fit_result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
</span><span id="L-359"><a href="#L-359"><span class="linenos">359</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;The minimization procedure did not converge.&#39;</span><span class="p">)</span>
</span><span id="L-360"><a href="#L-360"><span class="linenos">360</span></a>
</span><span id="L-361"><a href="#L-361"><span class="linenos">361</span></a> <span class="k">if</span> <span class="n">x_all</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">n_parms</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
</span><span id="L-362"><a href="#L-362"><span class="linenos">362</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">=</span> <span class="n">chisquare</span>
</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a> <span class="n">output</span><span class="o">.</span><span class="n">dof</span> <span class="o">=</span> <span class="n">x_all</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">n_parms</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">loc_priors</span><span class="p">)</span>
</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare_by_dof</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">/</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span>
</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a> <span class="n">output</span><span class="o">.</span><span class="n">p_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">scipy</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">chi2</span><span class="o">.</span><span class="n">cdf</span><span class="p">(</span><span class="n">output</span><span class="o">.</span><span class="n">chisquare</span><span class="p">,</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span><span class="p">)</span>
</span><span id="L-361"><a href="#L-361"><span class="linenos">361</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">=</span> <span class="n">chisquare</span>
</span><span id="L-362"><a href="#L-362"><span class="linenos">362</span></a> <span class="n">output</span><span class="o">.</span><span class="n">dof</span> <span class="o">=</span> <span class="n">x_all</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">n_parms</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">loc_priors</span><span class="p">)</span>
</span><span id="L-363"><a href="#L-363"><span class="linenos">363</span></a> <span class="n">output</span><span class="o">.</span><span class="n">p_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">scipy</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">chi2</span><span class="o">.</span><span class="n">cdf</span><span class="p">(</span><span class="n">output</span><span class="o">.</span><span class="n">chisquare</span><span class="p">,</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span><span class="p">)</span>
</span><span id="L-364"><a href="#L-364"><span class="linenos">364</span></a> <span class="k">if</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
</span><span id="L-365"><a href="#L-365"><span class="linenos">365</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare_by_dof</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">/</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span>
</span><span id="L-366"><a href="#L-366"><span class="linenos">366</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="L-367"><a href="#L-367"><span class="linenos">367</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare_by_dof</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">&#39;nan&#39;</span><span class="p">)</span>
</span><span id="L-368"><a href="#L-368"><span class="linenos">368</span></a>
@ -1371,11 +1371,11 @@ Hotelling t-squared p-value for correlated fits.</li>
</span><span id="least_squares-359"><a href="#least_squares-359"><span class="linenos">359</span></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">fit_result</span><span class="o">.</span><span class="n">success</span><span class="p">:</span>
</span><span id="least_squares-360"><a href="#least_squares-360"><span class="linenos">360</span></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">&#39;The minimization procedure did not converge.&#39;</span><span class="p">)</span>
</span><span id="least_squares-361"><a href="#least_squares-361"><span class="linenos">361</span></a>
</span><span id="least_squares-362"><a href="#least_squares-362"><span class="linenos">362</span></a> <span class="k">if</span> <span class="n">x_all</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">n_parms</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
</span><span id="least_squares-363"><a href="#least_squares-363"><span class="linenos">363</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">=</span> <span class="n">chisquare</span>
</span><span id="least_squares-364"><a href="#least_squares-364"><span class="linenos">364</span></a> <span class="n">output</span><span class="o">.</span><span class="n">dof</span> <span class="o">=</span> <span class="n">x_all</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">n_parms</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">loc_priors</span><span class="p">)</span>
</span><span id="least_squares-365"><a href="#least_squares-365"><span class="linenos">365</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare_by_dof</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">/</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span>
</span><span id="least_squares-366"><a href="#least_squares-366"><span class="linenos">366</span></a> <span class="n">output</span><span class="o">.</span><span class="n">p_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">scipy</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">chi2</span><span class="o">.</span><span class="n">cdf</span><span class="p">(</span><span class="n">output</span><span class="o">.</span><span class="n">chisquare</span><span class="p">,</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span><span class="p">)</span>
</span><span id="least_squares-362"><a href="#least_squares-362"><span class="linenos">362</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">=</span> <span class="n">chisquare</span>
</span><span id="least_squares-363"><a href="#least_squares-363"><span class="linenos">363</span></a> <span class="n">output</span><span class="o">.</span><span class="n">dof</span> <span class="o">=</span> <span class="n">x_all</span><span class="o">.</span><span class="n">shape</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">n_parms</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">loc_priors</span><span class="p">)</span>
</span><span id="least_squares-364"><a href="#least_squares-364"><span class="linenos">364</span></a> <span class="n">output</span><span class="o">.</span><span class="n">p_value</span> <span class="o">=</span> <span class="mi">1</span> <span class="o">-</span> <span class="n">scipy</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">chi2</span><span class="o">.</span><span class="n">cdf</span><span class="p">(</span><span class="n">output</span><span class="o">.</span><span class="n">chisquare</span><span class="p">,</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span><span class="p">)</span>
</span><span id="least_squares-365"><a href="#least_squares-365"><span class="linenos">365</span></a> <span class="k">if</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
</span><span id="least_squares-366"><a href="#least_squares-366"><span class="linenos">366</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare_by_dof</span> <span class="o">=</span> <span class="n">output</span><span class="o">.</span><span class="n">chisquare</span> <span class="o">/</span> <span class="n">output</span><span class="o">.</span><span class="n">dof</span>
</span><span id="least_squares-367"><a href="#least_squares-367"><span class="linenos">367</span></a> <span class="k">else</span><span class="p">:</span>
</span><span id="least_squares-368"><a href="#least_squares-368"><span class="linenos">368</span></a> <span class="n">output</span><span class="o">.</span><span class="n">chisquare_by_dof</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="s1">&#39;nan&#39;</span><span class="p">)</span>
</span><span id="least_squares-369"><a href="#least_squares-369"><span class="linenos">369</span></a>