q_to_tth & tth_to_q

doc/source/examples/diffractionobjectsexample.rst

@@ -8,34 +8,27 @@ Diffraction Objects Example
 This example will demonstrate how to use the ``DiffractionObject`` class in the
 ``diffpy.utils.scattering_objects.diffraction_objects`` module to process and analyze diffraction data.
 
-1) We have the function ``q_to_tth`` to convert q to two theta values in degrees, and ``tth_to_q`` to do the reverse.
-   You can use these functions with a pre-defined ``DiffractionObject``. ::
+1) Assuming we have created a ``DiffractionObject`` called my_diffraction_pattern from a measured diffraction pattern,
+   and we have specified the wavelength (see Section ??, to be added),
+   we can use the ``q_to_tth`` and ``tth_to_q`` functions to convert between q and two-theta. ::
 
-    # convert q to tth
-    from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
-    test = DiffractionObject(wavelength=1.54)
-    test.on_q = [[0, 0.2, 0.4, 0.6, 0.8, 1], [1, 2, 3, 4, 5, 6]]
-    test.q_to_tth()
+    # Example: convert q to tth
+    my_diffraction_pattern.on_q = [[0, 0.2, 0.4, 0.6, 0.8, 1], [1, 2, 3, 4, 5, 6]]
+    my_diffraction_pattern.q_to_tth()
 
    This function will convert your provided q array and return a two theta array in degrees.
-   To load the converted array, you can either call ``test.q_to_tth()`` or ``test.on_q[0]``.
-
-   Similarly, use the function ``tth_to_q`` to convert two theta values in degrees to q values. ::
+   To load the converted array, you can either call ``test.q_to_tth()`` or ``test.on_q[0]``. ::
 
-    # convert tth to q
+    # Example: convert tth to q
     from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
-    test = DiffractionObject(wavelength=1.54)
-    test.on_tth = [[0, 30, 60, 90, 120, 180], [1, 2, 3, 4, 5, 6]]
-    test.tth_to_q()
+    my_diffraction_pattern.on_tth = [[0, 30, 60, 90, 120, 180], [1, 2, 3, 4, 5, 6]]
+    my_diffraction_pattern.tth_to_q()
 
-   To load the converted array, you can either call ``test.tth_to_q()`` or ``test.on_tth[0]``.
+   Similarly, to load the converted array, you can either call ``test.tth_to_q()`` or ``test.on_tth[0]``.
 
-2) You can use these functions without specifying a wavelength. However, if so, the function will return an empty array,
-   so we strongly encourage you to specify a wavelength when using these functions. ::
-
-    from diffpy.utils.scattering_objects.diffraction_objects import DiffractionObject
-    test = DiffractionObject()
-    test.on_q = [[0, 0.2, 0.4, 0.6, 0.8, 1], [1, 2, 3, 4, 5, 6]]
-    test.q_to_tth()
+2) Both functions require a wavelength to perform conversions. Without a wavelength, they will return empty arrays.
+   Therefore, we strongly encourage you to specify a wavelength when using these functions. ::
 
-   In this case, the function will return an empty array on two theta.
+    # Example: without wavelength specified
+    my_diffraction_pattern.on_q = [[0, 0.2, 0.4, 0.6, 0.8, 1], [1, 2, 3, 4, 5, 6]]
+    my_diffraction_pattern.q_to_tth()    # returns an empty array

doc/source/utilities/diffractionobjectsutility.rst

@@ -7,10 +7,7 @@ The ``diffpy.utils.scattering_objects.diffraction_objects`` module provides func
 for managing and analyzing diffraction data, including angle-space conversions
 and interactions between diffraction data.
 
-- ``q_to_tth()``: Converts an array of q values to their corresponding two theta values, based on specified wavelength.
-- ``tth_to_q()``: Converts an array of two theta values to their corresponding q values, based on specified wavelength.
-
-  These functions help developers standardize diffraction data and update the arrays
-  in the associated ``DiffractionObject``, enabling easier analysis and further processing.
+These functions help developers standardize diffraction data and update the arrays
+in the associated ``DiffractionObject``, enabling easier analysis and further processing.
 
 For a more in-depth tutorial for how to use these functions, click :ref:`here <Diffraction Objects Example>`.