htdocs update (master)

Author: DiamondLightSource-build-server

documentation/library_reference/algorithms/dials.algorithms.symmetry.html

@@ -827,7 +827,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="dials.algorithms.symmetry.cosym.target.Target.compute_functional">
-<span class="sig-name descname"><span class="pre">compute_functional</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_functional"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_functional" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">compute_functional</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_functional"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_functional" title="Link to this definition">¶</a></dt>
 <dd><p>Compute the target function at coordinates <cite>x</cite>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -846,12 +846,12 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="dials.algorithms.symmetry.cosym.target.Target.compute_functional_score_for_dimension_assessment">
-<span class="sig-name descname"><span class="pre">compute_functional_score_for_dimension_assessment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">outlier_rejection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_functional_score_for_dimension_assessment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_functional_score_for_dimension_assessment" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">compute_functional_score_for_dimension_assessment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">outlier_rejection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.13)"><span class="pre">float</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_functional_score_for_dimension_assessment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_functional_score_for_dimension_assessment" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="dials.algorithms.symmetry.cosym.target.Target.compute_gradients">
-<span class="sig-name descname"><span class="pre">compute_gradients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_gradients"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_gradients" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">compute_gradients</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_gradients"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_gradients" title="Link to this definition">¶</a></dt>
 <dd><p>Compute the gradients of the target function at coordinates <cite>x</cite>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -871,7 +871,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="dials.algorithms.symmetry.cosym.target.Target.compute_gradients_fd">
-<span class="sig-name descname"><span class="pre">compute_gradients_fd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-06</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_gradients_fd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_gradients_fd" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">compute_gradients_fd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-06</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.compute_gradients_fd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.compute_gradients_fd" title="Link to this definition">¶</a></dt>
 <dd><p>Compute the gradients at coordinates <cite>x</cite> using finite differences.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -893,7 +893,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="dials.algorithms.symmetry.cosym.target.Target.curvatures">
-<span class="sig-name descname"><span class="pre">curvatures</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.curvatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.curvatures" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">curvatures</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.curvatures"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.curvatures" title="Link to this definition">¶</a></dt>
 <dd><p>Compute the curvature of the target function at coordinates <cite>x</cite>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -912,7 +912,7 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="dials.algorithms.symmetry.cosym.target.Target.curvatures_fd">
-<span class="sig-name descname"><span class="pre">curvatures_fd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-06</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.1)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.curvatures_fd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.curvatures_fd" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">curvatures_fd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">eps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-06</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.2)"><span class="pre">ndarray</span></a></span></span><a class="reference internal" href="../../../_modules/dials/algorithms/symmetry/cosym/target.html#Target.curvatures_fd"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#dials.algorithms.symmetry.cosym.target.Target.curvatures_fd" title="Link to this definition">¶</a></dt>
 <dd><p>Compute the curvatures at coordinates <cite>x</cite> using finite differences.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>