Upload documentation from latest commit

api/autoapi/reciprocalspaceship.algorithms.scale_merged_intensities.html

@@ -102,7 +102,7 @@
 <h1>reciprocalspaceship.algorithms.scale_merged_intensities<a class="headerlink" href="#reciprocalspaceship-algorithms-scale-merged-intensities" title="Link to this heading"></a></h1>
 <dl class="py function">
 <dt class="sig sig-object py" id="reciprocalspaceship.algorithms.scale_merged_intensities">
-<span class="sig-prename descclassname"><span class="pre">reciprocalspaceship.algorithms.</span></span><span class="sig-name descname"><span class="pre">scale_merged_intensities</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sigma_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_columns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dropna</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inplace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean_intensity_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'isotropic'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bw</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/rs-station/reciprocalspaceship/blob/main/reciprocalspaceship/algorithms/scale_merged_intensities.py#L178-L310"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#reciprocalspaceship.algorithms.scale_merged_intensities" title="Link to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">reciprocalspaceship.algorithms.</span></span><span class="sig-name descname"><span class="pre">scale_merged_intensities</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ds</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intensity_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sigma_key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_columns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dropna</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inplace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean_intensity_method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'isotropic'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bw</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimum_sigma</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-inf</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/rs-station/reciprocalspaceship/blob/main/reciprocalspaceship/algorithms/scale_merged_intensities.py#L178-L311"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#reciprocalspaceship.algorithms.scale_merged_intensities" title="Link to this definition"></a></dt>
 <dd><p>Scales merged intensities using Bayesian statistics in order to
 estimate structure factor amplitudes. This method is based on the approach
 by French and Wilson <a class="footnote-reference brackets" href="#id2" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a>, and is useful for improving the estimates
@@ -145,6 +145,7 @@ <h1>reciprocalspaceship.algorithms.scale_merged_intensities<a class="headerlink"
 parameter controls the distance that each reflection impacts in
 reciprocal space. Only affects output if mean_intensity_method is
 “anisotropic”.</p></li>
+<li><p><strong>minimum_sigma</strong> (<em>float</em>) – Minimum value imposed on Sigma (default: -np.inf, that is: no minimum).</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>