This class implements tri-linear frame interpolator functions. More...

Static Public Member Functions
static bool	resize (const FramePyramid &source, uint8_t target, const unsigned int targetWidth, const unsigned int targetHeight, const unsigned int targetPaddingElements, Worker worker=nullptr)
	Resizes the finest layer of a given frame pyramid by a tri-linear interpolation and optionally uses a worker object to distribute the computational load. More...

static bool	resize (const FramePyramid &source, Frame &target, Worker *worker=nullptr)
	Resizes the finest layer of a given frame pyramid by a tri-linear interpolation and optionally uses a worker object to distribute the computational load. More...

static bool	resize (const Frame &source, Frame &target, Worker *worker=nullptr)
	Resizes a given frame by a tri-linear interpolation and optionally uses a worker object to distribute the computational load. More...

static bool	resize (Frame &frame, const unsigned int newWidth, const unsigned int newHeight, Worker *worker=nullptr)
	Resizes a given frame by a tri-linear interpolation and optionally uses a worker object to distribute the computational load. More...

template<unsigned int tChannels>
static void	homography8BitPerChannel (const FramePyramid &sourcePyramid, const unsigned int width, const unsigned int height, const SquareMatrix3 &homography, const uint8_t borderColor, uint8_t target, Worker *worker=nullptr)
	Transforms a given 8 bit per channel input frame into an output frame by application of a homography. More...

static Vector3	interpolatePosition (const unsigned int layerCount, const Vector2 &centerPosition, const Vector2 &cornerPosition1, const Vector2 &cornerPosition2, const Vector2 &cornerPosition3, const Vector2 &cornerPosition4)
	Calculates a 3D position usable for tri-linear interpolation. More...

template<unsigned int tChannels>
static void	interpolateFullBorder8BitPerChannel (const FramePyramid &framePyramid, const Vector3 &position, uint8_t *result)
	Performs a pixel lookup in the frame pyramid using tri-linear interpolation. More...

template<unsigned int tChannels, bool tAlphaAtFront, bool tTransparentIs0xFF>
static void	interpolateInfiniteBorder8BitPerChannelAlpha (const FramePyramid &framePyramid, const Vector3 &position, uint8_t *result)
	Performs a pixel lookup in the frame pyramid using tri-linear interpolation with infinite transparent frame border. More...

template<unsigned int tChannels>
static void	resize8BitPerChannel (const FramePyramid &source, uint8_t target, const unsigned int targetWidth, const unsigned int targetHeight, const unsigned int targetPaddingElements, Worker worker=nullptr)
	Renders the passed source frame pyramid into the target frame using tri-linear interpolation. More...

Static Protected Member Functions
template<unsigned int tChannels, void tBilinearInterpolationFunction, void tLinearInterpolationFunction>
static void	interpolate8BitPerChannel (const FramePyramid &framePyramid, const Vector3 &position, uint8_t *result)
	Performs a pixel lookup in the frame pyramid using tri-linear interpolation. More...

template<unsigned int tChannels>
static void	interpolateTwoPixels8BitPerChannel (const uint8_t first, const unsigned int firstFactor, const uint8_t second, uint8_t *result)
	This function determines the linear interpolation result for to given layer pixels. More...

template<unsigned int tChannels, bool tAlphaAtFront, bool tTransparentIs0xFF>
static void	interpolateTwoPixels8BitPerChannelAlpha (const uint8_t first, const unsigned int firstFactor, const uint8_t second, uint8_t *result)
	This function determines the linear interpolation result for to given layer pixels while the interpolation result respects the alpha values of both pixels. More...

template<unsigned int tChannels>
static void	resize8BitPerChannelSubset (const FramePyramid source, uint8_t target, const unsigned int targetWidth, const unsigned int targetHeight, const unsigned int targetPaddingElements, const unsigned int firstTargetRow, const unsigned int numberTargetRows)
	Renders the passed source frame pyramid into the target frame using tri-linear interpolation. More...

template<unsigned int tChannels>
static void	homography8BitPerChannelSubset (const FramePyramid sourcePyramid, const unsigned int width, const unsigned int height, const SquareMatrix3 homography, const uint8_t borderColor, uint8_t target, const unsigned int firstRow, const unsigned int numberRows)
	Transforms an 8 bit per channel frame using the given homography. More...

Detailed Description

This class implements tri-linear frame interpolator functions.

Member Function Documentation

◆ homography8BitPerChannel()

template<unsigned int tChannels>

