CorrelationMatching1D (FsODE)

FsODE

Documentation for 0.0.2

CorrelationMatching1D Type

Namespace: Altaxo.Science.Spectroscopy
Assembly: AltaxoCore.Redist.dll
Base Type: obj

Correlation matching of feature points in one dimension. Can be used for instance to correlate peak positions in two spectra.

Constructors

Constructor Description


                
                  
                    
                      CorrelationMatching1D(windowSize, array1, array2)

Full Usage: CorrelationMatching1D(windowSize, array1, array2)

Parameters:

windowSize : int - Size of the correlation window.

array1 : float[] - The first array (for instance: a spectrum).

array2 : float[] - The second array (for instance: a spectrum).

Initializes a new instance of the CorrelationMatching1D class.

windowSize : int: Size of the correlation window.
array1 : float[]: The first array (for instance: a spectrum).
array2 : float[]: The second array (for instance: a spectrum).

ArgumentException

Window size should be odd - windowSize


                
                  
                    
                      CorrelationMatching1D(windowSize, maxDistance, array1, array2)

Full Usage: CorrelationMatching1D(windowSize, maxDistance, array1, array2)

Parameters:

windowSize : int - Size of the correlation window.

maxDistance : float - The maximum distance to consider points as correlated.

array1 : float[] - The first array (for instance, a spectrum).

array2 : float[] - The second array (for instance, a spectrum).

Initializes a new instance of the CorrelationMatching1D class.

windowSize : int: Size of the correlation window.
maxDistance : float: The maximum distance to consider points as correlated.
array1 : float[]: The first array (for instance, a spectrum).
array2 : float[]: The second array (for instance, a spectrum).

ArgumentException

Window size should be odd - windowSize

Instance members

Instance member	Description
`this.DistanceMax` Full Usage: `this.DistanceMax`	Gets or sets the maximum distance to consider points as correlated. Default is 0 (consider all points).
`this.Match` Full Usage: `this.Match` Parameters: points1 : `IEnumerable<int>` - Set of feature points for the first array. points2 : `IEnumerable<int>` - Set of feature points for the second array. Returns: `int[][]`	Matches two sets of feature points computed from the given arrays (for instance, peak positions). points1 : `IEnumerable<int>` Set of feature points for the first array. points2 : `IEnumerable<int>` Set of feature points for the second array. Returns: `int[][]`
`this.Match` Full Usage: `this.Match` Parameters: points1 : `int[]` - Feature points of the first array (that was given in the constructor). points2 : `int[]` - Feature points of the second array (that was given in the constructor). Returns: `int[][]` A Nx2 matrix of correlating feature points.	Matches two sets of feature points computed from the given arrays. points1 : `int[]` Feature points of the first array (that was given in the constructor). points2 : `int[]` Feature points of the second array (that was given in the constructor). Returns: `int[][]` A Nx2 matrix of correlating feature points.
`this.Normalization` Full Usage: `this.Normalization`	Gets or sets the normalization treatment of the values in the windows, before the correlation value is calculated. Default is NormalizationMethod.Variance
`this.WindowSize` Full Usage: `this.WindowSize`	Gets or sets the size of the correlation window.

Static members

Static member	Description
`CorrelationMatching1D.Normalize(y, count, sy, syy, normalization)` Full Usage: `CorrelationMatching1D.Normalize(y, count, sy, syy, normalization)` Parameters: y : `float[]` count : `int` sy : `float` syy : `float` normalization : `NormalizationMethod`	y : `float[]` count : `int` sy : `float` syy : `float` normalization : `NormalizationMethod`