REF: Improve gradient formatting function robustness

Improve gradient formatting function robustness by adopting a more
defensive approach:
- Raise if gradients are `None`.
- Raise if gradients are not a numeric homogeneous array-like object.

Add the corresponding tests.

Take advantage of the commit to test the `validate_gradients` function.

Author: jhlegarreta

src/nifreeze/data/dmri.py

@@ -63,6 +63,12 @@
 DTI_MIN_ORIENTATIONS = 6
 """Minimum number of nonzero b-values in a DWI dataset."""
 
+GRADIENT_ABSENCE_ERROR_MSG = "Gradient table may not be None."
+"""Gradient absence error message."""
+
+GRADIENT_OBJECT_ERROR_MSG = "Gradient table must be a numeric homogeneous array-like object."
+"""Gradient object error message."""
+
 GRADIENT_VOLUME_DIMENSIONALITY_MISMATCH_ERROR = """\
 Gradient table shape does not match the number of diffusion volumes: \
 expected {n_volumes} rows, found {n_gradients}."""
@@ -141,9 +147,31 @@ def format_gradients(
         ...
         ValueError: Gradient table must be a 2D array
 
+    Gradient tables must have a regular shape::
+
+        >>> format_gradients([[1, 2], [3, 4, 5]])
+        Traceback (most recent call last):
+        ...
+        TypeError: Gradient table must be a numeric homogeneous array-like object
+
+    Gradient tables must always have two dimensions::
+
+        >>> format_gradients([0, 1, 0, 1000])
+        Traceback (most recent call last):
+        ...
+        ValueError: Gradient table must be a 2D array
+
     """
 
-    formatted = np.asarray(value)
+    if value is None:
+        raise ValueError(GRADIENT_ABSENCE_ERROR_MSG)
+
+    try:
+        formatted = np.asarray(value, dtype=float)
+    except (TypeError, ValueError) as exc:
+        # Conversion failed (e.g. nested ragged objects, non-numeric)
+        raise TypeError(GRADIENT_OBJECT_ERROR_MSG) from exc
+
     if formatted.ndim != 2:
         raise ValueError(GRADIENT_NDIM_ERROR_MSG)
 

test/test_data_dmri.py

@@ -32,14 +32,18 @@
 from nifreeze.data import load
 from nifreeze.data.dmri import (
     DWI,
+    GRADIENT_ABSENCE_ERROR_MSG,
     GRADIENT_BVAL_BVEC_PRIORITY_WARN_MSG,
     GRADIENT_DATA_MISSING_ERROR,
     GRADIENT_EXPECTED_COLUMNS_ERROR_MSG,
     GRADIENT_NDIM_ERROR_MSG,
+    GRADIENT_OBJECT_ERROR_MSG,
     GRADIENT_VOLUME_DIMENSIONALITY_MISMATCH_ERROR,
     find_shelling_scheme,
+    format_gradients,
     from_nii,
     transform_fsl_bvec,
+    validate_gradients,
 )
 from nifreeze.utils.ndimage import load_api
 
@@ -88,6 +92,70 @@ def test_main(datadir):
     assert isinstance(load(input_file), DWI)
 
 
+@pytest.mark.parametrize(
+    "value, expected_exc, expected_msg",
+    [
+        (np.array([[1], [2]], dtype=object), ValueError, GRADIENT_EXPECTED_COLUMNS_ERROR_MSG),
+        (np.zeros((2, 3)), ValueError, GRADIENT_EXPECTED_COLUMNS_ERROR_MSG),
+    ],
+)
+def test_validate_gradients(value, expected_exc, expected_msg):
+    with pytest.raises(expected_exc, match=re.escape(str(expected_msg))):
+        validate_gradients(None, "gradients", value)
+
+
+@pytest.mark.parametrize(
+    "value, expected_exc, expected_msg",
+    [
+        (None, ValueError, GRADIENT_ABSENCE_ERROR_MSG),
+        (3.14, ValueError, GRADIENT_NDIM_ERROR_MSG),
+        ([1, 2, 3, 4], ValueError, GRADIENT_NDIM_ERROR_MSG),
+        (np.arange(24).reshape(4, 3, 2), ValueError, GRADIENT_NDIM_ERROR_MSG),
+        ([[1, 2], [3, 4, 5]], (TypeError, ValueError), GRADIENT_OBJECT_ERROR_MSG),  # Ragged
+    ],
+)
+def test_format_gradients_errors(value, expected_exc, expected_msg):
+    with pytest.raises(expected_exc, match=str(expected_msg)):
+        format_gradients(value)
+
+
+@pytest.mark.parametrize(
+    "value, expect_transpose",
+    [
+        # 2D arrays where first dim == 4 and second dim == 4 -> NO transpose
+        (np.arange(16).reshape(4, 4), False),
+        # 2D arrays where first dim == 4 and second dim != 4 -> transpose
+        (np.arange(12).reshape(4, 3), True),
+        (np.arange(4).reshape(4, 1), True),
+        (np.empty((4, 0)), True),  # zero columns -> still triggers transpose
+        (np.arange(20).reshape(4, 5), True),
+        # 2D arrays where first dim != 4 -> NO transpose
+        (np.arange(12).reshape(3, 4), False),
+        (np.arange(20).reshape(5, 4), False),
+        # List of lists
+        ([[1, 2, 3, 4], [5, 6, 7, 8]], False),
+        ([[1, 2, 3], [4, 5, 6], [7, 8, 9], [10, 11, 12]], True),
+    ],
+)
+def test_format_gradients_basic(value, expect_transpose):
+    obtained = format_gradients(value)
+
+    assert isinstance(obtained, np.ndarray)
+    if expect_transpose:
+        assert obtained.shape == np.asarray(value).T.shape
+        assert np.allclose(obtained, np.asarray(value).T)
+    else:
+        assert obtained.shape == np.asarray(value).shape
+        assert np.allclose(obtained, np.asarray(value))
+
+
+@pytest.mark.random_uniform_spatial_data((2, 2, 2, 4), 0.0, 1.0)
+def test_gradients_absence_error(setup_random_uniform_spatial_data):
+    data, affine = setup_random_uniform_spatial_data
+    with pytest.raises(ValueError, match=GRADIENT_ABSENCE_ERROR_MSG):
+        DWI(dataobj=data, affine=affine)
+
+
 @pytest.mark.random_gtab_data(10, (1000, 2000), 2)
 @pytest.mark.random_dwi_data(50, (34, 36, 24), True)
 @pytest.mark.parametrize("row_major_gradients", (False, True))