Skip to content

Commit 04b0f77

Browse files
REF: Remove image change percentage function
Remove image change percentage function from the `analysis.utils` module as it is a metric of image similarity rather than a metric of motion. Co-authored-by: Oscar Esteban <code@oscaresteban.es>
1 parent 711146a commit 04b0f77

File tree

1 file changed

+0
-33
lines changed

1 file changed

+0
-33
lines changed

nitransforms/analysis/utils.py

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -95,39 +95,6 @@ def compute_fd_from_transform(
9595
return np.mean(np.linalg.norm(test_xfm.map(fd_coords) - fd_coords, axis=-1))
9696

9797

98-
def compute_percentage_change(
99-
reference: np.ndarray,
100-
test: np.ndarray,
101-
mask: np.ndarray,
102-
) -> np.ndarray:
103-
"""Compute motion change between reference and test as a percentage.
104-
105-
If a mask is provided, the computation is only provided within the mask.
106-
Also, null values are ignored.
107-
108-
Parameters
109-
----------
110-
reference : :obj:`~numpy.ndarray`
111-
Reference imaging volume.
112-
test : :obj:`~numpy.ndarray`
113-
Test (shifted) imaging volume.
114-
mask : :obj:`~numpy.ndarray`
115-
Mask for value consideration.
116-
117-
Returns
118-
-------
119-
rel_diff : :obj:`~numpy.ndarray`
120-
Motion change between reference and test.
121-
"""
122-
123-
# Avoid divide-by-zero errors
124-
eps = 1e-5
125-
rel_diff = np.zeros_like(reference)
126-
mask = mask.copy()
127-
mask[reference <= eps] = False
128-
rel_diff[mask] = 100 * (test[mask] - reference[mask]) / reference[mask]
129-
130-
return rel_diff
13198

13299

133100
def displacements_within_mask(

0 commit comments

Comments
 (0)