Skip to content
Snippets Groups Projects
Commit 87bcd94b authored by Harry Jeffery's avatar Harry Jeffery
Browse files

Refs #11680 Fix dead links in IndexSXPeaks-v1.rst

parent 6bed809b
No related branches found
No related tags found
No related merge requests found
......@@ -9,19 +9,18 @@
Description
-----------
Given a `PeaksWorkspace <http://www.mantidproject.org/PeaksWorkspace>`_ and a set of
lattice parameters, attempts to tag each peak with a HKL value by comparing
d-spacings between potential HKL matches and the peaks as well as angles between Q
vectors.
Given a :ref:`PeaksWorkspace <PeaksWorkspace>` and a set of lattice parameters,
attempts to tag each peak with a HKL value by comparing d-spacings between
potential HKL matches and the peaks as well as angles between Q vectors.
Usage Notes
-----------
This algorithm does not generate a UB Matrix, it will only index peaks.
Run :ref:`CalculateUMatrix <algm-CalculateUMatrix>`
algorithm after executing this algorithm in order
to attach a UB Matrix onto the sample. The :ref:`CopySample <algm-CopySample>`
algorithm will allow this UB Matrix to be transfered between workspaces.
Run :ref:`CalculateUMatrix <algm-CalculateUMatrix>` algorithm after executing
this algorithm in order to attach a UB Matrix onto the sample. The
:ref:`CopySample <algm-CopySample>` algorithm will allow this UB Matrix to be
transfered between workspaces.
Usage
-----
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment