doc

scivision · scivision · commit 9b94342f87fd · 2020-09-02T18:28:21.000-04:00
diff --git a/+matmap3d/aer2ecef.m b/+matmap3d/aer2ecef.m
@@ -7,7 +7,7 @@
 % * az: azimuth clockwise from local north
 % * el: elevation angle above local horizon
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% outputs
diff --git a/+matmap3d/aer2geodetic.m b/+matmap3d/aer2geodetic.m
@@ -6,7 +6,7 @@
 % * az: azimuth clockwise from local north
 % * el: elevation angle above local horizon
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% Outputs
diff --git a/+matmap3d/ecef2aer.m b/+matmap3d/ecef2aer.m
@@ -4,7 +4,7 @@
 %%% Inputs
 % * x,y,z: Earth Centered Earth Fixed (ECEF) coordinates of test point (meters)
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% Outputs
diff --git a/+matmap3d/ecef2enu.m b/+matmap3d/ecef2enu.m
@@ -4,7 +4,7 @@
 %%% Inputs
 % * x,y,z: Earth Centered Earth Fixed (ECEF) coordinates of test point (meters)
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% outputs
diff --git a/+matmap3d/ecef2geodetic.m b/+matmap3d/ecef2geodetic.m
@@ -3,7 +3,7 @@
 %
 %%% Inputs
 % * x,y,z:  ECEF coordinates of test point(s) (meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% Outputs
diff --git a/+matmap3d/enu2ecef.m b/+matmap3d/enu2ecef.m
@@ -4,7 +4,7 @@
 %%% Inputs
 % * east, north, up: coordinates of test points (meters)
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% outputs
diff --git a/+matmap3d/enu2geodetic.m b/+matmap3d/enu2geodetic.m
@@ -4,7 +4,7 @@
 %%% Inputs
 % * east,north,up:  ENU coordinates of point(s) (meters)
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees, otherwise Radians
 %
 %%% outputs
diff --git a/+matmap3d/geodetic2aer.m b/+matmap3d/geodetic2aer.m
@@ -4,7 +4,7 @@
 %%% Inputs
 % * lat,lon, alt:  ellipsoid geodetic coordinates of point under test (degrees, degrees, meters)
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees, otherwise Radians
 %
 %%% Outputs
diff --git a/+matmap3d/geodetic2ecef.m b/+matmap3d/geodetic2ecef.m
@@ -3,7 +3,7 @@
 %
 %%% Inputs
 % * lat,lon, alt:  ellipsoid geodetic coordinates of point(s) (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% outputs
diff --git a/+matmap3d/geodetic2enu.m b/+matmap3d/geodetic2enu.m
@@ -4,7 +4,7 @@
 %%% Inputs
 % * lat,lon, alt:  ellipsoid geodetic coordinates of point under test (degrees, degrees, meters)
 % * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)
-% * spheroid: referenceEllipsoid parameter struct
+% * spheroid: referenceEllipsoid
 % * angleUnit: string for angular units. Default 'd': degrees
 %
 %%% outputs
diff --git a/+matmap3d/get_radius_normal.m b/+matmap3d/get_radius_normal.m
@@ -5,7 +5,7 @@
 %
 %%% Inputs
 % * lat: geodetic latitude in Radians
-% * ell: referenceEllipsoid() struct
+% * ell: referenceEllipsoid
 %
 %%% Outputs
 % * N: normal along the prime vertical section ellipsoidal radius of curvature, at a given geodetic latitude.
diff --git a/+matmap3d/wgs84Ellipsoid.m b/+matmap3d/wgs84Ellipsoid.m
@@ -1,5 +1,5 @@
 function E = wgs84Ellipsoid(lengthUnit)
-%% wgs84Ellipsoid  generate a WGS84 ellipsoid parameter struct
+%% wgs84Ellipsoid  generate a WGS84 referenceEllipsoid
 %
 %%%  Inputs
 %

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`% * az: azimuth clockwise from local north`
`8`	`8`	`% * el: elevation angle above local horizon`
`9`	`9`	`% * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)`
`10`		`-% * spheroid: referenceEllipsoid parameter struct`
	`10`	`+% * spheroid: referenceEllipsoid`
`11`	`11`	`% * angleUnit: string for angular units. Default 'd': degrees`
`12`	`12`	`%`
`13`	`13`	`%%% outputs`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`% * az: azimuth clockwise from local north`
`7`	`7`	`% * el: elevation angle above local horizon`
`8`	`8`	`% * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)`
`9`		`-% * spheroid: referenceEllipsoid parameter struct`
	`9`	`+% * spheroid: referenceEllipsoid`
`10`	`10`	`% * angleUnit: string for angular units. Default 'd': degrees`
`11`	`11`	`%`
`12`	`12`	`%%% Outputs`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`%%% Inputs`
`5`	`5`	`% * x,y,z: Earth Centered Earth Fixed (ECEF) coordinates of test point (meters)`
`6`	`6`	`% * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)`
`7`		`-% * spheroid: referenceEllipsoid parameter struct`
	`7`	`+% * spheroid: referenceEllipsoid`
`8`	`8`	`% * angleUnit: string for angular units. Default 'd': degrees`
`9`	`9`	`%`
`10`	`10`	`%%% Outputs`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`%`
`4`	`4`	`%%% Inputs`
`5`	`5`	`% * x,y,z: ECEF coordinates of test point(s) (meters)`
`6`		`-% * spheroid: referenceEllipsoid parameter struct`
	`6`	`+% * spheroid: referenceEllipsoid`
`7`	`7`	`% * angleUnit: string for angular units. Default 'd': degrees`
`8`	`8`	`%`
`9`	`9`	`%%% Outputs`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`%%% Inputs`
`5`	`5`	`% * east, north, up: coordinates of test points (meters)`
`6`	`6`	`% * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)`
`7`		`-% * spheroid: referenceEllipsoid parameter struct`
	`7`	`+% * spheroid: referenceEllipsoid`
`8`	`8`	`% * angleUnit: string for angular units. Default 'd': degrees`
`9`	`9`	`%`
`10`	`10`	`%%% outputs`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`%%% Inputs`
`5`	`5`	`% * east,north,up: ENU coordinates of point(s) (meters)`
`6`	`6`	`% * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)`
`7`		`-% * spheroid: referenceEllipsoid parameter struct`
	`7`	`+% * spheroid: referenceEllipsoid`
`8`	`8`	`% * angleUnit: string for angular units. Default 'd': degrees, otherwise Radians`
`9`	`9`	`%`
`10`	`10`	`%%% outputs`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`%%% Inputs`
`5`	`5`	`% * lat,lon, alt: ellipsoid geodetic coordinates of point under test (degrees, degrees, meters)`
`6`	`6`	`% * lat0, lon0, alt0: ellipsoid geodetic coordinates of observer/reference (degrees, degrees, meters)`
`7`		`-% * spheroid: referenceEllipsoid parameter struct`
	`7`	`+% * spheroid: referenceEllipsoid`
`8`	`8`	`% * angleUnit: string for angular units. Default 'd': degrees, otherwise Radians`
`9`	`9`	`%`
`10`	`10`	`%%% Outputs`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`%`
`6`	`6`	`%%% Inputs`
`7`	`7`	`% * lat: geodetic latitude in Radians`
`8`		`-% * ell: referenceEllipsoid() struct`
	`8`	`+% * ell: referenceEllipsoid`
`9`	`9`	`%`
`10`	`10`	`%%% Outputs`
`11`	`11`	`% * N: normal along the prime vertical section ellipsoidal radius of curvature, at a given geodetic latitude.`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`function E = wgs84Ellipsoid(lengthUnit)`
`2`		`-%% wgs84Ellipsoid generate a WGS84 ellipsoid parameter struct`
	`2`	`+%% wgs84Ellipsoid generate a WGS84 referenceEllipsoid`
`3`	`3`	`%`
`4`	`4`	`%%% Inputs`
`5`	`5`	`%`