Use labelOLD instead of labelORG, idem for chanpos, chanori, chantype and chanunit. This is more consistent with old/new in ft_apply_montage. The previous montages (containing "org") should still work.

Author: robertoostenveld

forward/ft_apply_montage.m

@@ -14,11 +14,11 @@
 %
 % A montage is specified as a structure with the fields
 %   montage.tra      = MxN matrix
-%   montage.labelorg = Nx1 cell-array
+%   montage.labelold = Nx1 cell-array
 %   montage.labelnew = Mx1 cell-array
 %
 % As an example, a bipolar montage could look like this
-%   bipolar.labelorg  = {'1', '2', '3', '4'}
+%   bipolar.labelold  = {'1', '2', '3', '4'}
 %   bipolar.labelnew  = {'1-2', '2-3', '3-4'}
 %   bipolar.tra       = [
 %     +1 -1  0  0
@@ -28,9 +28,9 @@
 %
 % The montage can optionally also specify the channel type and unit of the input
 % and output data with
-%   montage.chantypeorg = Nx1 cell-array
+%   montage.chantypeold = Nx1 cell-array
 %   montage.chantypenew = Mx1 cell-array
-%   montage.chanunitorg = Nx1 cell-array
+%   montage.chanunitold = Nx1 cell-array
 %   montage.chanunitnew = Mx1 cell-array
 %
 % Additional options should be specified in key-value pairs and can be
@@ -74,6 +74,9 @@
   return
 end
 
+% use "old/new" instead of "org/new"
+montage = fixmontage(montage);
+
 % get optional input arguments
 keepunused  = ft_getopt(varargin, 'keepunused',  'no');
 inverse     = ft_getopt(varargin, 'inverse',     'no');
@@ -88,16 +91,16 @@
 end
 
 % these are optional, at the end we will clean up the output in case they did not exist
-haschantype = (isfield(input, 'chantype') || isfield(input, 'chantypenew')) && all(isfield(montage, {'chantypeorg', 'chantypenew'}));
-haschanunit = (isfield(input, 'chanunit') || isfield(input, 'chanunitnew')) && all(isfield(montage, {'chanunitorg', 'chanunitnew'}));
+haschantype = (isfield(input, 'chantype') || isfield(input, 'chantypenew')) && all(isfield(montage, {'chantypeold', 'chantypenew'}));
+haschanunit = (isfield(input, 'chanunit') || isfield(input, 'chanunitnew')) && all(isfield(montage, {'chanunitold', 'chanunitnew'}));
 
 % make sure they always exist to facilitate the remainder of the code
-if ~isfield(montage, 'chantypeorg')
-  montage.chantypeorg = repmat({'unknown'}, size(montage.labelorg));
+if ~isfield(montage, 'chantypeold')
+  montage.chantypeold = repmat({'unknown'}, size(montage.labelold));
   if isfield(input, 'chantype') && ~istrue(inverse)
     warning('copying input chantype to montage');
-    [sel1, sel2] = match_str(montage.labelorg, input.label);
-    montage.chantypeorg(sel1) = input.chantype(sel2);
+    [sel1, sel2] = match_str(montage.labelold, input.label);
+    montage.chantypeold(sel1) = input.chantype(sel2);
   end
 end
 
@@ -110,12 +113,12 @@
   end
 end
 
-if ~isfield(montage, 'chanunitorg')
-  montage.chanunitorg = repmat({'unknown'}, size(montage.labelorg));
+if ~isfield(montage, 'chanunitold')
+  montage.chanunitold = repmat({'unknown'}, size(montage.labelold));
   if isfield(input, 'chanunit') && ~istrue(inverse)
     warning('copying input chanunit to montage');
-    [sel1, sel2] = match_str(montage.labelorg, input.label);
-    montage.chanunitorg(sel1) = input.chanunit(sel2);
+    [sel1, sel2] = match_str(montage.labelold, input.label);
+    montage.chanunitold(sel1) = input.chanunit(sel2);
   end
 end
 
@@ -157,19 +160,19 @@
 end
 
 % check the consistency of the montage
-if ~iscell(montage.labelorg) || ~iscell(montage.labelnew)
+if ~iscell(montage.labelold) || ~iscell(montage.labelnew)
   error('montage labels need to be specified in cell-arrays');
 end
 
 % check the consistency of the montage
-if ~all(isfield(montage, {'tra', 'labelorg', 'labelnew'}))
+if ~all(isfield(montage, {'tra', 'labelold', 'labelnew'}))
   error('the second input argument does not correspond to a montage');
 end
 
 % check the consistency of the montage
 if size(montage.tra,1)~=length(montage.labelnew)
   error('the number of channels in the montage is inconsistent');
-elseif size(montage.tra,2)~=length(montage.labelorg)
+elseif size(montage.tra,2)~=length(montage.labelold)
   error('the number of channels in the montage is inconsistent');
 end
 
@@ -189,12 +192,12 @@
 
 if istrue(inverse)
   % swap the role of the original and new channels
-  tmp.labelnew    = montage.labelorg;
-  tmp.labelorg    = montage.labelnew;
-  tmp.chantypenew = montage.chantypeorg;
-  tmp.chantypeorg = montage.chantypenew;
-  tmp.chanunitnew = montage.chanunitorg;
-  tmp.chanunitorg = montage.chanunitnew;
+  tmp.labelnew    = montage.labelold;
+  tmp.labelold    = montage.labelnew;
+  tmp.chantypenew = montage.chantypeold;
+  tmp.chantypeold = montage.chantypenew;
+  tmp.chanunitnew = montage.chanunitold;
+  tmp.chanunitold = montage.chanunitnew;
   % apply the inverse montage, this can be used to undo a previously
   % applied montage
   tmp.tra = full(montage.tra);
@@ -210,35 +213,35 @@
 % select and keep the columns that are non-empty, i.e. remove the empty columns
 selcol           = find(~all(montage.tra==0, 1));
 montage.tra      = montage.tra(:,selcol);
-montage.labelorg = montage.labelorg(selcol);
-montage.chantypeorg = montage.chantypeorg(selcol);
-montage.chanunitorg = montage.chanunitorg(selcol);
+montage.labelold = montage.labelold(selcol);
+montage.chantypeold = montage.chantypeold(selcol);
+montage.chanunitold = montage.chanunitold(selcol);
 clear selcol
 
 % select and remove the columns corresponding to channels that are not present in the
 % original data
-remove = setdiff(montage.labelorg, intersect(montage.labelorg, inputlabel));
-selcol = match_str(montage.labelorg, remove);
+remove = setdiff(montage.labelold, intersect(montage.labelold, inputlabel));
+selcol = match_str(montage.labelold, remove);
 % we cannot just remove the colums, all rows that depend on it should also be removed
 selrow = false(length(montage.labelnew),1);
 for i=1:length(selcol)
   selrow = selrow & (montage.tra(:,selcol(i))~=0);
 end
 % convert from indices to logical vector
-selcol = indx2logical(selcol, length(montage.labelorg));
+selcol = indx2logical(selcol, length(montage.labelold));
 % remove rows and columns
-montage.labelorg    = montage.labelorg(~selcol);
+montage.labelold    = montage.labelold(~selcol);
 montage.labelnew    = montage.labelnew(~selrow);
-montage.chantypeorg = montage.chantypeorg(~selcol);
+montage.chantypeold = montage.chantypeold(~selcol);
 montage.chantypenew = montage.chantypenew(~selrow);
-montage.chanunitorg = montage.chanunitorg(~selcol);
+montage.chanunitold = montage.chanunitold(~selcol);
 montage.chanunitnew = montage.chanunitnew(~selrow);
 montage.tra         = montage.tra(~selrow, ~selcol);
 clear remove selcol selrow i
 
 % add columns for channels that are present in the input data but not specified in
 % the montage, stick to the original order in the data
-[dum, ix]   = setdiff(inputlabel, montage.labelorg);
+[dum, ix]   = setdiff(inputlabel, montage.labelold);
 addlabel    = inputlabel(sort(ix));
 addchantype = inputchantype(sort(ix));
 addchanunit = inputchanunit(sort(ix));
@@ -264,18 +267,18 @@
   % add the channels that are not rereferenced to the input and output of the
   % montage
   montage.tra((m+(1:k)),(n+(1:k))) = eye(k);
-  montage.labelorg    = cat(1, montage.labelorg(:), addlabel(:));
+  montage.labelold    = cat(1, montage.labelold(:), addlabel(:));
   montage.labelnew    = cat(1, montage.labelnew(:), addlabel(:));
-  montage.chantypeorg = cat(1, montage.chantypeorg(:), addchantype(:));
+  montage.chantypeold = cat(1, montage.chantypeold(:), addchantype(:));
   montage.chantypenew = cat(1, montage.chantypenew(:), addchantype(:));
-  montage.chanunitorg = cat(1, montage.chanunitorg(:), addchanunit(:));
+  montage.chanunitold = cat(1, montage.chanunitold(:), addchanunit(:));
   montage.chanunitnew = cat(1, montage.chanunitnew(:), addchanunit(:));
 else
   % add the channels that are not rereferenced to the input of the montage only
   montage.tra(:,(n+(1:k))) = zeros(m,k);
-  montage.labelorg    = cat(1, montage.labelorg(:), addlabel(:));
-  montage.chantypeorg = cat(1, montage.chantypeorg(:), addchantype(:));
-  montage.chanunitorg = cat(1, montage.chanunitorg(:), addchanunit(:));
+  montage.labelold    = cat(1, montage.labelold(:), addlabel(:));
+  montage.chantypeold = cat(1, montage.chantypeold(:), addchantype(:));
+  montage.chanunitold = cat(1, montage.chanunitold(:), addchanunit(:));
 end
 clear addlabel addchantype addchanunit m n k
 
@@ -285,21 +288,21 @@
 if length(unique(montage.labelnew))~=m
   error('not all output channels of the montage are unique');
 end
-if length(unique(montage.labelorg))~=n
+if length(unique(montage.labelold))~=n
   error('not all input channels of the montage are unique');
 end
 
 % determine whether all channels that have to be rereferenced are available
-if length(intersect(inputlabel, montage.labelorg))~=length(montage.labelorg)
+if length(intersect(inputlabel, montage.labelold))~=length(montage.labelold)
   error('not all channels that are required in the montage are available in the data');
 end
 
 % reorder the columns of the montage matrix
-[selinput, selmontage] = match_str(inputlabel, montage.labelorg);
+[selinput, selmontage] = match_str(inputlabel, montage.labelold);
 montage.tra            = montage.tra(:,selmontage);
-montage.labelorg       = montage.labelorg(selmontage);
-montage.chantypeorg    = montage.chantypeorg(selmontage);
-montage.chanunitorg    = montage.chanunitorg(selmontage);
+montage.labelold       = montage.labelold(selmontage);
+montage.chantypeold    = montage.chantypeold(selmontage);
+montage.chanunitold    = montage.chanunitold(selmontage);
 
 % ensure that the montage is double precision
 montage.tra = double(montage.tra);
@@ -315,23 +318,23 @@
 end
 
 % update the channel scaling if the input has different units than the montage expects
-if isfield(input, 'chanunit') && ~isequal(input.chanunit, montage.chanunitorg)
-  scale = ft_scalingfactor(input.chanunit, montage.chanunitorg);
+if isfield(input, 'chanunit') && ~isequal(input.chanunit, montage.chanunitold)
+  scale = ft_scalingfactor(input.chanunit, montage.chanunitold);
   montage.tra = montage.tra * diag(scale);
-  montage.chanunitorg = input.chanunit;
-elseif isfield(input, 'chanunitnew') && ~isequal(input.chanunitnew, montage.chanunitorg)
-  scale = ft_scalingfactor(input.chanunitnew, montage.chanunitorg);
+  montage.chanunitold = input.chanunit;
+elseif isfield(input, 'chanunitnew') && ~isequal(input.chanunitnew, montage.chanunitold)
+  scale = ft_scalingfactor(input.chanunitnew, montage.chanunitold);
   montage.tra = montage.tra * diag(scale);
-  montage.chanunitorg = input.chanunitnew;
+  montage.chanunitold = input.chanunitnew;
 end
 
-if isfield(input, 'chantype') && ~isequal(input.chantype, montage.chantypeorg)
+if isfield(input, 'chantype') && ~isequal(input.chantype, montage.chantypeold)
   error('inconsistent chantype in data and montage');
-elseif isfield(input, 'chantypenew') && ~isequal(input.chantypenew, montage.chantypeorg)
+elseif isfield(input, 'chantypenew') && ~isequal(input.chantypenew, montage.chantypeold)
   error('inconsistent chantype in data and montage');
 end
 
-if isfield(input, 'labelorg') && isfield(input, 'labelnew')
+if isfield(input, 'labelold') && isfield(input, 'labelnew')
   inputtype = 'montage';
 elseif isfield(input, 'tra')
   inputtype = 'sens';
@@ -379,9 +382,9 @@
       if keepchans
         sens.chanpos = sens.chanpos(sel2,:);
       else
-        if ~isfield(sens, 'chanposorg')
-          % add a chanposorg only if it is not there yet
-          sens.chanposorg = sens.chanpos;
+        if ~isfield(sens, 'chanposold')
+          % add a chanposold only if it is not there yet
+          sens.chanposold = sens.chanpos;
         end
         sens.chanpos = nan(numel(montage.labelnew),3);
       end
@@ -391,8 +394,8 @@
       if keepchans
         sens.chanori = sens.chanori(sel2,:);
       else
-        if ~isfield(sens, 'chanoriorg')
-          sens.chanoriorg = sens.chanori;
+        if ~isfield(sens, 'chanoriold')
+          sens.chanoriold = sens.chanori;
         end
         sens.chanori = nan(numel(montage.labelnew),3);
       end
@@ -406,14 +409,14 @@
     % original label,
     % type and unit
     % for reference
-    if ~isfield(sens, 'labelorg')
-      sens.labelorg = inputlabel;
+    if ~isfield(sens, 'labelold')
+      sens.labelold = inputlabel;
     end
-    if ~isfield(sens, 'chantypeorg')
-      sens.chantypeorg = inputchantype;
+    if ~isfield(sens, 'chantypeold')
+      sens.chantypeold = inputchantype;
     end
-    if ~isfield(sens, 'chanunitorg')
-      sens.chanunitorg = inputchanunit;
+    if ~isfield(sens, 'chanunitold')
+      sens.chanunitold = inputchanunit;
     end
 
     % keep track of the order of the balancing and which one is the current one
@@ -545,10 +548,10 @@
 
 % only retain the chantype and/or chanunit if they were present in the input
 if ~haschantype
-  input = removefields(input, {'chantype', 'chantypeorg', 'chantypenew'});
+  input = removefields(input, {'chantype', 'chantypeold', 'chantypenew'});
 end
 if ~haschanunit
-  input = removefields(input, {'chanunit', 'chanunitorg', 'chanunitnew'});
+  input = removefields(input, {'chanunit', 'chanunitold', 'chanunitnew'});
 end
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -568,3 +571,20 @@ function nowarning(varargin)
   end
 end
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% HELPER FUNCTION use "old/new" instead of "org/new"
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+function montage = fixmontage(montage)
+if isfield(montage, 'labelorg')
+  montage.labelold = montage.labelorg;
+  montage = rmfield(montage, 'labelorg');
+end
+if isfield(montage, 'chantypeorg')
+  montage.chantypeold = montage.chantypeorg;
+  montage = rmfield(montage, 'chantypeorg');
+end
+if isfield(montage, 'chanuniteorg')
+  montage.chanunitold = montage.chanunitorg;
+  montage = rmfield(montage, 'chanunitorg');
+end
+

forward/ft_convert_units.m

@@ -199,7 +199,8 @@
 if isfield(obj, 'pnt'),        obj.pnt        = scale * obj.pnt;        end
 if isfield(obj, 'pos'),        obj.pos        = scale * obj.pos;        end
 if isfield(obj, 'chanpos'),    obj.chanpos    = scale * obj.chanpos;    end
-if isfield(obj, 'chanposorg'), obj.chanposorg = scale * obj.chanposorg; end
+if isfield(obj, 'chanposorg'), obj.chanposold = scale * obj.chanposorg; end % pre-2016 version
+if isfield(obj, 'chanposold'), obj.chanposold = scale * obj.chanposold; end % 2016 version and later
 if isfield(obj, 'coilpos'),    obj.coilpos    = scale * obj.coilpos;    end
 if isfield(obj, 'elecpos'),    obj.elecpos    = scale * obj.elecpos;    end
 

test/test_bug2332.m

@@ -26,7 +26,7 @@
 
 %% verify grad has been updated successfully
 
-assert(isequal(comp.grad.chanposorg, data.grad.chanpos));
+assert(isequal(comp.grad.chanposold, data.grad.chanpos));
 assert(all(isnan(comp.grad.chanpos(:))));
 
 %% rejectcomponent
@@ -50,18 +50,18 @@
 %% verify again that grad was updated successfully
 
 assert(all(isnan(datplan.grad.chanpos(:))));
-assert(~any(isnan(datplan.grad.chanposorg(:))));
+assert(~any(isnan(datplan.grad.chanposold(:))));
 
-% *org fields should still reflect the original physical positions
-assert(isequal(datplan.grad.chanposorg, data.grad.chanpos));
+% *old fields should still reflect the original physical positions
+assert(isequal(datplan.grad.chanposold, data.grad.chanpos));
 
 %% simple check that combineplanar still works
 
 datcmb = ft_combineplanar([], datplan);
 
 % now chanpos should be nans
 assert(all(isnan(datcmb.grad.chanpos(:))));
-% FIXME do we want a chanposorg on combined planar data as well?
+% FIXME do we want a chanposold on combined planar data as well?
 
 %% move back to original working dir