FBlockCorrelator

Correlation calculator which utilizes FFT to perform fast correlation calculations.

Windows
MacOS
Linux

References

Module

SignalProcessing

Header

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

Include

#include "DSP/BlockCorrelator.h"

Syntax

class FBlockCorrelator

Remarks

Correlation calculator which utilizes FFT to perform fast correlation calculations.

Constructors

Name Description

Public function

FBlockCorrelator

(
    const FBlockCorrelatorSettings& In...
)

Construct a block correlator with FBlockCorrelatorSettings

Functions

Name Description

Public function

void

 

AutoCorrelate

(
    const AlignedFloatBuffer& Input,
    AlignedFloatBuffer& Output
)

Autocorrelate an input signal.

Public function

void

 

CrossCorrelate

(
    const AlignedFloatBuffer& InputA,
    const AlignedFloatBuffer& InputB,
    AlignedFloatBuffer& Output
)

Cross correlate two input signals.

Public function Const

int32

 

GetNumInputValues()

Returns the number of input values to use when calling CrossCorrelate(...) or AutoCorrelate(...)

Public function Const

int32

 

GetNumOutputValues()

Returns the number of output values to use when calling CrossCorrelate(...) or AutoCorrelate(...)

Public function Const

const FBlock...

 

GetSettings()

Return settings used to construct block correlator.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss