add comments

Author: Remi-Gau

demos/roi/get_peak_coordinates.m

@@ -1,8 +1,17 @@
+% (C) Copyright 2020 CPP ROI developers
+
+% Shows how to get the peak coordinate within a ROI
 roiImage = extractRoiFromAtlas(pwd, 'wang', 'V1v', 'L');
 
+% Data to read the maximum from
 gunzip(fullfile(pwd, 'inputs', '*.gz'));
 dataImage = fullfile(pwd, 'inputs', 'TStatistic.nii');
 
+% If there is no value above a certain threshold the function will return NaN
+threshold = 1;
+
+% The image and the ROI must have the same dimension if we want to use the thresold option
 reslicedImages = resliceRoiImages(dataImage, roiImage);
 
-[worldCoord, voxelCoord, maxVal] = getPeakCoordinates(dataImage, reslicedImages);
+% Get to work.
+[worldCoord, voxelCoord, maxVal] = getPeakCoordinates(dataImage, reslicedImages, threshold);

src/roi/getPeakCoordinates.m

@@ -19,6 +19,9 @@
   %
   % (C) Copyright 2021 CPP ROI developers
 
+  % TODO
+  % if no threshold is requested images do not need to be at the samre resolution
+
   isFile = @(x) exist(x, 'file') == 2;
 
   args = inputParser;