Skip to content

Commit a06764a

Browse files
committed
tweak help formatting; remove generated tutorials.html
1 parent 67d74f0 commit a06764a

File tree

2 files changed

+47
-312
lines changed

2 files changed

+47
-312
lines changed

MDhelp/docs/powderpeaks.md

Lines changed: 47 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,52 @@
22
<a name="PWDR_Peak_List"></a>
33
# PWDR **Peak List** subdata tree item (Powder Diffraction)
44

5-
The Peak List data tree entry is used to fit diffraction peaks at refined or user-supplied positions (not generated from a unit cell). Peak positions and intensities may be selected for individual refinement. There are four modes available here for treatment of peak widths:
6-
1) Gaussian ($\sigma^2$) and Lorentzian (\(\Gamma\)) peak widths may be varied individually,
7-
2) the width values may be generated from the the appropriate profile terms in the Instrument Parameters tree item (U, V & W for \(\sigma^2\); X & Y for \(\Gamma\)), where those terms may optionally be refined.
8-
3) It is possible to mix refinement of XY terms and fit a few individual (\(\Gamma\)) peak widths, but this is not possible with the UVW terms. When any individual ($\sigma^2$) peak widths are fit, it is not possible to refine the U, V or W terms. Note that when individual widths are refined, the fitted values override the values that would be generated from the UVW/XY terms, except as noted in the next mode.
9-
4)It is possible to turn off the setting of individual (\(\sigma^2\) or \(\Gamma\) peak width values) peak width If are refined, then those value(s) in the table are used as the refinement starting point. If values are not refined, then normally the unvaried widths are determined from the appropriate Instrument Parameters profile terms and are placed in the table prior to fitting. When the "Gen unvaried widths" menu item is turned off, the unvaried peak with values are not computed from the Instrument Parameters; this must be turned on (the default mode) to vary Instrument Parameters.
10-
11-
Note that the Gaussian full-width at half-maximum is given by
12-
13-
$$FWHM = \sqrt{8 * \ln 2 * \sigma^ 2}$$
14-
15-
while \(\Gamma\) is the Lorentzian FWHM. The \(\sigma^2\) values (peak variances) are in units of centidegrees\(^2\) (centidegrees are degrees*100) for CW data or microseconds\(^2\) for TOF data; \(\Gamma\) has units of centidegrees or microseconds. Except in very unusual circumstances, instrumental broadening is Gaussian and will be a slowly-changing function of Q and sample broadening is strictly Lorentzian and while this may be only a function of Q, it can vary from peak to peak if the sample is a mixture of phases, or anisotropic peak broadening is present. Thus, it makes sense to fit Gaussian widths only using the U, V & W terms and indeed the software will not allow those terms to be varied if
16-
*any*
17-
individual peak \(\sigma^2\) terms are varied as this usage would not make sense physically.
18-
This is different for X & Y and individual peak \(\Gamma\) values. The refinement of X & Y, while fitting of *some* individual peak \(\Gamma\) values is allowed and this can make sense physically, but note that one should have a sufficient number of peaks that are not being fit individually and these peaks should be distributed over a wide range in Q when X & Y are fit simultaneously.
5+
The Peak List data tree entry is used to fit diffraction peaks at refined or
6+
user-supplied positions (not generated from a unit cell). Peak positions and
7+
intensities may be selected for individual refinement. There are four modes
8+
available here for treatment of peak widths:
9+
10+
1. Gaussian ($\sigma^2$) and Lorentzian (\(\Gamma\)) peak widths may be varied individually.
11+
2. The width values may be generated from the the appropriate profile terms in the
12+
Instrument Parameters tree item (U, V & W for \(\sigma^2\); X & Y for \(\Gamma\)),
13+
where those terms may optionally be refined.
14+
3. It is possible to mix refinement of XY terms and fit a few individual (\(\Gamma\))
15+
peak widths, but this is not possible with the UVW terms. When any individual ($\sigma^2$)
16+
peak widths are fit, it is not possible to refine the U, V or W terms. Note that when
17+
individual widths are refined, the fitted values override the values that would be
18+
generated from the UVW/XY terms, except as noted in the next mode.
19+
4. It is possible to turn off the setting of individual (\(\sigma^2\) or \(\Gamma\)
20+
peak width values) peak width If are refined, then those value(s) in the table are
21+
used as the refinement starting point. If values are not refined, then normally the
22+
unvaried widths are determined from the appropriate Instrument Parameters profile
23+
terms and are placed in the table prior to fitting. When the "Gen unvaried widths"
24+
menu item is turned off, the unvaried peak with values are not computed from the
25+
Instrument Parameters; this must be turned on (the default mode) to vary
26+
Instrument Parameters.
27+
28+
Note that the Gaussian full-width at half-maximum is given by:
29+
30+
$$FWHM_G = \sqrt{8 * \ln 2 * \sigma^ 2}$$
31+
32+
while the Lorentzian full-width at half-maximum is just $\Gamma$:
33+
34+
$$FWHM_L = \Gamma$$
35+
36+
The \(\sigma^2\) values (peak variances) are in units of centidegrees\(^2\)
37+
(centidegrees are degrees\*100) for CW data or microseconds\(^2\) for TOF data;
38+
\(\Gamma\) has units of centidegrees or microseconds. Except in very unusual
39+
circumstances, instrumental broadening is Gaussian and will be a slowly-changing
40+
function of Q. However, sample broadening is strictly Lorentzian and while sample broadening may
41+
only vary with Q, it can also vary from peak to peak if the sample is a mixture
42+
of phases, or anisotropic peak broadening is present. Thus, it makes sense to fit
43+
Gaussian widths only using the U, V & W terms and indeed the software will not
44+
allow those terms to be varied if *any*
45+
individual peak \(\sigma^2\) terms are varied, as this usage would not make sense physically.
46+
This is different for X & Y and individual peak \(\Gamma\) values. The refinement
47+
of X & Y, while fitting of *some* individual peak \(\Gamma\) values is allowed and
48+
this can make sense physically, but note that one should have a sufficient number
49+
of peaks that are not being fit individually and these peaks should be distributed
50+
over a wide range in Q when X & Y are fit simultaneously.
1951

2052
For peak fitting, the background is generated using the parameters in the Background data tree entry. Also, the range of data used in the fit is set from the Limits tree item. In both cases these are the same values that are used in Rietveld fits. Note that optionally the parameters on the Background and in the Instrument Parameters tree items may be refined during peak fitting, but in the case of U, V & W, these values cannot be refined if any individual \(\sigma^2\) values are fit.
2153

@@ -32,7 +64,7 @@ The following interactions are available with the peak table:
3264
* You can highlight a peak in the plot by double-clicking on the row label (to the left) for a peak.
3365
* Pressing "d" in the plot window causes the next peak in the table (or the first if none are selected) to be selected and causes that peak to be highlighted in the plot; pressing "u" causes the previous peak in the list to be highlighted.
3466

35-
### "**Command**" Menu Commands
67+
### Menu Commands: "**Command**" menu
3668

3769
The menu for Peak Fitting contains the following commands:
3870

0 commit comments

Comments
 (0)