Skip to content

Commit 9707916

Browse files
committed
docs: update image captions
1 parent 26fabef commit 9707916

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

doc/source/examples.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Examples
77
Sequential fitting
88
===================
99

10-
-------------------------
10+
---------
1111
r series
12-
-------------------------
12+
---------
1313

1414
In certain modeling situations the user could benefit from fitting a data set through a series of refinements that differ one from another by the corresponding fitting ranges. An example of this when one wants to study the details of the local- to average-structure crossover in a complex material. PDFgui has a pre-written macro that automates the setup of this type of refinement.
1515

@@ -26,7 +26,7 @@ In certain modeling situations the user could benefit from fitting a data set th
2626
:align: center
2727
:figwidth: 100%
2828

29-
Figure 3.5: Appearance of the setup panel for specifying an incremental r-series fit conditions.
29+
Figure 2.1: Appearance of the setup panel for specifying an incremental r-series fit conditions.
3030

3131

3232
The first row deals with the increment setup of the upper r of the refinements. User should specify the first and the last fit maximum r-value, and corresponding step (increment), all in units of Angstroms.
@@ -38,9 +38,9 @@ In certain modeling situations the user could benefit from fitting a data set th
3838

3939

4040
.. _temperature-series:
41-
----------------------------------------
41+
------------------
4242
temperature series
43-
----------------------------------------
43+
------------------
4444

4545
Frequently, one must handle a large number of data sets originating from a single sample collected at various temperatures. One of the common modeling schemes in such cases is to perform sequential fitting of such data series, which is known to yield well behaved modeling parameters.
4646

@@ -66,7 +66,7 @@ The data collected at NPDF instrument at LANSCE at Los Alamos National Laborator
6666
:align: center
6767
:figwidth: 100%
6868

69-
Figure 3.6: Setting up a T-series sequential refinement for LaMnO3. Ordering by temperature will ensure that the fits are linked correctly.
69+
Figure 2.2: Setting up a T-series sequential refinement for LaMnO3. Ordering by temperature will ensure that the fits are linked correctly.
7070

7171
4. Order the data by temperature. The data can be ordered by temperature by clicking the “Temperature” header.
7272

@@ -86,7 +86,7 @@ The data collected at NPDF instrument at LANSCE at Los Alamos National Laborator
8686
:figwidth: 100%
8787

8888

89-
Figure 3.7: Displaying the refinement results as a function of external parameter: T-series refinement of LaMnO3, example of isotropic ADP of oxygen atom on general position in *Pbnm* setting. Notable are the offsets just above 700 K (Jahn-Teller transition), and at around 1000 K when sample converts from orthorhombic to rhombohedral symmetry.
89+
Figure 2.3: Displaying the refinement results as a function of external parameter: T-series refinement of LaMnO3, example of isotropic ADP of oxygen atom on general position in *Pbnm* setting. Notable are the offsets just above 700 K (Jahn-Teller transition), and at around 1000 K when sample converts from orthorhombic to rhombohedral symmetry.
9090

9191

9292
Despite quite high temperatures, an onset of the static offset above the transition temperature is clearly marked by this parameter, as apparent in Figure 3.7. Curious user could repeat the same T-series refinement restricting the refinement range upper limit to say 5-6 Angstroms and observe the outcome. The refinement sequence execution should be very quick in this case
@@ -122,7 +122,7 @@ in contrast to 32 inverse Angstroms in previous example.
122122
:align: center
123123
:figwidth: 100%
124124

125-
Figure 3.8: After loading of the Ca-doping data series of LaMnO3 system, proper doping assignment needs to be carried out, as the doping levels introspected from the file names in this example incorrectly reflect the scientific situation. Note that dopant atom has to be present in the template seed used to generate the linked sequence of fits.
125+
Figure 2.4: After loading of the Ca-doping data series of LaMnO3 system, proper doping assignment needs to be carried out, as the doping levels introspected from the file names in this example incorrectly reflect the scientific situation. Note that dopant atom has to be present in the template seed used to generate the linked sequence of fits.
126126

127127

128128
3. Click on “Add” button. Using “Shift” and mouse-select operation you should select all the data sets mentioned in the above list, and then press “Open” button.
@@ -147,7 +147,7 @@ graphically such that various converged fit parameters are plotted versus Ca con
147147
:align: center
148148
:figwidth: 100%
149149

150-
Figure 3.9: Sequence of refined parameters, such as lattice constants, can be plotted vs doping using PDFgui plotting facilities. Figure features lattice parameter *b* in *Pbnm* space group setting for series of Ca-doped LaMnO3 samples for doping concentrations between 0 and 0.28 at 10 K temperature.
150+
Figure 2.5: Sequence of refined parameters, such as lattice constants, can be plotted vs doping using PDFgui plotting facilities. Figure features lattice parameter *b* in *Pbnm* space group setting for series of Ca-doped LaMnO3 samples for doping concentrations between 0 and 0.28 at 10 K temperature.
151151

