Commit 4ce31259 authored by Zhang, Chen's avatar Zhang, Chen
Browse files

make the documentation clearer

parent b91f506f

src/imars3d/backend/diagnostics/rotation.py

+7 −5
Original line number Diff line number Diff line
@@ -18,11 +18,13 @@ class find_rotation_center(param.ParameterizedFunction): 
    """

    Automatically find the rotation center from a given radiograph stack.



    The input radiograph stack must be sorted by rotation angle omega. In most

    conventional tomography scan, this is automatically the case. However, if

    the radiograph is collected via non-conventional method, such as grid scan

    or sampling scan, the radiograph stack must be sorted by omega before using

    this function.

    If atol_deg is set to None (default), the input radiograph stack MUST BE

    SORTED by rotation angle omega. In most conventional tomography scan, this

    is automatically the case. However, if the radiograph is collected via

    non-conventional method, such as grid scan or sampling scan, the radiograph

    stack must be sorted by omega before using this function.

    Alternatively, the user can specify the tolerance of the search for 180 deg

    pairs, which is useful for non-conventional tomography scan.



    Parameters

    ----------

src/imars3d/backend/diagnostics/tilt.py

+3 −1
Original line number Diff line number Diff line
@@ -26,10 +26,12 @@ def find_180_deg_pairs_idx( 
    """

    Return the indices of the 180 degree pairs from given list of angles.



    If atol is set to None (default), the input angles MUST BE SORTED.



    Parameters

    ----------

    angles:

        The list of sorted angles as a 1d array.

        The list of angles as a 1d array.

    atol:

        The absolute tolerance in degree for the 180 degree pairs.

    in_degrees: