Merge pull request #355 from nipreps/enh/calculate-bspline-dense-refe…

…rence

ENH: Function to calculate reference grids aligned with the coefficients

sdcflows/utils/tests/test_tools.py

@@ -22,12 +22,93 @@
 #
 """Test EPI manipulation routines."""
 import numpy as np
+import pytest
 import nibabel as nb
-from ..tools import brain_masker
+from nitransforms.linear import Affine
+from sdcflows.utils.tools import brain_masker, deoblique_and_zooms
 
 
 def test_epi_mask(tmpdir, testdata_dir):
     """Check mask algorithm."""
     tmpdir.chdir()
     mask = brain_masker(testdata_dir / "epi.nii.gz")[-1]
     assert abs(np.asanyarray(nb.load(mask).dataobj).sum() - 166476) < 10
+
+
+@pytest.mark.parametrize("padding", [0, 1, 4])
+@pytest.mark.parametrize("factor", [1, 4, 0.8])
+@pytest.mark.parametrize("centered", [True, False])
+@pytest.mark.parametrize(
+    "rotate",
+    [
+        np.eye(4),
+        # Rotate 90 degrees around x-axis
+        np.array([[0, 1, 0, 0], [0, 0, 1, 0], [1, 0, 0, 0], [0, 0, 0, 1]]),
+        # Rotate 30 degrees around x-axis
+        nb.affines.from_matvec(
+            nb.eulerangles.euler2mat(0, 0, 30 * np.pi / 180),
+            (0, 0, 0),
+        ),
+        # Rotate 48 degrees around y-axis and translation
+        nb.affines.from_matvec(
+            nb.eulerangles.euler2mat(0, 48 * np.pi / 180, 0),
+            (2.0, 1.2, 0.7),
+        ),
+    ],
+)
+def test_deoblique_and_zooms(tmpdir, padding, factor, centered, rotate, debug=False):
+    """Check deoblique and denser."""
+    tmpdir.chdir()
+
+    # Generate an example reference image
+    ref_shape = (80, 128, 160) if factor < 1 else (20, 32, 40)
+    ref_data = np.zeros(ref_shape, dtype=np.float32)
+    ref_data[1:-2, 10:-11, 1:-2] = 1
+    ref_affine = np.diag([2.0, 1.25, 1.0, 1.0])
+    ref_zooms = nb.affines.voxel_sizes(ref_affine)
+    if centered:
+        ref_affine[:3, 3] -= nb.affines.apply_affine(
+            ref_affine,
+            0.5 * (np.array(ref_data.shape) - 1),
+        )
+    ref_img = nb.Nifti1Image(ref_data, ref_affine)
+    ref_img.header.set_qform(ref_affine, 1)
+    ref_img.header.set_sform(ref_affine, 0)
+
+    # Generate an example oblique image
+    mov_affine = rotate @ ref_affine
+    mov_img = nb.Nifti1Image(ref_data, mov_affine)
+    mov_img.header.set_qform(mov_affine, 1)
+    mov_img.header.set_sform(mov_affine, 0)
+
+    # Call function with default parameters
+    out_img = deoblique_and_zooms(ref_img, mov_img, padding=padding, factor=factor)
+
+    # Check output shape and zooms
+    assert np.allclose(out_img.header.get_zooms()[:3], ref_zooms / factor)
+
+    # Check idempotency with a lot of tolerance
+    ref_resampled = Affine(reference=out_img).apply(ref_img, order=0)
+    ref_back = Affine(reference=ref_img).apply(ref_resampled, order=0)
+    resampled = Affine(reference=out_img).apply(mov_img, order=2)
+    if debug:
+        ref_img.to_filename("reference.nii.gz")
+        ref_back.to_filename("reference_back.nii.gz")
+        ref_resampled.to_filename("reference_resampled.nii.gz")
+        mov_img.to_filename("moving.nii.gz")
+        resampled.to_filename("resampled.nii.gz")
+
+    # Allow up to 3% pixels wrong after up(down)sampling and walk back.
+    assert (
+        np.abs(np.clip(ref_back.get_fdata(), 0, 1) - ref_data).sum()
+        < ref_data.size * 0.03
+    )
+
+    vox_vol_out = np.prod(out_img.header.get_zooms())
+    vox_vol_mov = np.prod(mov_img.header.get_zooms())
+    vol_factor = vox_vol_out / vox_vol_mov
+
+    ref_volume = ref_data.sum()
+    res_volume = np.clip(resampled.get_fdata(), 0, 1).sum() * vol_factor
+    # Tolerate up to 2% variation of the volume of the moving image
+    assert abs(1 - res_volume / ref_volume) < 0.02

sdcflows/utils/tools.py

@@ -21,6 +21,78 @@
 #     https://www.nipreps.org/community/licensing/
 #
 """Image processing tools."""
+import nibabel as nb
+
+
+def deoblique_and_zooms(
+    in_reference: nb.spatialimages.SpatialImage,
+    oblique: nb.spatialimages.SpatialImage,
+    factor: int = 4,
+    padding: int = 1,
+    factor_tol: float = 1e-4,
+):
+    """
+    Generate a sampling reference aligned with in_reference fully covering oblique.
+
+    Parameters
+    ----------
+    in_reference : :obj:`~nibabel.spatialimages.SpatialImage`
+        The sampling reference.
+    oblique : :obj:`~nibabel.spatialimages.SpatialImage`
+        The rotated coordinate system whose extent should be fully covered by the
+        generated reference.
+    factor : :obj:`int`
+        A factor to increase the resolution of the generated reference.
+    padding : :obj:`int`
+        Number of additional voxels around the most extreme positions of the projection of
+        oblique on to the reference.
+    factor_tol : :obj:`float`
+        Absolute tolerance to determine whether factor is one.
+
+    """
+    from itertools import product
+    import numpy as np
+    from nibabel.affines import apply_affine, rescale_affine
+
+    # Reference space metadata
+    hdr = in_reference.header.copy()
+    affine = in_reference.affine.copy()
+    ref_shape = np.array(in_reference.shape[:3])
+    ref_zooms = np.array(hdr.get_zooms()[:3])
+    _, scode = in_reference.get_sform(coded=True)
+    _, qcode = in_reference.get_qform(coded=True)
+
+    # Calculate the 8 most extreme coordinates of oblique in in_reference space
+    corners = np.array(list(product((0, 1), repeat=3))) * (
+        np.array(oblique.shape[:3]) - 1
+    )
+    extent_ijk = apply_affine(np.linalg.inv(affine) @ oblique.affine, corners)
+
+    underflow = np.clip(extent_ijk.min(0) - padding, None, 0).astype(int)
+    overflow = np.ceil(
+        np.clip(extent_ijk.max(0) + padding + 1 - ref_shape, 0, None)
+    ).astype(int)
+    if np.any(underflow < 0) or np.any(overflow > 0):
+        # Add under/overflow voxels
+        ref_shape += overflow - underflow
+        # Consistently update origin
+        affine[:-1, -1] = apply_affine(affine, underflow)
+
+    # Make grid denser
+    if abs(1.0 - factor) > factor_tol:
+        new_shape = np.rint(ref_shape * factor)
+        affine = rescale_affine(affine, ref_shape, ref_zooms / factor, new_shape)
+        ref_shape = new_shape
+
+    # Generate new reference
+    hdr.set_sform(affine, scode)
+    hdr.set_qform(affine, qcode)
+
+    return in_reference.__class__(
+        nb.fileslice.strided_scalar(ref_shape.astype(int)),
+        affine,
+        hdr,
+    )
 
 
 def resample_to_zooms(in_file, zooms, order=3, prefilter=True):