validate Matlab function parameters

Author: scivision

.gitignore

@@ -1,3 +1,4 @@
+.eggs/
 .mypy_cache/
 .pytest_cache/
 

CMakeLists.txt

@@ -58,7 +58,7 @@ endif()
 
 find_package(Octave)
 if (OCTAVE_MAJOR_VERSION GREATER_EQUAL 4)
-  add_test(NAME MatlabOctave COMMAND octave-cli -q Test.m
+  add_test(NAME MatlabOctave COMMAND octave-cli -q Test_maptran.m
            WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests)
   set_tests_properties(MatlabOctave PROPERTIES TIMEOUT 30)
 endif()

README.md

@@ -82,7 +82,7 @@ The three separate packages are independent, they don't rely on each other.
 
     One can verify Matlab code functionality by running:
 
-        tests/Test.m
+        tests/Test_maptran.m
 
 ## Usage
 

matlab/aer2ecef.m

@@ -13,20 +13,20 @@
 % outputs
 % -------
 % x,y,z: Earth Centered Earth Fixed (ECEF) coordinates of test point (meters)
-     
-  if nargin < 7 || isempty(spheroid), spheroid = wgs84Ellipsoid(); end
-  if nargin < 8, angleUnit = 'd'; end
+narginchk(6,8)
+if nargin < 7, spheroid = []; end
+if nargin < 8, angleUnit = []; end
 
-  %% Origin of the local system in geocentric coordinates.
-  [x0, y0, z0] = geodetic2ecef(spheroid, lat0, lon0, alt0, angleUnit);
-  %% Convert Local Spherical AER to ENU
-  [e, n, u] = aer2enu(az, el, slantRange, angleUnit);
-  %% Rotating ENU to ECEF
-  [dx, dy, dz] = enu2uvw(e, n, u, lat0, lon0, angleUnit);
-  %% Origin + offset from origin equals position in ECEF
-  x = x0 + dx;
-  y = y0 + dy;
-  z = z0 + dz;
+%% Origin of the local system in geocentric coordinates.
+[x0, y0, z0] = geodetic2ecef(spheroid, lat0, lon0, alt0, angleUnit);
+%% Convert Local Spherical AER to ENU
+[e, n, u] = aer2enu(az, el, slantRange, angleUnit);
+%% Rotating ENU to ECEF
+[dx, dy, dz] = enu2uvw(e, n, u, lat0, lon0, angleUnit);
+%% Origin + offset from origin equals position in ECEF
+x = x0 + dx;
+y = y0 + dy;
+z = z0 + dz;
 
 end
 

matlab/aer2enu.m

@@ -11,17 +11,25 @@
 % Outputs
 % -------
 % e,n,u:  East, North, Up coordinates of test points (meters)
+narginchk(3,4)
 
-  if nargin==3 || isempty(angleUnit) || strcmpi(angleUnit(1),'d') 
-    az = deg2rad(az);
-    el = deg2rad(el);
-  end    
+if nargin==3 || isempty(angleUnit), angleUnit='d'; end
+
+validateattributes(az, {'numeric'}, {'real'})
+validateattributes(el, {'numeric'}, {'real','>=',-90,'<=',90})
+validateattributes(slantRange, {'numeric'}, {'real'})
+validateattributes(angleUnit,{'string','char'},{'scalar'})
+%% compute
+if strcmpi(angleUnit(1),'d') 
+  az = deg2rad(az);
+  el = deg2rad(el);
+end    
 
 %% Calculation of AER2ENU
-   u = slantRange .* sin(el);
-   r = slantRange .* cos(el);
-   e = r .* sin(az);
-   n = r .* cos(az);
+u = slantRange .* sin(el);
+r = slantRange .* cos(el);
+e = r .* sin(az);
+n = r .* cos(az);
 
 end
 

matlab/aer2geodetic.m

@@ -13,13 +13,14 @@
 % Outputs
 % -------
 % lat1,lon1,alt1: geodetic coordinates of test points (degrees,degrees,meters)
+narginchk(6,8)
 
-  if nargin<7, spheroid = []; end
-  if nargin<8, angleUnit= [];  end
+if nargin<7, spheroid = []; end
+if nargin<8, angleUnit= [];  end
 
-  [x, y, z] = aer2ecef(az, el, slantRange, lat0, lon0, alt0, spheroid, angleUnit);
- 
-  [lat1, lon1, alt1] = ecef2geodetic(spheroid, x, y, z, angleUnit);
+[x, y, z] = aer2ecef(az, el, slantRange, lat0, lon0, alt0, spheroid, angleUnit);
+
+[lat1, lon1, alt1] = ecef2geodetic(spheroid, x, y, z, angleUnit);
 
 end
 

matlab/ecef2aer.m

@@ -13,12 +13,12 @@
 % az, el, slantrange: look angles and distance to point under test (degrees, degrees, meters)
 % az: azimuth clockwise from local north
 % el: elevation angle above local horizon
+narginchk(6,8)
+if nargin < 7, spheroid = [];  end
+if nargin < 8, angleUnit= []; end
 
-  if nargin < 7, spheroid = [];  end
-  if nargin < 8, angleUnit= []; end
-
-  [e, n, u] = ecef2enu(x, y, z, lat0, lon0, alt0, spheroid, angleUnit);
-  [az,el,slantRange] = enu2aer(e, n, u, angleUnit);
+[e, n, u] = ecef2enu(x, y, z, lat0, lon0, alt0, spheroid, angleUnit);
+[az,el,slantRange] = enu2aer(e, n, u, angleUnit);
 
 end
 

matlab/ecef2enu.m

@@ -12,11 +12,13 @@
 % -------
 % e,n,u:  East, North, Up coordinates of test points (meters)
 
-  if nargin < 7, spheroid = []; end
-  if nargin < 8, angleUnit = []; end
+narginchk(6,8)
 
-  [x0, y0, z0] = geodetic2ecef(spheroid, lat0, lon0, alt0, angleUnit);
-  [e, n, u]    = ecef2enuv(x - x0, y - y0, z - z0, lat0, lon0, angleUnit);
+if nargin < 7, spheroid = []; end
+if nargin < 8, angleUnit = []; end
+
+[x0, y0, z0] = geodetic2ecef(spheroid, lat0, lon0, alt0, angleUnit);
+[e, n, u]    = ecef2enuv(x - x0, y - y0, z - z0, lat0, lon0, angleUnit);
 end
 
 % Copyright (c) 2014-2018 Michael Hirsch, Ph.D.

matlab/ecef2enuv.m

@@ -1,4 +1,4 @@
-function [e, n, Up] = ecef2enuv (u, v, w, lat0, lon0, angleUnit)
+function [e, n, Up] = ecef2enuv(u, v, w, lat0, lon0, angleUnit)
 %ecef2enuv convert *vector projection* UVW to ENU
 %
 % Inputs
@@ -10,16 +10,27 @@
 % Outputs
 % -------
 % e,n,Up:  East, North, Up vector
-%
-  if nargin<6 || isempty(angleUnit) || strcmpi(angleUnit(1), 'd')
-    lat0 = deg2rad(lat0);
-    lon0 = deg2rad(lon0);
-  end
+narginchk(5,6)
+if nargin<6 || isempty(angleUnit), angleUnit='d'; end
+
+validateattributes(u, {'numeric'}, {'real'})
+validateattributes(v, {'numeric'}, {'real'})
+validateattributes(w, {'numeric'}, {'real'})
+validateattributes(lat0, {'numeric'}, {'real','>=',-90,'<=',90})
+validateattributes(lon0, {'numeric'}, {'real'})
+validateattributes(angleUnit,{'string','char'},{'scalar'})
+
+%% compute
+
+if strcmpi(angleUnit(1), 'd')
+  lat0 = deg2rad(lat0);
+  lon0 = deg2rad(lon0);
+end
 
-  t  =  cos(lon0) .* u + sin(lon0) .* v;
-  e  = -sin(lon0) .* u + cos(lon0) .* v;
-  Up =  cos(lat0) .* t + sin(lat0) .* w;
-  n  = -sin(lat0) .* t + cos(lat0) .* w;
+t  =  cos(lon0) .* u + sin(lon0) .* v;
+e  = -sin(lon0) .* u + cos(lon0) .* v;
+Up =  cos(lat0) .* t + sin(lat0) .* w;
+n  = -sin(lat0) .* t + cos(lat0) .* w;
 end
 
 % Copyright (c) 2014-2018 Michael Hirsch, Ph.D.

matlab/ecef2geodetic.m

@@ -1,4 +1,4 @@
-function [lat,lon,alt] = ecef2geodetic(spheroid, x, y, z,  angleUnit)
+function [lat,lon,alt] = ecef2geodetic(spheroid, x, y, z, angleUnit)
 %ecef2geodetic   convert ECEF to geodetic coordinates
 %
 % Inputs
@@ -13,49 +13,72 @@
 %
 % also see: http://www.oc.nps.edu/oc2902w/coord/coordcvt.pdf
 % Fortran reference at bottom of: http://www.astro.uni.torun.pl/~kb/Papers/geod/Geod-BG.htm
+narginchk(3,5)
+if isempty(spheroid)
+  spheroid = wgs84Ellipsoid();
+elseif isnumeric(spheroid) && nargin == 3
+  z = y;
+  y = x;
+  x = spheroid;
+  spheroid = wgs84Ellipsoid();
+elseif isnumeric(spheroid) && ischar(z) && nargin == 4
+  angleUnit = z;
+  z = y;
+  y = x;
+  x = spheroid;
+  spheroid = wgs84Ellipsoid();
+end
 
-  if isempty(spheroid), spheroid = wgs84Ellipsoid(); end
+if nargin < 5 || isempty(angleUnit), angleUnit='d'; end
 
-  % Algorithm is based on 
-  % http://www.astro.uni.torun.pl/~kb/Papers/geod/Geod-BG.htm
-  % This algorithm provides a converging solution to the latitude equation
-  % in terms of the parametric or reduced latitude form (v)
-  % This algorithm provides a uniform solution over all latitudes as it does
-  % not involve division by cos(phi) or sin(phi)
-   a = spheroid.SemimajorAxis; 
-   b = spheroid.SemiminorAxis;
-  r = hypot(x, y);
-  % Constant required for Latitude equation
-  rho = atan2(b * z, a * r);  
-  % Constant required for latitude equation
-  c = (a^2 - b^2) ./ hypot(a*r, b*z);  
-   count = 0;
+validateattributes(spheroid,{'struct'},{'nonempty'})
+validateattributes(x, {'numeric'}, {'real'})
+validateattributes(y, {'numeric'}, {'real'})
+validateattributes(z, {'numeric'}, {'real'})
+validateattributes(angleUnit,{'string','char'},{'scalar'})
+
+%% compute
+
+% Algorithm is based on 
+% http://www.astro.uni.torun.pl/~kb/Papers/geod/Geod-BG.htm
+% This algorithm provides a converging solution to the latitude equation
+% in terms of the parametric or reduced latitude form (v)
+% This algorithm provides a uniform solution over all latitudes as it does
+% not involve division by cos(phi) or sin(phi)
+a = spheroid.SemimajorAxis; 
+b = spheroid.SemiminorAxis;
+r = hypot(x, y);
+% Constant required for Latitude equation
+rho = atan2(b * z, a * r);  
+% Constant required for latitude equation
+c = (a^2 - b^2) ./ hypot(a*r, b*z);  
+count = 0;
 % Starter for the Newtons Iteration Method
-  vnew = atan2(a * z, b * r);  
+vnew = atan2(a * z, b * r);  
 % Initializing the parametric latitude
-   v = 0;
-  while v ~= vnew && count < 5
- %   disp([v,vnew])
-     v = vnew;
-    % Derivative of latitude equation
-    w = 2 * (cos (v - rho) - c .* cos(2 * v)); 
-    % Newtons Method for computing iterations  
-    vnew = v - ((2 * sin (v - rho) - c .* sin(2 * v)) ./ w);  
-    count = count+1;
-  end %while
+v = 0;
+while all(v ~= vnew) && count < 5
+%   disp([v,vnew])
+ v = vnew;
+% Derivative of latitude equation
+w = 2 * (cos (v - rho) - c .* cos(2 * v)); 
+% Newtons Method for computing iterations  
+vnew = v - ((2 * sin (v - rho) - c .* sin(2 * v)) ./ w);  
+count = count+1;
+end %while
 
 %% Computing latitude from the root of the latitude equation
-  lat = atan2(a * tan (vnew), b); 
-  % Computing longitude
-  lon = atan2(y, x); 
- % Computing h from latitude obtained 
-  alt = ((r - a * cos (vnew)) .* cos (lat)) +  ...
-      ((z - b * sin (vnew)) .* sin (lat));
-      
-  if nargin < 5 || isempty(angleUnit) || strcmpi(angleUnit(1),'d')
-    lat = rad2deg(lat);
-    lon = rad2deg(lon);
-  end
+lat = atan2(a * tan (vnew), b); 
+% Computing longitude
+lon = atan2(y, x); 
+% Computing h from latitude obtained 
+alt = ((r - a * cos (vnew)) .* cos (lat)) +  ...
+  ((z - b * sin (vnew)) .* sin (lat));
+
+if strcmpi(angleUnit(1),'d')
+  lat = rad2deg(lat);
+  lon = rad2deg(lon);
+end
 
  end % function