void Ocean::CV::FrameInterpolatorTrilinear::homography8BitPerChannel	(	const FramePyramid &	sourcePyramid,
		const unsigned int	width,
		const unsigned int	height,
		const SquareMatrix3 &	homography,
		const uint8_t *	borderColor,
		uint8_t *	target,
		Worker *	worker = `nullptr`
	)

inlinestatic

Transforms a given 8 bit per channel input frame into an output frame by application of a homography.

Parameters

sourcePyramid	Frame pyramid of input frame that will be transformed
width	The width of both input images in pixel
height	The height of both input images pixel
homography	Homography used to transform the given input frame
borderColor	Color of undefined pixel positions, the size of the buffer must match to the number of channels, nullptr to assign 0x00 to each channel
target	Output frame using the given homography
worker	Optional worker object to distribute the computational load

Template Parameters

tChannels Number of channels of the frame

See also: homographyWithCamera8BitPerChannel().

◆ homography8BitPerChannelSubset()

template<unsigned int tChannels>

void Ocean::CV::FrameInterpolatorTrilinear::homography8BitPerChannelSubset	(	const FramePyramid *	sourcePyramid,
		const unsigned int	width,
		const unsigned int	height,
		const SquareMatrix3 *	homography,
		const uint8_t *	borderColor,
		uint8_t *	target,
		const unsigned int	firstRow,
		const unsigned int	numberRows
	)

staticprotected

Transforms an 8 bit per channel frame using the given homography.

Parameters

sourcePyramid	Frame pyramid of input frame that will be transformed
width	The width of both input images in pixel
height	The height of both input images pixel
homography	Homography used to transform the given input frame
borderColor	Color of undefined pixel positions, the size of the buffer must match to the number of channels, nullptr to assign 0x00 to each channel
target	Output frame resulting by application of the given homography
firstRow	The first row to be handled
numberRows	Number of rows to be handled

Template Parameters

tChannels Number of frame channels

◆ interpolate8BitPerChannel()

template<unsigned int tChannels, void tBilinearInterpolationFunction, void tLinearInterpolationFunction>

void Ocean::CV::FrameInterpolatorTrilinear::interpolate8BitPerChannel	(	const FramePyramid &	framePyramid,
		const Vector3 &	position,
		uint8_t *	result
	)

inlinestaticprotected

Performs a pixel lookup in the frame pyramid using tri-linear interpolation.

The position is given as 3D-vector, where x & y specify the 2d image coordinates in pixel units of the finest frame pyramid layer
and z specifies the pyramid layer index. Values with fractions for x,y & z are used as interpolation weights between neighboring pixels and layers.

Parameters

framePyramid	Frame pyramid to determine the pixel values from
position	Image coordinates (x, y) and layer (z), for which pixel values are interpolated using tri-linear interpolation within the range [0, framePyramid.finestLayerWidth()]x[0, framePyramid.finestLayerWidth()]x[0, layerCount - 1u]
result	Pointer to resulting interpolated pixel values (1Byte per color channel)

Template Parameters

tChannels	Defines the number of channels the frame holds
tBilinearInterpolationFunction	The bilinear interpolation function that will be used to interpolate the pixel values within one frame pyramid layer
tLinearInterpolationFunction	The linear interpolation function that will be used to interpolate the pixel values between two frame pyramid layers

See also: FrameInterpolatorBilinear::interpolatePixel8BitPerChannel(), FrameInterpolatorBilinear::interpolateFullAlphaBorder8BitPerChannel().

◆ interpolateFullBorder8BitPerChannel()

template<unsigned int tChannels>

void Ocean::CV::FrameInterpolatorTrilinear::interpolateFullBorder8BitPerChannel	(	const FramePyramid &	framePyramid,
		const Vector3 &	position,
		uint8_t *	result
	)

inlinestatic

Performs a pixel lookup in the frame pyramid using tri-linear interpolation.

The position is given as 3D-vector, where x & y specify the 2d image coordinates in pixel units of the finest frame pyramid layer
and z specifies the pyramid layer index. Values with fractions for x,y & z are used as interpolation weights between neighboring pixels and layers.

Parameters

framePyramid	Frame pyramid to determine the pixel values from
position	Image coordinates (x, y) and layer (z), for which pixel values are interpolated using tri-linear interpolation within the range [0, framePyramid.finestLayerWidth()]x[0, framePyramid.finestLayerWidth()]x[0, layerCount - 1u]
result	Pointer to resulting interpolated pixel values (1Byte per color channel)

Template Parameters

tChannels Defines the number of channels the frame holds

◆ interpolateInfiniteBorder8BitPerChannelAlpha()

template<unsigned int tChannels, bool tAlphaAtFront, bool tTransparentIs0xFF>

