Skip to content

Commit a6eb945

Browse files
update help files
1 parent 2ccb4d8 commit a6eb945

File tree

3 files changed

+170
-83
lines changed

3 files changed

+170
-83
lines changed

GSASII/help/powder.html

Lines changed: 128 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -975,39 +975,75 @@
975975
<ul class="md-nav__list">
976976

977977
<li class="md-nav__item">
978-
<a href="#for-line-plots" class="md-nav__link">
978+
<a href="#for-single-histogram-line-plots" class="md-nav__link">
979979
<span class="md-ellipsis">
980-
For line plots
980+
For Single-Histogram line plots
981981
</span>
982982
</a>
983983

984-
</li>
984+
<nav class="md-nav" aria-label="For Single-Histogram line plots">
985+
<ul class="md-nav__list">
985986

986987
<li class="md-nav__item">
987-
<a href="#for-line-plots-with-more-than-one-powder-pattern" class="md-nav__link">
988+
<a href="#for-specific-data-tree-items" class="md-nav__link">
988989
<span class="md-ellipsis">
989-
For line plots with more than one powder pattern
990+
For specific data tree items
990991
</span>
991992
</a>
992993

993994
</li>
994995

996+
</ul>
997+
</nav>
998+
999+
</li>
1000+
1001+
<li class="md-nav__item">
1002+
<a href="#for-waterfall-plots-with-more-than-one-powder-pattern" class="md-nav__link">
1003+
<span class="md-ellipsis">
1004+
For Waterfall Plots (with more than one powder pattern)
1005+
</span>
1006+
</a>
1007+
1008+
<nav class="md-nav" aria-label="For Waterfall Plots (with more than one powder pattern)">
1009+
<ul class="md-nav__list">
1010+
9951011
<li class="md-nav__item">
996-
<a href="#offset-modes-for-line-plots-in-waterfall-mode-multiple-patterns-only" class="md-nav__link">
1012+
<a href="#waterfall-plot-offsets" class="md-nav__link">
9971013
<span class="md-ellipsis">
998-
Offset modes for line plots in waterfall mode (multiple patterns only)
1014+
Waterfall Plot Offsets
9991015
</span>
10001016
</a>
10011017

1018+
</li>
1019+
1020+
</ul>
1021+
</nav>
1022+
10021023
</li>
10031024

10041025
<li class="md-nav__item">
10051026
<a href="#for-contour-plots" class="md-nav__link">
10061027
<span class="md-ellipsis">
1007-
For contour plots
1028+
For Contour Plots
1029+
</span>
1030+
</a>
1031+
1032+
<nav class="md-nav" aria-label="For Contour Plots">
1033+
<ul class="md-nav__list">
1034+
1035+
<li class="md-nav__item">
1036+
<a href="#contour-plots-display-options" class="md-nav__link">
1037+
<span class="md-ellipsis">
1038+
Contour Plots Display Options
10081039
</span>
10091040
</a>
10101041

1042+
</li>
1043+
1044+
</ul>
1045+
</nav>
1046+
10111047
</li>
10121048

10131049
<li class="md-nav__item">
@@ -1542,39 +1578,75 @@
15421578
<ul class="md-nav__list">
15431579

15441580
<li class="md-nav__item">
1545-
<a href="#for-line-plots" class="md-nav__link">
1581+
<a href="#for-single-histogram-line-plots" class="md-nav__link">
15461582
<span class="md-ellipsis">
1547-
For line plots
1583+
For Single-Histogram line plots
15481584
</span>
15491585
</a>
15501586

1551-
</li>
1587+
<nav class="md-nav" aria-label="For Single-Histogram line plots">
1588+
<ul class="md-nav__list">
15521589

15531590
<li class="md-nav__item">
1554-
<a href="#for-line-plots-with-more-than-one-powder-pattern" class="md-nav__link">
1591+
<a href="#for-specific-data-tree-items" class="md-nav__link">
15551592
<span class="md-ellipsis">
1556-
For line plots with more than one powder pattern
1593+
For specific data tree items
15571594
</span>
15581595
</a>
15591596