152152

153153

@@ -258,7 +258,7 @@ and is used here.
258258
:align: center
259259
:figwidth: 100%
260260

261-
Figure 3.10: Fitting the structure of a nanoparticle: 3nm CdSe nanoparticle example.
261+
Figure 2.6: Fitting the structure of a nanoparticle: 3nm CdSe nanoparticle example.
262262

263263

264264
Further improvements can be obtained by introducing anisotropic ADPs, where again values related to the z-direction will remain abnormally large most probably due to the stacking related disorder.A detailed description of this system and successful PDF modeling can be found in this publication: `Quantitative size-dependent structure and strain determination of CdSe nanoparticles using atomic pair distribution function analysis <https://link.aps.org/doi/10.1103/PhysRevB.76.115413>`_.

doc/source/extras.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ Since several formal
3535
plotting examples were given through the tutorial exercise, and having simplicity of usage in
3636
mind, no other plotting examples are provided, hoping that the usage is sufficiently simple
3737
for users to master individually with ease. An example plot of Rw vs refinement step is
38-
shown in Figure 4.1 for Ni example.
38+
shown in Figure 3.1 for Ni example.
3939

4040

4141

4242
.. figure:: images/fig4-01.png
4343
:align: center
4444
:figwidth: 100%
4545

46-
Figure 4.1: Plotting window featuring Rw vs refinement step for Ni example. The basic functionality for manipulating the plot is provided through icons on the tool bar of the plotting window.
46+
Figure 3.1: Plotting window featuring Rw vs refinement step for Ni example. The basic functionality for manipulating the plot is provided through icons on the tool bar of the plotting window.
4747

4848

4949

@@ -102,7 +102,7 @@ An example Ni structure visualization with AtomEye is shown in Figure 4.2.
102102
:align: center
103103
:figwidth: 100%
104104

105-
Figure 4.2: Using AtomEye functionality (if installed on your system) for 3D visualization of the initial and refined PDF structures: example of Ni structure.
105+
Figure 3.2: Using AtomEye functionality (if installed on your system) for 3D visualization of the initial and refined PDF structures: example of Ni structure.
106106

107107
================================
108108
Advanced usage and special needs

doc/source/tutorial.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pane, and the ``PDFfit2 Output`` panel.
3939
:align: center
4040
:figwidth: 100%
4141

42-
Figure 2.1: Appearance of a PDFgui window after a structure model is loaded.
42+
Figure 1.1: Appearance of a PDFgui window after a structure model is loaded.
4343

4444
The ``Fit Tree`` is used in setting up a fit protocol. The ``Plot Control`` serves the user’s needs
4545
for graphically displaying the fits, as well as various fit-related parameters. The content of
@@ -82,7 +82,7 @@ Procedure:
8282
valid structure model file, a ``.stru`` or a ``.cif`` file.
8383
3. Note, an alternative workflow for adding structural models is to select ``New Phase`` from the ``Phases`` dropdown menu.
8484

85-
If you select the Phase in the ``Fit Tree`` by left clicking on it, you will see in the right panel 3 tabs, ``Configure``, ``Constraints``, ``Results``. As shown in the Figure 2.1. Feel free to click one these tabs and look inside.
85+
If you select the Phase in the ``Fit Tree`` by left clicking on it, you will see in the right panel 3 tabs, ``Configure``, ``Constraints``, ``Results``. As shown in the Figure 1.1. Feel free to click one these tabs and look inside.
8686

8787
The ``Configure`` panel displays configuration information from the structure file. The top portion contains lattice parameters, phase scale factor, and a set of parameters intended to be used to account for correlated atomic motion effects that typically sharpen the nearest neighbor PDF peak. These are ``delta1``, ``delta2``, ``sratio``, and ``rcut``. The ``spdiameter`` and ``stepcut`` parameters include scatterer size effects in the PDF. These parameters will be described later. The bottom part of the panel contains standard unit cell content related information such as atomic species, their fractional coordinates, anisotropic ADPs, and site occupancies. The ``Constraints`` panel will hold the constraints we will set up for our fits, it should be empty now, and the results tab will contain the results of any fit.
8888

@@ -102,7 +102,7 @@ Procedure:
102102
:align: center
103103
:figwidth: 100%
104104

105-
Figure 2.2: Appearance of a PDFgui window after a PDF dataset is loaded.
105+
Figure 1.2: Appearance of a PDFgui window after a PDF dataset is loaded.
106106

