Btwxt is a free and open source C++ library to perform numerical interpolation on a regular grid data set. The primary class is a RegularGridInterpolator constructed from:
- a set of N grid axes representing the values of the independent variables, and
- a collection of one or more grid point data sets aligned to the grid axes.
A RegularGridInterpolator object can then be queried repeatedly for interpolated values that fall inside its grid points, or extrapolated values beyond the grid points (up to a limit defined by the user).
Btwxt supports linear and cubic spline (Catmull-Rom) interpolation methods. Different methods can be specified for each axis. The API also allows specification of preferred extrapolation methods (constant or linear)--again independently for each axis--and extrapolation limits.
The grid is required to be regular (rectilinear), but the axes are not required to have uniform spacing. Each axis need only be strictly increasing.
The grid point data sets are imported as a single long vector (i.e., a flattened array). It is the user's responsibility to ensure that the grid point data is ordered according to the order of grid axes. Btwxt ensures that the number of grid points aligns with the total combined points of the grid axes.
An individual axis can be instantiated with:
std::vector<double> one_axis{6, 10, 15};
GridAxis(one_axis, "x"); // Construct a new axis named "x"
// interpolation method defaults to linear
// extrapolation method defaults to constant
// extrapolation limits default to {-DBL_MAX, DBL_MAX}
Method extrapolation_method = Method::linear;
Method interpolation_method = Method::cubic;
std::pair<double, double> extrapolation_limits{0, 20};
GridAxis(one_axis, "x", interpolation_method, extrapolation_method, extrapolation_limits);A RegularGridInterpolator holds a collection of axes and the corresponding grid point data at all permutations of the grid axes' values.
std::vector<std::vector<double>> vector_grid = {{6, 10, 15},
{4, 6, 9}};
std::vector<std::vector<double>> values = {...};
RegularGridInterpolator my_interpolator(vector_grid, values);Once you have an RegularGridInterpolator object, you can set a point to interpolate to:
std::vector<double> target{12.5, 5.1};
my_interpolator.set_target(target);
std::vector<double> result = my_interpolator.get_values_at_target();
// or set the target when requesting values:
std::vector<double> new_target{11.7, 6.1};
result = my_interpolator.get_values_at_target(new_target);We have overloaded the () operator on the RegularGridInterpolator to perform the interpolation, enabling the following:
std::vector<double> target{12.5, 5.1};
my_interpolator.set_target(target);
std::vector<double> result = my_interpolator();
std::vector<double> new_target{11.7, 6.1};
result = my_interpolator(new_target);