FContiguousSparse2DKernelTransform

[FContiguousSparse2DKernelTransform](API\Runtime\SignalProcessing\DSP\FContiguousSparse2DKernelTransfo-)

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

/Engine/Source/Runtime/SignalProcessing/Public/DSP/FloatArrayMath.h

Include

#include "DSP/FloatArrayMath.h"

Syntax

class FContiguousSparse2DKernelTransform

Remarks

FContiguousSparse2DKernelTransform

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.

Constructors

Name Description

Public function

FContiguousSparse2DKernelTransform

(
    const FContiguousSparse2DKernelTran...
)

Public function

FContiguousSparse2DKernelTransform

(
    const FContiguousSparse2DKernelTran...
)

Public function

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.

Destructors

Functions

Name Description

Public function Const

int32

 

GetNumInElements()

Returns the required size of the input array

Public function Const

int32

 

GetNumOutElements()

Returns the size of the output array

Public function

void

 

SetRow

(
    const int32 RowIndex,
    const int32 StartIndex,
    TArrayView< const float > OffsetVal...
)

Set the kernel values for an individual row.

Public function Const

void

 

TransformArray

(
    TArrayView< const float > InView,
    TArray< float >& OutArray
)

Transforms the input array given the kernel.

Public function Const

void

 

TransformArray

(
    TArrayView< const float > InView,
    AlignedFloatBuffer& OutArray
)

Transforms the input array given the kernel.

Public function Const

void

 

TransformArray

(
    const float* InArray,
    float* OutArray
)

Transforms the input array given the kernel.

Operators

Name Description

Public function

FContiguousS...

 

operator=

(
    const FContiguousSparse2DKernelTran...
)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss