Changeset 8639

Timestamp:

06/15/11 11:58:50 (14 years ago)

Author:

jschierm

Message:

KMLOverlay: wrote usage function.

File:

• issm/trunk/src/mex/KMLOverlay/KMLOverlay.cpp (modified) (1 diff)

issm/trunk/src/mex/KMLOverlay/KMLOverlay.cpp

@@ -129 +129 @@
         _printf_(true,"KMLOverlay - KML file overlay module:\n");
         _printf_(true,"\n");
-        _printf_(true,"   This module reads a KML file.\n");
+        _printf_(true,"   This module reads a list of image files and writes a KML or KMZ overlay file.\n");
         _printf_(true,"\n");
         _printf_(true,"   Usage:\n");
-        _printf_(true,"      ierror=KMLMeshWrite(name,notes,elem,nodecon,lat,long,part,data,cmap,kmlfile);\n");
+        _printf_(true,"      ierror=KMLOverlay(kmlfile,'param name',param,...);\n");
         _printf_(true,"\n");
-        _printf_(true,"      name       model name (string, may be empty)\n");
-        _printf_(true,"      notes      model notes (string or cell array of strings, may be empty)\n");
-        _printf_(true,"      elem       elements (double array)\n");
-        _printf_(true,"      nodecon    nodal connectivity array (double array, may be empty)\n");
-        _printf_(true,"      lat        nodal latititudes (double vector)\n");
-        _printf_(true,"      long       nodal longitudes (double vector)\n");
-        _printf_(true,"      part       nodal partitions (double vector, may be empty)\n");
-        _printf_(true,"      data       nodal or element data (double vector, may be empty)\n");
-        _printf_(true,"      cmap       color map (double nx3 array, may be empty)\n");
-        _printf_(true,"      kmlfile    KML file name (string)\n");
+        _printf_(true,"      kmlfile     KML or KMZ file name (string)\n");
+        _printf_(true,"\n");
+        _printf_(true,"      lataxis     latitude axis (double vector [south north], required)\n");
+        _printf_(true,"      longaxis    longitude axis (double vector [west east], required)\n");
+        _printf_(true,"      images      relative or http image file names (string or array of strings or cell array of strings, required)\n");
+        _printf_(true,"      zip         flag to zip the doc.kml and image files into kmzfile (double, non-zero for kmz)\n");
         _printf_(true,"\n");
         _printf_(true,"      ierror     error flag (double, non-zero for error)\n");
         _printf_(true,"\n");
         _printf_(true,"   Example:\n");
-        _printf_(true,"      KMLMeshWrite(md.name,md.notes,md.elements,md.nodeconnectivity,md.lat,md.long,md.part,md.fm_criterion,options.cmap,filekml);\n");
+        _printf_(true,"      KMLOverlay(kmlfile,'lataxis',[south north],'longaxis',[west east],'images',{'file1.png','http://issm/file2.png'},'zip',1);\n");
         _printf_(true,"\n");
 }