107107
The ``Configure``
108108
panel displays configuration information from the data file. It should be noted that depend-ing on the software used to prepare the experimental PDF from the raw data, the file may
@@ -140,7 +140,7 @@ Procedure:
140140
:align: center
141141
:figwidth: 100%
142142

143-
Figure 2.3: Adjusting data set related configuration.
143+
Figure 1.3: Adjusting data set related configuration.
144144

145145
Since there is no physical information in the region of of r below the nearest neighbor PDF peak position (as seen in the plot), and since this region is often affected by noise and experimental artifacts, it is wise to exclude it from fitting.
146146
We therefore set the value of the lower boundary of the ``Fit range`` to 1.7. (Note that the
@@ -156,7 +156,7 @@ Procedure:
156156
:align: center
157157
:figwidth: 100%
158158

159-
Figure 2.4: Setting up the refinement parameters and constraints of the structure model.
159+
Figure 1.4: Setting up the refinement parameters and constraints of the structure model.
160160

161161
Here we are defining "variables" that will be refined and giving them names
162162
variable "@1", "@2", etc. and linking them to model parameters by typing them
@@ -173,7 +173,7 @@ Procedure:
173173
:align: center
174174
:figwidth: 100%
175175

176-
Figure 2.5: Setting up the refinement parameters and constraints of the PDF data.
176+
Figure 1.5: Setting up the refinement parameters and constraints of the PDF data.
177177

178178
When we assign the three parameters ``a``, ``b`` and ``c`` to the same variable,
179179
``@2``, we are implicitly ensuring that the refinement will respect
@@ -215,7 +215,7 @@ Procedure:
215215
:align: center
216216
:figwidth: 100%
217217

218-
Figure 2.6: Reviewing the fit parameters and conditions.
218+
Figure 1.6: Reviewing the fit parameters and conditions.
219219

220220

221221
2. When you are satisfied with the configuration, click the "gear" icon |gear| on the toolbar and watch the fit progress in the terminal window. The refinement can be stopped prematurely by clicking on the “stop” icon |stop| on the tool bar. During the refinement the refinement progress will be directly reported in the PDFfit2 Output panel.
@@ -228,7 +228,7 @@ Procedure:
228228
:align: center
229229
:figwidth: 100%
230230

231-
Figure 2.7: Refinement progress is displayed in the PDFfit2 Output panel.
231+
Figure 1.7: Refinement progress is displayed in the PDFfit2 Output panel.
232232

233233

234234

@@ -239,7 +239,7 @@ Procedure:
239239
:align: center
240240
:figwidth: 100%
241241

242-
Figure 2.8: Updating the set of initial values of refined parameters.
242+
Figure 1.8: Updating the set of initial values of refined parameters.
243243

244244
7. Plot the results:
245245
1. Select the data in the fit (in this case the `Ni-xray.gr` dataset) by left clicking it.
@@ -270,13 +270,13 @@ Procedure:
270270
:align: center
271271
:figwidth: 100%
272272

273-
Figure 2.9:An example of PDFgui plotting capabilities: displaying a fit.
273+
Figure 1.9: An example of PDFgui plotting capabilities: displaying a fit.
274274

275275
.. figure:: images/fig2-10.png
276276
:align: center
277277
:figwidth: 100%
278278

279-
Figure 2.10:An example of PDFgui plotting capabilities: displaying a parameter.
279+
Figure 1.10: An example of PDFgui plotting capabilities: displaying a parameter.
280280

281281

282282
8. Save your project for later use.
@@ -309,7 +309,7 @@ In the previous example the initial structure was defined by an existing file. H
309309
:align: center
310310
:figwidth: 100%
311311

312-
Figure 3.1: Expanding the unit cell using space group information.
312+
Figure 1.11: Expanding the unit cell using space group information.
313313

314314
4. Generate symmetry constraints:
315315
1. Select the "Constraints" tab.
@@ -346,7 +346,7 @@ calculate Ni PDF using neutron radiation.
346346
:align: center
347347
:figwidth: 100%
348348

349-
Figure 3.2: An example of the calculation configuration panel.
349+
Figure 1.12: An example of the calculation configuration panel.
350350

351351
Conditions to be specified include radiation type, calculation
352352
range and corresponding r-grid size, as well as instrument resolution and maximum momentum transfer parameters. For the later two, the default values of parameters could be
@@ -390,7 +390,7 @@ Learn how to string together fits.
390390
:align: center
391391
:figwidth: 100%
392392

393-
Figure 3.3: An example of linked fits.
393+
Figure 1.13: An example of linked fits.
394394

395395
5. Add more fit parameters:
396396
1. Select the "Constraints" tab of the `Ni.stru` phase below "Fit 1_copy".

0 commit comments

Comments
 (0)