.\" This page was automatically generated.  Do not edit!
.\"
.TH PLGRIDDATA 3plplot  "December, 2018" "" "PLplot API"
.SH NAME
\fBplgriddata\fP - Grid data from irregularly sampled data
.SH SYNOPSIS
\fBplgriddata\fP(\fIx\fP, \fIy\fP, \fIz\fP, \fInpts\fP, \fIxg\fP, \fInptsx\fP, \fIyg\fP, \fInptsy\fP, \fIzg\fP, \fItype\fP, \fIdata\fP)
.SH DESCRIPTION

.P
Real world data is frequently irregularly sampled, but PLplot 3D plots require data organized as a grid, i.e., with x sample point values independent of y coordinate and vice versa.  This function takes irregularly sampled data from the x[npts], y[npts], and z[npts] vectors; reads the desired grid location from the input vectors xg[nptsx] and yg[nptsy]; and returns the interpolated result on that grid using the output matrix zg[nptsx][nptsy].  The algorithm used to interpolate the data to the grid is specified with the argument type which can have one parameter specified in argument data.
.P
Redacted form: General: \fBplgriddata(x, y, z, xg, yg, zg, type, data)\fP
Python: \fIzg\fP=\fBplgriddata(x, y, z, xg, yg, type, data)\fP

.P
This function is used in example 21.
.SH ARGUMENTS
.TP
\fIx\fP (\fBPLFLT_VECTOR\fP(3plplot), input)
The input x vector.
.TP
\fIy\fP (\fBPLFLT_VECTOR\fP(3plplot), input)
The input y vector.
.TP
\fIz\fP (\fBPLFLT_VECTOR\fP(3plplot), input)
The input z vector. Each triple x[i], y[i], z[i] represents one data sample coordinate.
.TP
\fInpts\fP (\fBPLINT\fP(3plplot), input)
The number of data samples in the x, y and z vectors.
.TP
\fIxg\fP (\fBPLFLT_VECTOR\fP(3plplot), input)
A vector that specifies the grid spacing in the x direction. Usually xg has nptsx equally spaced values from the minimum to the maximum values of the x input vector.
.TP
\fInptsx\fP (\fBPLINT\fP(3plplot), input)
The number of points in the xg vector.
.TP
\fIyg\fP (\fBPLFLT_VECTOR\fP(3plplot), input)
A vector that specifies the grid spacing in the y direction. Similar to the xg parameter.
.TP
\fInptsy\fP (\fBPLINT\fP(3plplot), input)
The number of points in the yg vector.
.TP
\fIzg\fP (\fBPLFLT_NC_MATRIX\fP(3plplot), output)
The matrix of interpolated results where data lies in the grid specified by xg and yg. Therefore the zg matrix must be dimensioned \fInptsx\fP by \fInptsy\fP.
.TP
\fItype\fP (\fBPLINT\fP(3plplot), input)
The type of grid interpolation algorithm to use, which can be: GRID_CSA: Bivariate Cubic Spline approximation
GRID_DTLI: Delaunay Triangulation Linear Interpolation
GRID_NNI: Natural Neighbors Interpolation
GRID_NNIDW: Nearest Neighbors Inverse Distance Weighted
GRID_NNLI: Nearest Neighbors Linear Interpolation
GRID_NNAIDW:  Nearest Neighbors Around Inverse Distance Weighted
For details of the algorithms read the source file plgridd.c.
.TP
\fIdata\fP (\fBPLFLT\fP(3plplot), input)
Some gridding algorithms require extra data, which can be specified through this argument. Currently, for algorithm: GRID_NNIDW, data specifies the number of neighbors to use, the lower the value, the noisier (more local) the approximation is.
GRID_NNLI, data specifies what a thin triangle is, in the range [1. .. 2.]. High values enable the usage of very thin triangles for interpolation, possibly resulting in error in the approximation.
GRID_NNI, only weights greater than data will be accepted. If 0, all weights will be accepted.


.SH AUTHORS
Many developers (who are credited at http://plplot.org/credits.php)
have contributed to PLplot over its long history.
.SH SEE ALSO
PLplot documentation at http://plplot.org/documentation.php.
