|  | Double | 
 Inheritance Hierarchy
Inheritance Hierarchy Syntax
SyntaxThe DoubleComplex1DCorrelation type exposes the following members.
 Constructors
Constructors| Name | Description | |
|---|---|---|
|  | DoubleComplex1DCorrelation(DoubleComplex, Int32) | Constructs a correlation instance and defines the correlation kernel, and input signal data length. | 
|  | DoubleComplex1DCorrelation(DoubleComplexVector, Int32) | Constructs a correlation instance and defines the correlation kernel, and input signal data length. | 
|  | DoubleComplex1DCorrelation(DoubleComplex, Int32, Int32, Int32) | Constructs a correlation instance and defines the correlation kernel with a given offset and stride. | 
 Properties
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) | 
 Methods
Methods| Name | Description | |
|---|---|---|
|  | Clone | Creates a deep copy of this correlation instance. | 
|  | Correlate(DoubleComplex) | Computes the correlation between the stored correlation kernel, and the vector data. | 
|  | Correlate(DoubleComplexVector) | Computes the correlation between the stored correlation kernel, and the vector data. | 
|  | Correlate(DoubleComplex, DoubleComplex) | Computes the correlation between the stored correlation kernel, and the vector data. | 
|  | Correlate(DoubleComplexVector, DoubleComplexVector) | 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) | 
|  | TrimCorrelation(DoubleComplexVector, CorrelationBaseWindowing) | Creates a clipped view into the correlation. This does not create a copy of the input correlation. | 
|  | TrimCorrelationT(T, CorrelationBaseWindowing) | Creates a windowed view into the correlation.  This does not create a copy of the input correlation. (Inherited from CorrelationBase) | 
 Fields
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) | 
 Remarks
Remarks Example
ExampleDoubleComplexVector kernel = new DoubleComplexVector(1, 2, 3, 1); DoubleComplexVector data = new DoubleComplexVector(1, 2, 3, 4, 5, 6); DoubleComplex1DCorrelation corr = new DoubleComplex1DCorrelation(kernel, data.Length); DoubleVector correlation = corr.Correlate(data); DoubleComplexVector corr_full_kernel_overlap = corr.TrimConvolution(correlation, CorrelationBase.Windowing.FullKernelOverlap); DoubleComplexVector 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]
 See Also
See Also