1597+
</li>
1598+
1599+
</ul>
1600+
</nav>
1601+
15601602
</li>
15611603

15621604
<li class="md-nav__item">
1563-
<a href="#offset-modes-for-line-plots-in-waterfall-mode-multiple-patterns-only" class="md-nav__link">
1605+
<a href="#for-waterfall-plots-with-more-than-one-powder-pattern" class="md-nav__link">
15641606
<span class="md-ellipsis">
1565-
Offset modes for line plots in waterfall mode (multiple patterns only)
1607+
For Waterfall Plots (with more than one powder pattern)
15661608
</span>
15671609
</a>
15681610

1611+
<nav class="md-nav" aria-label="For Waterfall Plots (with more than one powder pattern)">
1612+
<ul class="md-nav__list">
1613+
1614+
<li class="md-nav__item">
1615+
<a href="#waterfall-plot-offsets" class="md-nav__link">
1616+
<span class="md-ellipsis">
1617+
Waterfall Plot Offsets
1618+
</span>
1619+
</a>
1620+
1621+
</li>
1622+
1623+
</ul>
1624+
</nav>
1625+
15691626
</li>
15701627

15711628
<li class="md-nav__item">
15721629
<a href="#for-contour-plots" class="md-nav__link">
15731630
<span class="md-ellipsis">
1574-
For contour plots
1631+
For Contour Plots
1632+
</span>
1633+
</a>
1634+
1635+
<nav class="md-nav" aria-label="For Contour Plots">
1636+
<ul class="md-nav__list">
1637+
1638+
<li class="md-nav__item">
1639+
<a href="#contour-plots-display-options" class="md-nav__link">
1640+
<span class="md-ellipsis">
1641+
Contour Plots Display Options
15751642
</span>
15761643
</a>
15771644

1645+
</li>
1646+
1647+
</ul>
1648+
</nav>
1649+
15781650
</li>
15791651

