meshkernel::BilinearInterpolationOnGriddedSamples< T > Class Template Reference

A class for performing bilinear interpolation on gridded samples. More...

#include <BilinearInterpolationOnGriddedSamples.hpp>

Inheritance diagram for meshkernel::BilinearInterpolationOnGriddedSamples< T >:

Public Member Functions
	BilinearInterpolationOnGriddedSamples (const Mesh2D &mesh, UInt numXCoord, UInt numYCoord, const Point &origin, double cellSize, std::span< T const > values)
	Bilinear interpolation with constant cell size (faster because no linear search is performed for each mesh node)
	BilinearInterpolationOnGriddedSamples (const Mesh2D &mesh, std::span< double const > xCoordinates, std::span< double const > yCoordinates, std::span< T const > values)
	Bilinear interpolation with non constant cell size (slower because linear search is performed for each mesh node)
void	Compute () override
	Compute interpolation.
Public Member Functions inherited from meshkernel::MeshInterpolation
virtual	~MeshInterpolation ()=default
	Virtual destructor.
double	GetNodeResult (UInt node) const
	Gets the interpolation value at a specific node.
double	GetEdgeResult (UInt edge) const
	Gets the interpolation value at a specific edge.
double	GetFaceResult (UInt face) const
	Gets the interpolation value at a specific face.
const std::vector< double > &	GetNodeResults () const
	Gets all interpolated values at nodes.
const std::vector< double > &	GetEdgeResults () const
	Gets all interpolated values at edges.
const std::vector< double > &	GetFaceResults () const
	Gets all interpolated values at faces.

Additional Inherited Members
Protected Attributes inherited from meshkernel::MeshInterpolation
std::vector< double >	m_nodeResults
	The interpolation results at nodes.
std::vector< double >	m_edgeResults
	The interpolation results at edges.
std::vector< double >	m_faceResults
	The interpolation results at faces.

Detailed Description

template<InterpolatableType T>
class meshkernel::BilinearInterpolationOnGriddedSamples< T >

A class for performing bilinear interpolation on gridded samples.

Constructor & Destructor Documentation

BilinearInterpolationOnGriddedSamples() [1/2]

template<InterpolatableType T>

meshkernel::BilinearInterpolationOnGriddedSamples< T >::BilinearInterpolationOnGriddedSamples	(	const Mesh2D &	mesh,
		UInt	numXCoord,
		UInt	numYCoord,
		const Point &	origin,
		double	cellSize,
		std::span< T const >	values
	)

Bilinear interpolation with constant cell size (faster because no linear search is performed for each mesh node)

Parameters

[in]	mesh	The input mesh
[in]	numXCoord	The number of x coordinates of the gridded data
[in]	numYCoord	The number of y coordinates of the gridded data
[in]	origin	The coordinate of the grid origin
[in]	cellSize	The grid cell size
[in]	values	The values of the gridded samples

BilinearInterpolationOnGriddedSamples() [2/2]

template<InterpolatableType T>

meshkernel::BilinearInterpolationOnGriddedSamples< T >::BilinearInterpolationOnGriddedSamples	(	const Mesh2D &	mesh,
		std::span< double const >	xCoordinates,
		std::span< double const >	yCoordinates,
		std::span< T const >	values
	)

Bilinear interpolation with non constant cell size (slower because linear search is performed for each mesh node)

Parameters

[in]	mesh	The input mesh
[in]	xCoordinates	The x coordinates of the grid
[in]	yCoordinates	The y coordinates of the grid
[in]	values	The values of the gridded samples

Member Function Documentation

Compute()

template<InterpolatableType T>

void meshkernel::BilinearInterpolationOnGriddedSamples< T >::Compute ( )

overridevirtual

Compute interpolation.

Implements meshkernel::MeshInterpolation.

---

The documentation for this class was generated from the following file:

• /home/runner/work/MeshKernel/MeshKernel/libs/MeshKernel/include/MeshKernel/BilinearInterpolationOnGriddedSamples.hpp