GTGRID User Guide > Reference > GTINSTALLSURF Function
  

GTINSTALLSURF Function
Creates a surface from grid and fault lines.
Usage
result = GTINSTALLSURF(thegrid)
Input Parameters
thegrid—A 2D floating-point array of grid data.
Returned Value
result—(long) The surface ID for the installed surface.
Keywords
Bounding_Poly—A 2D floating-point array specifying a bounding polygon for the generated grid.
Nsmooth—(integer) Specifies the number of smoothing passes made on the data. (Default: 20)
Nulval—(float) Specifies the numeric value used by the gridder for null or missing grid nodes in the resulting output grid. The default value is determined by inspecting the zvec array and computing:
Nulval = zmin - (zmax - zmin) 
Numpts—(long) Specifies the number of points in the vectors from which the grid was formed. (Default: the maximum lengths of the keywords Xvec, Yvec, and Zvec)
Nx—(integer or long) Specifies the number of columns in the result array. If Nx is not specified, but Ny is specified, then Nx is set equal to Ny. (Default: 20)
Ny—(integer or long) Specifies number of rows in the result array. If Ny is not specified, but Nx is specified, then Ny is set equal to Nx. (Default: 20)
Xfaults—A 1D array of floating-point values used to define faults relative to the xvec parameter. The values for Xfaults must be defined within the same coordinate system as the random data. There is no default for this keyword. If Xfaults is present, but Yfaults is not provided, an error message is produced and GTINSTALLSURF returns the scalar 0.0 as the results.
Xmax—(float) Defines the maximum x grid boundary in data coordinates. The default is the maximum value found in xvec.
Xmin—(float or double) Defines the minimum x grid boundary in data coordinates. The default is the minimum value found in xvec.
Xorg—(float) Specifies the x-coordinate of the origin of the generated grid. (Default: Xorg = xmin)
Xspacing—(float) Defines the spacing between consecutive nodes in the x direction. (Default: Xspacing = (xmax¦–xmin)/(nx–1))
Xvec—A 1D floating-point array containing the x vectors for the grid.
Yfaults—A 1D array of floating-point values used to define faults relative to the yvec parameter. The values of Yfaults must be defined within the same coordinate system as the random data. There is no default for this keyword. If Yfaults is present, but Xfaults is not provided, an error message is issued and GTINSTALLSURF returns the scalar 0.0 as the result.
Ymax—(float) Defines the maximum y grid boundary in data coordinates. The default value is the maximum value found in yvec.
Ymin—(float or double) Defines the minimum y grid boundary in data coordinates. The default is the minimum value found in yvec.
Yorg—(float) Specifies the y-coordinate of the origin of the generated grid. (Default: Yorg = ymin)
Yspacing—(float) Defines the spacing between consecutive nodes in the y direction. (Default: Yspacing = (ymax¦–ymin)/(ny–1))
Yvec—A 1D floating-point array containing the y vectors for the grid.
Zmax—(float) Defines the maximum z clipping plane in data coordinates. The default is the maximum value found in zvec.
Zmin—(float or double) Defines the minimum z clipping plane in data coordinates. The default is the minimum value found in zvec.
Zresolution—(float) The minimum meaningful difference in z values during gridding.
Zvec—A 1D floating-point array containing the z vectors for the grid.
Discussion
GTINSTALLSURF can be used to install grids from GTGRID 1.x for use with the functions and procedures in GTGRID 3.0 which require a valid surface ID as input. GTINSTALLSURF must be able to determine the original grid x and y node spacing, the grid origin, and the null value for the grid. This information may be explicitly supplied to GTINSTALLSURF using the Xspacing, Yspacing, Xorg, Yorg, and Nulval keywords; or GTINSTALLSURF will calculate these values given the x vector from which the grid was formed or the Xmin and Xmax values, the y vector from which the grid was formed or the Ymin and Ymax values, and the z vector from which the grid was formed or the Zmin and Zmax values.
 
note
Because GTINSTALLSURF must compute the Xmax, Xmin, Ymax, and Ymin values if you do not provide them, you can improve overall performance time by supplying values for these keywords.

Version 3.0
Copyright © 2017, Rogue Wave Software, Inc. All Rights Reserved.