FContiguousSparse2DKernelTransform | Unreal Engine 5.6 Documentation

API > API/Runtime > API/Runtime/SignalProcessing

FContiguousSparse2DKernelTransform applies a matrix transformation to an input array. [OutArray] = [[Kernal]][InView]

It provides some optimization by exploit the contiguous and sparse qualities of the kernel rows, which allows it to skip multiplications with the number zero.

It works with non-sparse and non-contiguous kernels as well, but will be more computationally expensive than a naive implementation. Also, only takes advantage of sparse contiguous rows, not columns.


Name	FContiguousSparse2DKernelTransform
Type	class
Header File	/Engine/Source/Runtime/SignalProcessing/Public/DSP/FloatArrayMath.h
Include Path	#include "DSP/FloatArrayMath.h"

Syntax

class FContiguousSparse2DKernelTransform

Constructors

Name	Remarks	Include Path
FContiguousSparse2DKernelTransform ( const FContiguousSparse2DKernelTransform& )		DSP/FloatArrayMath.h
FContiguousSparse2DKernelTransform ( const FContiguousSparse2DKernelTransform&& )		DSP/FloatArrayMath.h
FContiguousSparse2DKernelTransform ( const int32 NumInElements, const int32 NumOutElements )	NumInElements sets the expected number of input array elements as well as the number of elements in a row.	DSP/FloatArrayMath.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FContiguousSparse2DKernelTransform()		DSP/FloatArrayMath.h

Structs

Name	Remarks
FRow

Variables

Protected

Name	Type	Include Path
Kernel	TArray< FRow >	DSP/FloatArrayMath.h
NumIn	int32	DSP/FloatArrayMath.h
NumOut	int32	DSP/FloatArrayMath.h

Functions

Public

Name	Remarks	Include Path
int32 GetNumInElements()	Returns the required size of the input array	DSP/FloatArrayMath.h
int32 GetNumOutElements()	Returns the size of the output array	DSP/FloatArrayMath.h
void SetRow ( const int32 RowIndex, const int32 StartIndex, TArrayView< const float > OffsetValues )	Set the kernel values for an individual row.	DSP/FloatArrayMath.h
void TransformArray ( TArrayView< const float > InView, TArray< float >& OutArray ) const	Transforms the input array given the kernel.	DSP/FloatArrayMath.h
void TransformArray ( TArrayView< const float > InView, FAlignedFloatBuffer& OutArray ) const	Transforms the input array given the kernel.	DSP/FloatArrayMath.h
void TransformArray ( const float* InArray, float* OutArray ) const	Transforms the input array given the kernel.	DSP/FloatArrayMath.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FContiguousSparse2DKernelTransform & operator= ( const FContiguousSparse2DKernelTransform& )		DSP/FloatArrayMath.h

Navigation