Changeset 26959

Timestamp:

04/15/22 12:32:48 (3 years ago)

Author:

Mathieu Morlighem

Message:

CHG: better doc

File:

• issm/trunk-jpl/src/m/modules/CoordTransform.m (modified) (1 diff)

issm/trunk-jpl/src/m/modules/CoordTransform.m

@@ -4 +4 @@
 %   Usage:
 %      [xout,yout] = CoordTransform(xin,yin,projin,projout)
-%
-%   xin,  yin : input coordinates
-%   xout, yout: output coordinates (in new projection)
-%   projin,projout: input/output projection string (PROJ)
+%      - xin,  yin : input coordinates
+%      - xout, yout: output coordinates (in new projection)
+%      - projin,projout: input/output projection string (PROJ)
+%   
+%   Examples:
+%      [md.mesh.lat md.mesh.long] = CoordTransform(md.mesh.x,  md.mesh.y,   'EPSG:3413','EPSG:4326');
+%      [md.mesh.x   md.mesh.y]    = CoordTransform(md.mesh.lat,md.mesh.long,'EPSG:4326','EPSG:3413');
 %
 %   Example of Projections:
+%      lat/lon    = 'EPSG:4326'  or  lat/lon = '+proj=longlat +datum=WGS84'
+%      Greenland  = 'EPSG:3413' (polar stereographic 70N 45W)
+%      Antarctica = 'EPSG:3031' (polar stereographic 71S 0E)
+%      
+%   ll2xy previous default equivalent (uses with Hugues Ellispoid S)
+%      Greenland  = '+proj=stere +lat_0=90 +lat_ts=70 +lon_0=-45 +k=1 +x_0=0 +y_0=0 +a=6378273 +b=6356889.448564109 +units=m +no_defs'
+%      Antarctica = '+proj=stere +lat_0=-90 +lat_ts=-71 +lon_0=0 +k=1 +x_0=0 +y_0=0 +a=6378273 +b=6356889.448564109 +units=m +no_defs'
+%      Bamber Greenland = '+proj=stere +lat_0=90 +lat_ts=71 +lon_0=-39 +k=1 +x_0=0 +y_0=0 +ellps=WGS84 +datum=WGS84 +units=m +no_defs'
 %
-%   lat/lon = '+init=epsg:4326'
-%   lat/lon = '+proj=longlat +datum=WGS84'
-%
-%   ll2xy default equivalent (uses with Hugues Ellispoid S)
-%   Greenland = '+proj=stere +lat_0=90 +lat_ts=70 +lon_0=-45 +k=1 +x_0=0 +y_0=0 +a=6378273 +b=6356889.448564109 +units=m +no_defs'
-%   Antarctica = '+proj=stere +lat_0=-90 +lat_ts=-71 +lon_0=0 +k=1 +x_0=0 +y_0=0 +a=6378273 +b=6356889.448564109 +units=m +no_defs'
-%   Bamber Greenland = '+proj=stere +lat_0=90 +lat_ts=71 +lon_0=-39 +k=1 +x_0=0 +y_0=0 +ellps=WGS84 +datum=WGS84 +units=m +no_defs'
-%
-%   For latitude/longitude, x is longitude and y latitude and the angles are in 
-%   rad
-%
-%   This function will only work if PROJ has been installed and --with-proj-dir 
+%   This function will only work if PROJ has been installed and --with-proj-dir
 %   option has been set to its location in ISSM configuration