add isBinaryMask function

Author: Remi-Gau

src/utils/isBinaryMask.m

@@ -0,0 +1,38 @@
+function status = isBinaryMask(image)
+  %
+  % (C) Copyright 2022 CPP ROI developers
+
+  status = true;
+
+  if exist(image, 'file') == 0
+    err.identifier =  'isBinaryMask:notAFile';
+    err.message = sprintf(['the image:', ...
+                           '\n\t%s\n'...
+                           'does not exist.'], ...
+                          image);
+    error(err);
+  end
+
+  hdr = spm_vol(image);
+
+  if numel(hdr) > 1
+    err.identifier =  'isBinaryMask:notBinaryImage';
+    err.message = sprintf(['the image:', ...
+                           '\n\t%s\n', ...
+                           'must be a 3D image. It seems to be 4D image with %i volume.'], ...
+                          image);
+    error(err);
+  end
+
+  vol = spm_read_vols(hdr);
+
+  if numel(unique(vol)) > 2 || ~all(unique(vol) == [0; 1])
+    err.identifier =  'isBinaryMask:notBinaryImage';
+    err.message = sprintf(['the image:', ...
+                           '\n\t%s\n', ...
+                           'must be a binary image. It seems to more than ones and zeros.'], ...
+                          image);
+    error(err);
+  end
+
+end

tests/test_isBinaryMask.m

@@ -0,0 +1,55 @@
+function test_suite = test_isBinaryMask %#ok<*STOUT>
+  % (C) Copyright 2022 CPP ROI developers
+  try % assignment of 'localfunctions' is necessary in Matlab >= 2016
+    test_functions = localfunctions(); %#ok<*NASGU>
+  catch % no problem; early Matlab versions can use initTestSuite fine
+  end
+  initTestSuite;
+end
+
+function test_isBinaryMask_true()
+
+  roiFilename = prepareRoiAndVolumeDefiningImage();
+  isBinaryMask(roiFilename);
+
+end
+
+function test_isBinaryMask_false()
+
+  [~, zMap] = prepareRoiAndVolumeDefiningImage();
+  assertExceptionThrown(@()isBinaryMask(zMap), 'isBinaryMask:notBinaryImage');
+
+end
+
+function value = thisDir()
+  value = fullfile(fileparts(mfilename('fullpath')));
+end
+
+function value = demoDir()
+
+  value = fullfile(thisDir(), '..', 'demos', 'roi', 'inputs');
+
+  if exist(fullfile(value, 'TStatistic.nii'), 'file') == 0
+    gunzip(fullfile(value, '*.gz'));
+  end
+
+end
+
+function  [roiFilename, zMap] = prepareRoiAndVolumeDefiningImage()
+
+  zMap = fullfile(demoDir(), 'space-MNI_atlas-neurosynth_label-visualMotion_probseg.nii');
+
+  roiFilename = fullfile(demoDir(), ...
+                         'space-MNI_atlas-neurosynth_label-visualMotion_desc-p10pt00_mask.nii');
+
+  if exist(roiFilename, 'file') == 2
+
+  else
+
+    zMap = renameNeuroSynth(zMap);
+    threshold = 10;
+    roiFilename = thresholdToMask(zMap, threshold);
+
+  end
+
+end