15801652
<li class="md-nav__item">
@@ -1705,16 +1777,16 @@ <h4 id="for-specific-datatree-items">For specific datatree items</h4>
17051777
<p><a name="PWDR_keylist"></a></p>
17061778
<h3 id="plot-key-commands">Plot Key Commands</h3>
17071779
<p>The following key press characters have defined actions. These actions can also be initiated from the Key Press button on the plot toolbar. Not all actions are available for all PWDR subdata tree items.</p>
1708-
<h4 id="for-line-plots">For line plots</h4>
1780+
<h4 id="for-single-histogram-line-plots">For Single-Histogram line plots</h4>
17091781
<ul>
17101782
<li><strong>a: add magnification region</strong> - Adds a magnification region to the plot and sets the magnification amount to x2. This can be edited (or deleted) in the table that is shown when the main PWDR tree entry is selected.</li>
17111783
<li><strong>b: subtract background</strong> - Subtracts the fitted background from the powder pattern. Pressing this again turns the mode off.</li>
1712-
<li><strong>c: contour on/off</strong> - if multiple powder profiles, then a contour plot is shown of the observed intensities. Data sets of differing length are padded/trimmed to match the 1st pattern.</li>
1713-
<li><strong>f: toggle full length reflection tickmarks</strong> - Reflection positions are indicated when the main PDWR tree entry is selected, or when the "Reflection Lists" entry is selected by display of vertical lines. These lines can be shown as tickmarks, short lines or a thin vertical line the full length of the plot. The 'f' key toggles between the two modes.</li>
1784+
<li><strong>c: contour on/off</strong> - with multiple powder profiles, a contour plot is shown of the observed intensities (see below)</li>
1785+
<li><strong>f: toggle reflection tickmarks</strong> - Reflection positions can be indicated when the main PDWR tree entry is selected, or when the "Reflection Lists" entry is selected by display of vertical lines. These lines can be shown as tickmarks: short lines or a thin vertical line the full length of the plot. The 'f' key toggles between three modes: short lines, thin lines or no lines.</li>
17141786
<li><strong>g: grid lines</strong> - Toggle drawing vertical and horizontal grid lines at all axis label positions. Applies to all plot modes.</li>
1715-
<li><strong>m: toggle single/multiple plot</strong> - In single mode, this will show only the one selected from the data tree. In multiple “waterfall” mode all are superimposed; offset options (below) can be used to shift them. The selected one is displayed as points &amp; curve for obs/calc; others as obs lines only.</li>
1787+
<li><strong>m: toggle single/multiple plot</strong> - In single mode, this will show only the one selected from the data tree. In multiple “waterfall” mode, all selected data are shown (see below).</li>
17161788
<li><strong>n: log(I) on/off</strong> - changes the y-axis to be the log10 of the intensity; difference curve is not shown for log(I) on.</li>
1717-
<li><strong>o: remove obs...</strong> - toggle removal of the labels for obs, calc, etc (only phase names for tickmarks remain).</li>
1789+
<li><strong>o: legend contents</strong> - toggle removal of the labels for obs, calc, etc (only phase names for tickmarks may remain, as determined by the <strong>f</strong> key).</li>
17181790
<li><strong>p: plot partials</strong> - plots the partial contributions from each phase, if they have been computed (using Calculate/Compute partials) in addition to the </li>
17191791
<li><strong>q: toggle Q plot</strong> - changes the x-axis to Q (in Å<span class="arithmatex">\(^{-1}\)</span>). This will put multiple powder patterns taken at different wavelengths/types on the same x-axis scale.</li>
17201792
<li><strong>s: Sqrt(I) on/off</strong> - changes the y-axis to be the square-root of the intensity. The tickmark and the difference curve location is reset.</li>
@@ -1726,44 +1798,59 @@ <h4 id="for-line-plots">For line plots</h4>
17261798
<li><strong>X: cumulative</strong> <span class="arithmatex">\(\chi^2\)</span> - Superimposes a cumulative** <span class="arithmatex">\(\chi^2\)</span> plot that shows the data regions most contributing to the disparities in the fit.</li>
17271799
<li><strong>+,=: no selection</strong> - This is a three-way toggle. In the default mode, observed points are shown as blue "+" signs (the color can be changed in preferences) and the fitted pattern as a green line. Pressing this once adds a line for the observed points and pressing it again removes the "+" signs and for single histogram plots removes the difference curve. </li>
17281800
<li><strong>.: scaling diagnostic</strong> - When the '.' key is pressed, data are plotted as intensity*weight. Normally this = 1.0 for CW data and proportional to incident spectrum for normalized neutron TOF data. Does not include effect of selected weight factor but is equal to number of detectors in multidetector data. (not in menu)</li>
1729-
<li>
1730-
<p><strong>!: save plot parameters as default</strong> - When the "!" key is pressed, the current display settings for the histogram are saved and these settings will be used when the histogram is displayed by clicking on a data tree entry. To reset the scaling, use either the "s" key (sqrt plotting mode) twice or press the "Home" button to the left on the Matplotlib toolbar. </p>
1731-
</li>
1732-
<li>
1733-
<p><strong>e: set excluded region</strong> - Defines a new excluded region: press the "e" key with the mouse on one side of the region. Move the mouse to the other side and press "e" again. The region markers (magenta dashed lines) can be dragged to new positions.
1734-
Available only when the Limits tree entry is selected. </p>
1735-
</li>
1801+
<li><strong>!: save plot parameters as default</strong> - When the "!" key is pressed, the current display settings for the histogram are saved and these settings will be used when the histogram is displayed by clicking on a data tree entry. To reset the scaling, use either the "s" key (sqrt plotting mode) twice or press the "Home" button to the left on the Matplotlib toolbar. </li>
1802+
</ul>
1803+
<h5 id="for-specific-data-tree-items">For specific data tree items</h5>
1804+
<ul>
1805+
<li><strong>e: set excluded region</strong> - Defines a new excluded region: press the "e" key with the mouse on one side of the region. Move the mouse to the other side and press "e" again. The region markers (magenta dashed lines) can be dragged to new positions.
1806+
Available only when the Limits tree entry is selected. </li>
17361807
<li><strong>d: highlight next peak</strong> - Selects a peak in the table, or the next peak.
17371808
Available only when the Peak List or Index Peak List tree entries are selected. </li>
17381809
<li><strong>u: highlight previous peak</strong> - Selects a peak in the table, or the previous peak.
17391810
Available only when the Peak List or Index Peak List tree entries are selected. </li>
17401811
</ul>
1741-
<h4 id="for-line-plots-with-more-than-one-powder-pattern">For line plots with more than one powder pattern</h4>
1812+
<h4 id="for-waterfall-plots-with-more-than-one-powder-pattern">For Waterfall Plots (with more than one powder pattern)</h4>
17421813
<ul>
1743-
<li><strong>c: contour on/off</strong> - if multiple powder profiles, then a contour plot is shown of the observed intensities. Data sets of differing length are padded/trimmed to match the 1st pattern.</li>
1744-
<li><strong>S: set color Scheme</strong> - Select the color map used for contour plots</li>
1745-
<li><strong>m: toggle single/multiple plot</strong> - In single mode, this will show only the one selected from the data tree. In multiple “waterfall” mode all are superimposed; offset options (below) can be used to shift them. The selected one is displayed as points &amp; curve for obs/calc; others as obs lines only.</li>
1746-
<li><strong>f: select data</strong> - Allows a subset of the powder patterns to be plotted, rather than all.</li>
1747-
<li><strong>+,=: no selection</strong> - For multiple powder profiles, only the observed curve is shown when this mode is turned on ('+' and '=' do exactly the same thing).</li>
1748-
<li><strong>/: normalize</strong> - For multiple powder profiles, all diffraction datasets are normalized so that the maximum intensity is 1 (does not affect the data).</li>
1814+
<li><strong>m: toggle single/multiple plot</strong> - In single mode, this will show only the one histogram selected from the data tree. In multiple “waterfall” mode, all selected histograms are superimposed (see <strong>F</strong> for selection); offset options (below) can be used to shift them. The mode for display of the selected dataset is determined by the <strong>+</strong> (or <strong>=</strong>) key (see below).</li>
1815+
<li><strong>F: select data</strong> - Allows a subset of the powder patterns to be plotted, rather than all.</li>
1816+
<li><strong>n: log(I) on/off</strong> - changes the y-axis to be the log10 of the intensity; difference curve is not shown for log(I) on.</li>
1817+
<li><strong>o: legend contents</strong> - toggles addition of histogram names in the plot legend for waterfall plots. Names are the histogram label or the data tree name, if the former is not set. See <strong>f</strong> for inclusion of phase names via tickmarks in the legend.</li>
1818+
<li><strong>s: Sqrt(I) on/off</strong> - changes the y-axis to be the square-root of the intensity. The tickmark location is reset.</li>
1819+
<li><strong>+,=: no selection</strong> - With waterfall plots, this is a four-way toggle. As before, in the default mode, observed points are shown as blue "+" signs (the color can be changed in preferences) and the fitted pattern as a green line. Pressing this once adds a line for the observed points, pressing it again removes the "+" signs. The additional mode for waterfall plots removes the calculated plot from the display and shows the
1820+
histogram name as the histogram label or the data tree name, if the former is not set.
1821+
('+' and '=' do exactly the same thing).</li>
1822+
<li><strong>/: normalize</strong> - For multiple powder profiles, all diffraction datasets are normalized so that the maximum intensity is 1 (only as displayed, the stored values are not changed).</li>
17491823
</ul>
1750-
<h4 id="offset-modes-for-line-plots-in-waterfall-mode-multiple-patterns-only">Offset modes for line plots in waterfall mode (multiple patterns only)</h4>
1824+
<h5 id="waterfall-plot-offsets">Waterfall Plot Offsets</h5>
17511825
<ul>
17521826
<li><strong>l: offset left</strong> - For a waterfall plot of multiple powder profiles, increase the offset so that later plots are shifted more to the left relative to previous plots.</li>
17531827
<li><strong>r: offset right</strong> - For a waterfall plot of multiple powder profiles, increase the offset to the right (or decrease the left offset.)</li>
17541828
<li><strong>d,D: offset down</strong> - For a waterfall plot of multiple powder profiles, increase the offset down. (D does the same as d but to a much larger amount)</li>
17551829
<li><strong>u,U: offset up</strong> - For a waterfall plot of multiple powder profiles, increase the offset up. (U does the same as u but to a much larger amount)</li>
1756-
<li><strong>o: reset offset</strong> - For a waterfall plot of multiple powder profiles, reset to no offset.</li>
1830+
<li><strong>O: reset offset</strong> - For a waterfall plot of multiple powder profiles, reset to no offset.</li>
17571831
</ul>
1758-
<h4 id="for-contour-plots">For contour plots</h4>
1832+
<h4 id="for-contour-plots">For Contour Plots</h4>
17591833
<ul>
1760-
<li><strong>d: lower contour max</strong> - This lowers the level chosen for the highest contour color.</li>
1834+
<li>
1835+
<p><strong>c: contour on/off</strong> - if multiple powder profiles, then a contour plot is shown of the observed intensities. Data sets of differing length are padded/trimmed to match the 1st pattern.</p>
1836+
</li>
1837+
<li>
1838+
<p><strong>F: select data</strong> - Allows a subset of the powder patterns to be plotted, rather than all.</p>
1839+
</li>
1840+
</ul>
1841+
<h5 id="contour-plots-display-options">Contour Plots Display Options</h5>
1842+
<ul>
1843+
<li>
1844+
<p><strong>S: set color Scheme</strong> - Select the color map used for contour plots.
1845+
Default is 'Paired', black/ white options are 'Greys' and 'binary' (for black on white) or 'gray' (for white on black). Some others can be very colorful (but not all are useful!).</p>
1846+
</li>
1847+
<li>
1848+
<p><strong>d: lower contour max</strong> - This lowers the level chosen for the highest contour color.</p>
1849+
</li>
17611850
<li><strong>D: lower contour min</strong> - This lowers the level chosen for the lowest contour color; can be negative.</li>
17621851
<li><strong>u: raise contour max</strong> - This raises the level chosen for the highest contour color</li>
17631852
<li><strong>U: lower contour min</strong> - This lowers the level chosen for the highest contour color</li>
17641853
<li><strong>i: interpolation method</strong> - This changes the method used to represent the contours. If selected a dialog box appears with all the possible choices. Default is 'nearest'; the other useful choice is 'bilinear', this will smooth out the contours.</li>
1765-
<li><strong>s: color scheme</strong> - This changes the color scheme for the contouring. Default is 'Paired', black/ white options are 'Greys' and 'binary' (for black on white) or 'gray' (for white on black). Others can be very colorful (but not useful!)</li>
1766-
<li><strong>c: contour off/on</strong> -This turns off contouring and returns to a waterfall plot with any offsets applied.</li>
17671854
<li><strong>t: temperature on/off</strong> - Show “temperature” for y-axis; valid only if temperature is varied across data sequence and evenly spaced.</li>
17681855
<li><strong>s: toggle sqrt(I) plot</strong> - Show sqrt(intensity) in contour plot</li>
17691856
</ul>

0 commit comments

Comments
 (0)