gis-tools-ts/dist/tools/interpolation/average.d.ts

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

import type { GetInterpolateValue } from './index.js';
import type { MValue, Properties, RGBA, VectorPoint } from '../../index.js';
/**
 * # Average Neighbor Interpolation
 *
 * ## Description
 * Finds the avarage point in the reference data to the given point and returns its value.
 *
 * ## Usage
 * ```ts
 * import { averageInterpolation, PointIndexFast } from 'gis-tools-ts';
 * import type { VectorPoint } from 'gis-tools-ts';
 *
 * // We have m-value data that we want to interpolate
 * interface TempData { temp: number; }
 *
 * const pointIndex = new PointIndexFast<TempData>();
 * // add lots of points
 * pointIndex.insertLonLat(lon, lat, data);
 * // ....
 *
 * // given a point we are interested in
 * const point: VectorPoint = { x: 20, y: -40 };
 * //  get a collection of points relative to the point
 * const data = await pointIndex.searchRadius(point.x, point.y, radius);
 *
 * // interpolate
 * const interpolatedValue = averageInterpolation<TempData>(point, data, (p) => p.m.temp);
 * ```
 * @param _point - Point to interpolate around. Unused for this method
 * @param refData - Reference data to search from
 * @param getValue - Function to get value from reference data
 * defaults to function that returns the z value or 0 if the z value is undefined
 * @returns - The avarage value of the collection of points
 */
export declare function averageInterpolation<T extends MValue = Properties>(_point: VectorPoint, refData: VectorPoint<T>[], getValue?: GetInterpolateValue<T>): number;
/**
 * Helper function for {@link averageInterpolation} on RGB(A) data.
 * Light in RGB data is logarithmically weighted (gamma corrected), so we need to expand each component by n^2 to
 * get the correct weight for each component.
 * @param point - Point to interpolate
 * @param refData - Reference data points
 * @returns - The interpolated RGBA data.
 */
export declare function rgbaAverageInterpolation(point: VectorPoint, refData: VectorPoint<RGBA>[]): RGBA;
//# sourceMappingURL=average.d.ts.map