add tests for createRoiName

Author: Remi-Gau

src/roi/createRoiName.m

@@ -1,9 +1,26 @@
-function roiName = createRoiName(mask, volumeDefiningImage)
+function roiName = createRoiName(varargin)
   %
+  % creates BIDS like filename for ROIs
+  %
+  % USAGE::
+  %
+  %     roiName = createRoiName(mask, volumeDefiningImage)
   %
   % (C) Copyright 2022 CPP ROI developers
 
-  if strcmp(mask.def, 'sphere')
+  args = inputParser;
+
+  args.addRequired('mask', @isstruct);
+  args.addOptional('volumeDefiningImage', '', @ischar);
+
+  args.parse(varargin{:});
+
+  type = args.Results.mask.def;
+  label = args.Results.mask.label;
+  mask = args.Results.mask;
+  volumeDefiningImage = args.Results.volumeDefiningImage;
+
+  if strcmp(type, 'sphere')
 
     bf = bids.File('');
     bf.extension = '.nii';
@@ -20,28 +37,32 @@
 
     end
 
-    label = '';
+    tmp = '';
     if isfield(bf.entities, 'label')
-      label = bf.entities.label;
+      tmp = bf.entities.label;
     end
 
-    entities.label = bids.internal.camel_case([label ' ' mask.label]);
+    entities.label = bids.internal.camel_case([tmp ' ' label]);
 
     bf.entities = entities;
 
   else
 
     bf = bids.File(mask.global.hdr.fname);
 
-    label = '';
+    bf.suffix = 'mask';
+
+    tmp = '';
     if isfield(bf.entities, 'label')
-      label = bf.entities.label;
+      tmp = bf.entities.label;
     end
 
-    bf.entities.label = bids.internal.camel_case([label ' ' mask.label]);
+    bf.entities.label = bids.internal.camel_case([tmp ' ' label]);
 
   end
 
+  bf = bf.reorder_entities();
+  bf = bf.update;
   roiName = bf.filename;
 
 end

tests/test_createRoiName.m

@@ -0,0 +1,92 @@
+function test_suite = test_createRoiName %#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_createRoiName_non_sphere()
+
+  mask.def = 'expand';
+  mask.global.hdr.fname = 'suffixOnly.nii';
+
+  %%
+  mask.label = '';
+  roiName = createRoiName(mask);
+  assertEqual(roiName, 'mask.nii');
+
+  mask.label = 'foo';
+  roiName = createRoiName(mask);
+  assertEqual(roiName, 'label-foo_mask.nii');
+
+  %%
+  mask.global.hdr.fname = 'one-entity.nii';
+
+  mask.label = '';
+  roiName = createRoiName(mask);
+  assertEqual(roiName, 'one-entity_mask.nii');
+
+  % This will likely break when bids-matlab is updated and the order of entities
+  % is imposed by the schema
+  %
+  % label-foo_one-entity_mask.nii
+  %
+  mask.label = 'foo';
+  roiName = createRoiName(mask);
+  assertEqual(roiName, 'one-entity_label-foo_mask.nii');
+
+end
+
+function test_createRoiName_sphere()
+
+  mask.def = 'sphere';
+
+  %%
+  mask.label = '';
+  roiName = createRoiName(mask);
+  assertEqual(roiName, 'mask.nii');
+
+  mask.label = 'foo';
+  roiName = createRoiName(mask);
+  assertEqual(roiName, 'label-foo_mask.nii');
+
+  %%
+  volumeDefiningImage = fullfile(pwd, 'TStatistic.nii');
+
+  mask.label = '';
+  roiName = createRoiName(mask, volumeDefiningImage);
+  assertEqual(roiName, 'mask.nii');
+
+  mask.label = 'foo';
+  roiName = createRoiName(mask, volumeDefiningImage);
+  assertEqual(roiName, 'label-foo_mask.nii');
+
+  %%
+  volumeDefiningImage = fullfile(pwd, 'space-MNI_TStatistic.nii');
+
+  mask.label = '';
+  roiName = createRoiName(mask, volumeDefiningImage);
+  assertEqual(roiName, 'space-MNI_mask.nii');
+
+  mask.label = 'foo';
+  roiName = createRoiName(mask, volumeDefiningImage);
+  assertEqual(roiName, 'space-MNI_label-foo_mask.nii');
+
+end
+
+function test_createRoiName_sphere_spm()
+
+  % spm (ish) output
+  %
+  % https://github.com/cpp-lln-lab/CPP_ROI/issues/6
+  %
+
+  volumeDefiningImage = fullfile(pwd, 'task-auditory_p-0001_k-0_MC-none_label-001_spmT.nii');
+  mask.def = 'sphere';
+  mask.label = 'sphere5x44yMinus67z0';
+  roiName = createRoiName(mask, volumeDefiningImage);
+  assertEqual(roiName, 'label-sphere5x44yMinus67z0_mask.nii');
+
+end