NHP-pRF/Toolboxes/analyzePRF/utilities/vectorlength.m

function f = vectorlength(m,dim)

% function f = vectorlength(m,dim)
%
% <m> is a matrix
% <dim> (optional) is the dimension of interest.
%   if supplied, calculate vector length of each case oriented along <dim>.
%   if [] or not supplied, calculate vector length of entire matrix
%
% calculate vector length of <m>, either of individual cases (in which case
% the output is the same as <m> except collapsed along <dim>) or globally
% (in which case the output is a scalar).
%
% we ignore NaNs gracefully.
% 
% note some weird cases:
%   vectorlength([]) is [].
%   vectorlength([NaN NaN]) is 0
%
% example:
% a = [1 1];
% isequal(vectorlength(a),sqrt(2))
% a = [1 NaN; NaN NaN];
% isequal(vectorlength(a,1),[1 0])

% deal with NaNs
m(isnan(m)) = 0;

% handle weird case up front
if isempty(m)
  f = [];
  return;
end

% do it
if ~exist('dim','var') || isempty(dim)
  f = sqrt(dot(m(:),m(:),1));
else
  f = sqrt(dot(m,m,dim));
end