void Ocean::CV::FrameInterpolatorTrilinear::interpolateInfiniteBorder8BitPerChannelAlpha	(	const FramePyramid &	framePyramid,
		const Vector3 &	position,
		uint8_t *	result
	)

inlinestatic

Performs a pixel lookup in the frame pyramid using tri-linear interpolation with infinite transparent frame border.

The position is given as 3D-vector, where x & y specify the 2d image coordinates in pixel units of the finest frame pyramid layer
and z specifies the pyramid layer index. Values with fractions for x,y & z are used as interpolation weights between neighboring pixels and layers.

Parameters

framePyramid	Frame pyramid to determine the pixel values from
position	Image coordinates (x, y) and layer (z), for which pixel values are interpolated using tri-linear interpolation within the range [0, framePyramid.finestLayerWidth()]x[0, framePyramid.finestLayerWidth()]x[0, layerCount - 1u]
result	Pointer to resulting interpolated pixel values (1Byte per color channel)

Template Parameters

tChannels	Defines the number of channels the frame holds
tAlphaAtFront	True, if the alpha channel is in the front of the data channels
tTransparentIs0xFF	True, if 0xFF is interpreted as fully transparent

◆ interpolatePosition()

Vector3 Ocean::CV::FrameInterpolatorTrilinear::interpolatePosition	(	const unsigned int	layerCount,
		const Vector2 &	centerPosition,
		const Vector2 &	cornerPosition1,
		const Vector2 &	cornerPosition2,
		const Vector2 &	cornerPosition3,
		const Vector2 &	cornerPosition4
	)

inlinestatic

Calculates a 3D position usable for tri-linear interpolation.

The specified image coordinates define the center and four corner positions of quad. The center position determines the x- and y-coordinate of the resulting 3D sampling position. The corner positions determine the z-coordinate of the resulting sampling position and the pyramid layers from which samples are retrieved. The vertices have to be specified in clockwise order.

Parameters

layerCount	Number of layers supported by the pyramid
centerPosition	Quad center coordinates in pixels of the finest pyramid layer, used for the actual texture look-up
cornerPosition1	First quad corner coordinates in pixels of the finest pyramid layer, used for interpolation between pyramid layers
cornerPosition2	Second quad corner coordinates in pixels of the finest pyramid layer, used for interpolation between pyramid layers
cornerPosition3	Third quad corner coordinates in pixels of the finest pyramid layer, used for interpolation between pyramid layers
cornerPosition4	Fourth quad corner coordinates in pixels of the finest pyramid layer, used for interpolation between pyramid layers

Returns: The image coordinates (x, y) and layer (z) within the range [0, framePyramid.finestLayerWidth()]x[0, framePyramid.finestLayerWidth()]x[0, layerCount - 1u]

◆ interpolateTwoPixels8BitPerChannel()

template<unsigned int tChannels>

void Ocean::CV::FrameInterpolatorTrilinear::interpolateTwoPixels8BitPerChannel	(	const uint8_t *	first,
		const unsigned int	firstFactor,
		const uint8_t *	second,
		uint8_t *	result
	)

inlinestaticprotected

This function determines the linear interpolation result for to given layer pixels.

Parameters

first	The first pixel data
firstFactor	First interpolation factor, with range [0, 128]
second	The second pixel data
result	Interpolation result

Template Parameters

tChannels Defines the number of channels the frame holds

◆ interpolateTwoPixels8BitPerChannelAlpha()

template<unsigned int tChannels, bool tAlphaAtFront, bool tTransparentIs0xFF>

void Ocean::CV::FrameInterpolatorTrilinear::interpolateTwoPixels8BitPerChannelAlpha	(	const uint8_t *	first,
		const unsigned int	firstFactor,
		const uint8_t *	second,
		uint8_t *	result
	)

inlinestaticprotected

This function determines the linear interpolation result for to given layer pixels while the interpolation result respects the alpha values of both pixels.

Parameters

first	The first pixel data
firstFactor	First interpolation factor, with range [0, 128]
second	The second pixel data
result	Interpolation result

Template Parameters

tChannels	Defines the number of channels the frame holds
tAlphaAtFront	True, if the alpha channel is in the front of the data channels
tTransparentIs0xFF	True, if 0xFF is interpreted as fully transparent

◆ resize() [1/4]

static bool Ocean::CV::FrameInterpolatorTrilinear::resize	(	const Frame &	source,
		Frame &	target,
		Worker *	worker = `nullptr`
	)

static

Resizes a given frame by a tri-linear interpolation and optionally uses a worker object to distribute the computational load.

