pyinterp.core.RTree3DFloat32.window_function

RTree3DFloat32.window_function(self: pyinterp.core.RTree3DFloat32, coordinates: numpy.ndarray[numpy.float32], radius: Optional[float] = None, k: int = 9, wf: pyinterp.core.WindowFunction = <WindowFunction.Hamming: 5>, arg: Optional[float] = None, within: bool = True, num_threads: int = 0) → tuple

Interpolation of the value at the requested position by window function.

Parameters:

  • coordinates – a matrix of shape (n, 3), where n is the number of observations and 3 represents the coordinates in the order: x, y, and z. If the matrix shape is (n, 2), the z-coordinate is assumed to be zero. The coordinates (x, y, z) are in the Cartesian coordinate system (ECEF) if the instance is configured to use this system (ecef keyword set to True during construction). Otherwise, the coordinates are in the geodetic system (longitude, latitude, and altitude) in degrees, degrees, and meters, respectively.

  • radius – The maximum radius of the search (m). Default to the largest value that can be represented on a float.

  • k – The number of nearest neighbors to be used for calculating the interpolated value. Defaults to 9.

  • wf – The window function to be used. Defaults to pyinterp.core.WindowFunction.Hamming.

  • arg – The optional argument of the window function. Defaults to None.

  • within – If true, the method ensures that the neighbors found are located around the point of interest. Defaults to true.

  • num_threads – The number of threads to use for the computation. If 0 all CPUs are used. If 1 is given, no parallel computing code is used at all, which is useful for debugging. Defaults to 0.

Returns:

The interpolated value and the number of neighbors used for the calculation.