Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Correlation calculator which utilizes FFT to perform fast correlation calculations.
| Name | FBlockCorrelator |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/BlockCorrelator.h |
| Include Path | #include "DSP/BlockCorrelator.h" |
Syntax
class FBlockCorrelator
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBlockCorrelator
(
const FBlockCorrelatorSettings& InSettings |
Construct a block correlator with FBlockCorrelatorSettings | DSP/BlockCorrelator.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ComplexBufferA | FAlignedFloatBuffer | DSP/BlockCorrelator.h | ||
| ComplexBufferB | FAlignedFloatBuffer | DSP/BlockCorrelator.h | ||
| ComplexCorrelationBuffer | FAlignedFloatBuffer | DSP/BlockCorrelator.h | ||
| FFTAlgorithm | TUniquePtr< IFFTAlgorithm > | DSP/BlockCorrelator.h | ||
| FullOutputBuffer | FAlignedFloatBuffer | DSP/BlockCorrelator.h | ||
| NormalizationBuffer | FAlignedFloatBuffer | DSP/BlockCorrelator.h | ||
| NumValuesInBlock | int32 | DSP/BlockCorrelator.h | ||
| NumValuesInFFTComplexBuffer | int32 | DSP/BlockCorrelator.h | ||
| NumValuesInFFTRealBuffer | int32 | DSP/BlockCorrelator.h | ||
| Settings | FBlockCorrelatorSettings | DSP/BlockCorrelator.h | ||
| Window | FWindow | DSP/BlockCorrelator.h | ||
| WindowedBufferA | FAlignedFloatBuffer | DSP/BlockCorrelator.h | ||
| WindowedBufferB | FAlignedFloatBuffer | DSP/BlockCorrelator.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AutoCorrelate
(
const FAlignedFloatBuffer& Input, |
Autocorrelate an input signal. | DSP/BlockCorrelator.h | |
void CrossCorrelate
(
const FAlignedFloatBuffer& InputA, |
Cross correlate two input signals. | DSP/BlockCorrelator.h | |
int32 GetNumInputValues() |
Returns the number of input values to use when calling CrossCorrelate(...) or AutoCorrelate(...) | DSP/BlockCorrelator.h | |
int32 GetNumOutputValues() |
Returns the number of output values to use when calling CrossCorrelate(...) or AutoCorrelate(...) | DSP/BlockCorrelator.h | |
const FBlockCorrelatorSettings & GetSettings() |
Return settings used to construct block correlator. | DSP/BlockCorrelator.h |