Skip to content

Commit 8d78856

Browse files
committed
add zscan plot to docs example
1 parent 99f34b1 commit 8d78856

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed
File renamed without changes.

docs/source/examples/CeO2_635um_zscan_200umSlit_chanClose_exported.xy renamed to docs/source/examples/example_data/CeO2_635um_zscan_200umSlit_chanClose_exported.xy

File renamed without changes.
File renamed without changes.

docs/source/examples/mu_calc_examples.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ Calculating μ from a "z-scan" Measurement
5050

5151
.. note::
5252

53-
The data we will be using for this example can be found here,
54-
`FIXME <https://www.diffpy.org/diffpy.utils/examples/zscan_example_data.txt>`_.
53+
The data we will be using for this example can be found,
54+
`here <https://github.com/diffpy/diffpy.utils/tree/main/docs/source/examples/example_data>`_.
5555

5656
A "z-scan" measurement is the measured transmission of your X-ray incident beam
5757
as a function of sample position. This is obtained by moving the sample
58-
along the X-ray beam (z-direction) and recording the transmitted
58+
perpendicular to the X-ray beam (z-direction) and recording the transmitted
5959
intensity at each position. This measured data looks something like this,
6060

61-
.. image:: ../images/FIXME
61+
.. image:: ../img/zscan-plot.png
6262
:alt: Example of a z-scan measurement.
6363
:align: center
64-
:width: 200px
64+
:width: 300px
6565

6666
Using this z-scan data, you can calculate **μ·d**, where d is the inner diameter of
6767
your sample capillary. To do this, simply pass your z-scan measurement to the ``compute_mud``
@@ -78,7 +78,7 @@ Next, pass the filepath to the function,
7878

7979
.. code-block:: python
8080
81-
filepath = "zscan_example_data.txt"
81+
filepath = "CeO2_635um_zscan_200umSlit_chanClose_exported.xy"
8282
capillary_diameter = 0.5 # mm
8383
mud = compute_mud(filepath)
8484
print(f"Calculated mu*d: {round(mud, 3)}")
@@ -88,8 +88,8 @@ This will output the calculated value of μ·d, which is unitless, and μ in mm\
8888

8989
.. code-block:: console
9090
91-
Calculated mu*d: FIXME
92-
Calculated mu: FIXME mm^-1
91+
Calculated mu*d: 3.489
92+
Calculated mu: 6.977 mm^-1
9393
9494
Calculating μ from Tabulated Values
9595
-----------------------------------

docs/source/img/zscan-plot.png

79.6 KB
Loading

0 commit comments

Comments
 (0)