This method creates a new frame pyramid of the source frame, which creates additional computational load.

Parameters

source	The source frame buffer to resize
target	The target frame buffer
worker	Optional worker object used for load distribution

Returns: True, if the frame could be resized

◆ resize() [2/4]

static bool Ocean::CV::FrameInterpolatorTrilinear::resize	(	const FramePyramid &	source,
		Frame &	target,
		Worker *	worker = `nullptr`
	)

static

Resizes the finest layer of a given frame pyramid by a tri-linear interpolation and optionally uses a worker object to distribute the computational load.

Parameters

source	Frame pyramid whose finest layer is resized
target	The target frame buffer
worker	Optional worker object used for load distribution

Returns: True, if the frame could be resized

◆ resize() [3/4]

static bool Ocean::CV::FrameInterpolatorTrilinear::resize	(	const FramePyramid &	source,
		uint8_t *	target,
		const unsigned int	targetWidth,
		const unsigned int	targetHeight,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

static

Resizes the finest layer of a given frame pyramid by a tri-linear interpolation and optionally uses a worker object to distribute the computational load.

Beware: This method assumes that the pixel format of the target is identical to the pixel format of the frame pyramid.

Parameters

source	Frame pyramid provided the frame which will be resized
target	The target frame buffer
targetWidth	Width of the target frame in pixel, with range [1, infinity)
targetHeight	Height of the target frame in pixel, with range [1, infinity)
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object used for load distribution

Returns: True, if the frame could be resized

◆ resize() [4/4]

static bool Ocean::CV::FrameInterpolatorTrilinear::resize	(	Frame &	frame,
		const unsigned int	newWidth,
		const unsigned int	newHeight,
		Worker *	worker = `nullptr`
	)

static

Resizes a given frame by a tri-linear interpolation and optionally uses a worker object to distribute the computational load.

This method creates a new frame pyramid of the source frame, which creates additional computational load.

Parameters

frame	The frame to be resized in place
newWidth	New width of the frame in pixel, with range [1, infinity)
newHeight	New height of the frame in pixel, with range [1, infinity)
worker	Optional worker object used for load distribution

Returns: True, if the frame could be resized

◆ resize8BitPerChannel()

template<unsigned int tChannels>

void Ocean::CV::FrameInterpolatorTrilinear::resize8BitPerChannel	(	const FramePyramid &	source,
		uint8_t *	target,
		const unsigned int	targetWidth,
		const unsigned int	targetHeight,
		const unsigned int	targetPaddingElements,
		Worker *	worker = `nullptr`
	)

inlinestatic

Renders the passed source frame pyramid into the target frame using tri-linear interpolation.

Parameters

source	The source frame pyramid that is read from. The pyramid needs to have the appropriate layers
target	The target frame buffer
targetWidth	Width of the target frame in pixel
targetHeight	Height of the target frame in pixel
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
worker	Optional worker object used for load distribution

Template Parameters

tChannels Defines the number of channels the frame holds

◆ resize8BitPerChannelSubset()

template<unsigned int tChannels>

void Ocean::CV::FrameInterpolatorTrilinear::resize8BitPerChannelSubset	(	const FramePyramid *	source,
		uint8_t *	target,
		const unsigned int	targetWidth,
		const unsigned int	targetHeight,
		const unsigned int	targetPaddingElements,
		const unsigned int	firstTargetRow,
		const unsigned int	numberTargetRows
	)

staticprotected

Renders the passed source frame pyramid into the target frame using tri-linear interpolation.

Parameters

source	The source frame pyramid that is read from. The pyramid needs to have the appropriate layers
target	The target frame buffer
targetWidth	Width of the target frame in pixel
targetHeight	Height of the target frame in pixel
targetPaddingElements	The number of padding elements at the end of each target row, in elements, with range [0, infinity)
firstTargetRow	First (including) row to convert
numberTargetRows	Number of rows to convert

Template Parameters

tChannels Defines the number of channels the frame holds

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

FrameInterpolatorTrilinear.h

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ homography8BitPerChannel()

◆ homography8BitPerChannelSubset()

◆ interpolate8BitPerChannel()

◆ interpolateFullBorder8BitPerChannel()

◆ interpolateInfiniteBorder8BitPerChannelAlpha()

◆ interpolatePosition()

◆ interpolateTwoPixels8BitPerChannel()

◆ interpolateTwoPixels8BitPerChannelAlpha()

◆ resize() [1/4]

◆ resize() [2/4]

◆ resize() [3/4]

◆ resize() [4/4]

◆ resize8BitPerChannel()

◆ resize8BitPerChannelSubset()