Changeset 8062


Ignore:
Timestamp:
04/27/11 10:47:45 (14 years ago)
Author:
jschierm
Message:

KMLMeshWrite: minor clean-up.

Location:
issm/trunk/src/mex/KMLMeshWrite
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • issm/trunk/src/mex/KMLMeshWrite/KMLMeshWrite.cpp

    r7738 r8062  
    109109        if (verbose) printf("Parsing options:\n");
    110110        options=new Options(NRHS,nrhs,prhs);
     111//      if (options->Size()) for(i=0;i<options->Size();i++) ((Option*)options->GetObjectByOffset(i))->DeepEcho();
    111112
    112113        /*some checks*/
     
    171172void KMLMeshWriteUsage(void)
    172173{
    173         _printf_(true,"INTERFROMMESHTOMESH2D - interpolation from a 2d triangular mesh onto a list of point\n");
     174        _printf_(true,"KMLMeshWrite - KML mesh writer module:\n");
    174175        _printf_(true,"\n");
    175         _printf_(true,"   This function is a multi-threaded mex file that interpolates a field\n");
    176         _printf_(true,"   defined on a triangular mesh onto a list of point\n");
     176        _printf_(true,"   This module writes the mesh of a model as KML polygons into the specified KML file.\n");
    177177        _printf_(true,"\n");
    178178        _printf_(true,"   Usage:\n");
    179         _printf_(true,"         data_interp=InterpFromMeshToMesh2d(index,x,y,data,x_interp,y_interp);\n");
    180         _printf_(true,"      or data_interp=InterpFromMeshToMesh2d(index,x,y,data,x_interp,y_interp,default_value,contourname);\n");
     179        _printf_(true,"      ierror=KMLMeshWrite(name,notes,elem,nodecon,lat,long,part,data,cmap,kmlfile);\n");
    181180        _printf_(true,"\n");
    182         _printf_(true,"      index: index of the mesh where data is defined\n");
    183         _printf_(true,"      x,y: coordinates of the nodes where data is defined\n");
    184         _printf_(true,"      data: matrix holding the data to be interpolated onto the mesh. (one column per field)\n");
    185         _printf_(true,"      x_interp,y_interp: coordinates of the points onto which we interpolate.\n");
    186         _printf_(true,"      if default_value and contourname not specified: linear interpolation will happen on all x_interp,y_interp.\n");
    187         _printf_(true,"      if (default_value,contourname) specified: linear interpolation will happen on all x_interp,y_interp inside the contour, default value will be adopted on the rest of the mesh.\n");
    188         _printf_(true,"      note that default_value is either a scalar, or a vector of size  length(x_interp)\n");
    189         _printf_(true,"      data_interp: vector of mesh interpolated data.\n");
     181        _printf_(true,"      name       model name (string, may be empty)\n");
     182        _printf_(true,"      notes      model notes (string or cell array of strings, may be empty)\n");
     183        _printf_(true,"      elem       elements (double array)\n");
     184        _printf_(true,"      nodecon    nodal connectivity array (double array, may be empty)\n");
     185        _printf_(true,"      lat        nodal latititudes (double vector)\n");
     186        _printf_(true,"      long       nodal longitudes (double vector)\n");
     187        _printf_(true,"      part       nodal partitions (double vector, may be empty)\n");
     188        _printf_(true,"      data       nodal or element data (double vector, may be empty)\n");
     189        _printf_(true,"      cmap       color map (double nx3 array, may be empty)\n");
     190        _printf_(true,"      kmlfile    KML file name (string)\n");
     191        _printf_(true,"\n");
     192        _printf_(true,"      ierror     error flag (double, non-zero for error)\n");
    190193        _printf_(true,"\n");
    191194        _printf_(true,"   Example:\n");
    192         _printf_(true,"      load('temperature.mat');\n");
    193         _printf_(true,"      md.temperature=InterpFromMeshToMesh2d(index,x,y,temperature,md.x,md.y);\n");
    194         _printf_(true,"      md.temperature=InterpFromMeshToMesh2d(index,x,y,temperature,md.x,md.y,253,'Contour.exp');\n");
     195        _printf_(true,"      KMLMeshWrite(md.name,md.notes,md.elements,md.nodeconnectivity,md.lat,md.long,md.part,md.fm_criterion,options.cmap,filekml);\n");
    195196        _printf_(true,"\n");
    196197}
  • issm/trunk/src/mex/KMLMeshWrite/KMLMeshWrite.h

    r7655 r8062  
    11/*!\file KMLMeshWrite.h
    2  * \brief: prototype for Data Interpolation mex module.
     2 * \brief: prototype for KML mesh writer mex module.
    33 */
    44
Note: See TracChangeset for help on using the changeset viewer.