Skip to content

Commit 0a155aa

Browse files
docs: edit example file
1 parent 66c67c6 commit 0a155aa

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

doc/source/examples/diffraction_objects_example.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -106,23 +106,26 @@ we would replace the code above with
106106
The ``scale_to()`` method returns a new ``DiffractionObject`` which we can assign to a new
107107
variable and make use of,
108108

109+
The default behavior is to align the objects based on the maximal q-value of each diffraction object,
110+
so they will align at the intensity at these indices.
111+
109112
.. code-block:: python
110113
111-
scaled_measured = measured.scale_to(calculated, q=5.5)
114+
scaled_measured = measured.scale_to(calculated)
112115
113-
For convenience, you can also apply an offset to the scaled new diffraction object with the optional
114-
``offset`` argument, for example,
116+
If this doesn't give the desirable results, you can specify an ``xtype=value`` to scale
117+
based on the closest x-value in both objects. For example:
115118

116119
.. code-block:: python
117120
118-
scaled_and_offset_measured = measured.scale_to(calculated, q=5.5, offset=0.5)
121+
scaled_measured = measured.scale_to(calculated, q=5.5)
119122
120-
You can call `scale_to()` without specifying a value for `q`, `tth`, or `d`.
121-
In this case, the scaling will be done based on the maximal x-array value of both diffraction objects:
123+
For convenience, you can also apply an offset to the scaled new diffraction object with the optional
124+
``offset`` argument, for example,
122125

123126
.. code-block:: python
124127
125-
scaled_measured = measured.scale_to(calculated)
128+
scaled_and_offset_measured = measured.scale_to(calculated, q=5.5, offset=0.5)
126129
127130
DiffractionObject convenience functions
128131
---------------------------------------

0 commit comments

Comments
 (0)