Skip to content
Snippets Groups Projects
Commit 1d9dbb34 authored by Michael Wedel's avatar Michael Wedel
Browse files

Refs #14121. Fixing documentation

parent 612d8d1a
No related branches found
No related tags found
No related merge requests found
......@@ -51,7 +51,7 @@ For the usage example there is a calculated, theoretical diffraction pattern (in
# Run the actual fit with lattice parameters that are slightly off
si_fitted, si_cell, si_params, chi_square = PawleyFit(si_spectrum,
CrystalSystem='Cubic',
LatticeSystem='Cubic',
InitialCell='5.436 5.436 5.436',
PeakTable=si_peaks_indexed)
......
......@@ -14,7 +14,7 @@ been used to assign indices. LatticeFunction can be used to achieve that task wi
work with a PeaksWorkspace or with a TableWorkspace that contains two columns named `HKL` and `d` (see
:ref:`algm-PawleyFit` for specification of the table).
After setting the `CrystalSystem` attribute to one of the seven crystal systems, the function exposes the
After setting the `LatticeSystem` attribute to one of the seven lattice systems, the function exposes the
corresponding lattice parameters, as well as a `ZeroShift`. In most cases it's recommended to fix this additional
parameter as this is often taken care of in earlier steps of the data reduction.
......@@ -38,7 +38,7 @@ used to generate Bragg reflections that are expected for the crystal structure o
LatticeSpacingMin=0.7)
# Fit a cubic cell, starting parameter is 5
Fit(Function="name=LatticeFunction,CrystalSystem=Cubic,a=5",
Fit(Function="name=LatticeFunction,LatticeSystem=Cubic,a=5",
InputWorkspace=peaks_Si,
Ties="ZeroShift=0.0",
CreateOutput=True,
......
......@@ -11,7 +11,7 @@ Description
The basic principle of fitting unit cell parameters to a complete powder diffraction pattern has been described by Pawley. Instead allowing each peak to have a freely selectable position, these positions are calculated as a result from the unit cell parameters. All other parameters of the peaks are refined independently. The implementation of the function differs from the method described in the paper in some points, for example the number of parameters can not change during the refinement (no reflections will be added or removed).
Since the function requires special setup (assignment of HKLs, selection of crystal system and profile function), there is an algorithm that can perform a Pawley-type fit with different input data. Please see the documentation of :ref:`algm-PawleyFit` for details on how to use it.
Since the function requires special setup (assignment of HKLs, selection of lattice system and profile function), there is an algorithm that can perform a Pawley-type fit with different input data. Please see the documentation of :ref:`algm-PawleyFit` for details on how to use it.
.. attributes::
......
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