Double1DCorrelation Class

Double1DCorrelation represents a 1D correlation, with a specified kernel and data length.

Inheritance Hierarchy

SystemObject
CenterSpace.NMath.CoreCorrelationBase
CenterSpace.NMath.CoreDouble1DCorrelation

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4

Syntax

C++

Copy

[SerializableAttribute]
public class Double1DCorrelation : CorrelationBase, 
	ICloneable

<SerializableAttribute>
Public Class Double1DCorrelation
	Inherits CorrelationBase
	Implements ICloneable

[SerializableAttribute]
public ref class Double1DCorrelation : public CorrelationBase, 
	ICloneable

[<SerializableAttribute>]
type Double1DCorrelation = 
    class
        inherit CorrelationBase
        interface ICloneable
    end

The Double1DCorrelation type exposes the following members.

Constructors

	Name	Description
	Double1DCorrelation(Double, Int32)	Constructs a correlation instance and defines the correlation kernel, and input signal data length.
	Double1DCorrelation(DoubleVector, Int32)	Constructs a correlation instance and defines the correlation kernel, and input signal data length.
	Double1DCorrelation(Double, Int32, Int32, Int32)	Constructs a correlation instance and defines the correlation kernel with a given offset and stride.

Top

Properties

	Name	Description
	DataLength	Gets the length of the correlation data. (Inherited from CorrelationBase)
	KernelLength	Gets the length of the correlation kernel. (Inherited from CorrelationBase)
	KernelShape	Gets the shape of the convolution kernel. (Inherited from CorrelationBase)
	Length	Gets the length of the correlation. (Inherited from CorrelationBase)

Top

Methods

	Name	Description
	Clone	Creates a deep copy of this correlation instance.
	Correlate(Double)	Computes the correlation between the stored correlation kernel, and the vector data.
	Correlate(DoubleVector)	Computes the correlation between the stored correlation kernel, and the vector data.
	Correlate(Double, Double)	Computes the correlation between the stored correlation kernel, and the vector data.
	Correlate(DoubleVector, DoubleVector)	Computes the correlation between the stored correlation kernel, and the vector data.
	Dispose	Clean up resources. (Inherited from CorrelationBase)
	Finalize	Provides non-deterministic destruction of underlying unmanaged resources. (Inherited from CorrelationBase)
	TrimConvolution	Creates a clipped view into the correlation. This does not create a copy of the input correlation.
	TrimCorrelationT	Creates a windowed view into the correlation. This does not create a copy of the input correlation. (Inherited from CorrelationBase)

Top

Fields

	Name	Description
	kerneloffset_	Offset into correlation kernel. (Inherited from CorrelationBase)
	kernelstride_	Correlation kernel stride. (Inherited from CorrelationBase)
	mode_	Mode is either automatic, fft, or direct sum. (Inherited from CorrelationBase)

Top

Remarks

The length of the correlation = length_of_data + length_of_kernel - 1. In general, unlike convolution, correlation is a non-communitive operation. Typically the kernel is shorter than the data and is used over many correlations operations against different data sets. This class is designed to be used in that fashion and the higest performance will be acheived if the kernel is fixed over a series of correlation operations.

Example

Copy

DoubleVector kernel = new DoubleVector(1, 2, 3, 1);
DoubleVector data = new DoubleVector(1, 2, 3, 4, 5, 6);

Double1DCorrelation corr = new Double1DCorrelation(kernel, data.Length);
DoubleVector correlation = corr.Correlate(data);

DoubleVector corr_full_kernel_overlap = corr.TrimConvolution(correlation, CorrelationBase.Windowing.FullKernelOverlap);
DoubleVector corr_centered = corr.TrimConvolution(correlation, CorrelationBase.Windowing.CenterWindow);

// correlation =            [1 5 11 18 25 32 32 17 6]
// corr_centered =              [11 18 25 32 32 17]
// corr_full_kernel_overlap =      [18 25 32]

Reference

CenterSpace.NMath.Core Namespace