Coherence (FPScript)

21.09.2021

Computes the coherence spectrum between two data sets.

Syntax

Coherence(SignalA, SignalB, [ SpectrumType = COHERENCE_MAGNITUDE2 ], [ Window = WIN_HANNING ], [ Adjustment ], [ SegmentLength = 0 ], [ OverlapOrGap = 50 ], [ FFTLength = 0 ] [ , Peaks ])

 

The syntax of the Coherence function consists of the following parts:

Part

Description

SignalA

The first data set to be analyzed.

Permitted data structures are data series, signal und signal series. All real data types are permitted, except calendar time und time span.

Void values are not permitted in this argument.

For the X component additional restrictions do apply.The values must have a constant positive spacing. Void values are not permitted in this argument.

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

SignalB

The second data set to be analyzed.

Permitted data structures are data series, signal und signal series. All real data types are permitted, except calendar time und time span.

Void values are not permitted in this argument.

For the X component additional restrictions do apply.The values must have a constant positive spacing. Void values are not permitted in this argument.

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

SpectrumType

The coherence or Signal to Noise Ratio format to be computed.

The argument SpectrumType can have the following values:

Constant

Meaning

COHERENCE_MAGNITUDE2

Magnitude² coherence

COHERENCE_SNR

Signal to Noise Ratio Spectrum

COHERENCE_SNR_DB

Signal to noise ratio in dB (decibels)

COHERENCE_SNR_DBNORM

Signal to noise ratio in dB (decibels) peak normalized to zero

+ SPECTRUM_PEAKS O

If this constant is added to one of the spectrum types above, then only peaks in the spectrum are output. Adding this constant is an alternative to specifying the Peaks argument with a value of 10.

O This constant requires the option Spectral Analysis to be licensed.

Permitted data structures are scalar value. All integral data types are permitted.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value COHERENCE_MAGNITUDE2.

Window

The fixed or adjustable data window to be applied to the data.

The argument Window can have the following values:

Constant

Meaning

WIN_RECTANGULAR

Rectangular -13 dB (no windowing, width=1)

WIN_WELCH

Welch -21 dB (fixed width=1.4)

WIN_SINE

Sine -23 dB (fixed width=1.5)

WIN_BISQUARE

Bi-Square or Connes -28 dB (fixed width=1.8)

WIN_BARTLETT

Bartlett -27 dB (fixed width=2)

WIN_HANNING

Hanning Max. Rolloff -31 dB (cosine, order 2, fixed width=2)

WIN_TUKEYHANN O

Tukey-Hann -37 dB (fixed width=2)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_BARTLETTMOD O

Modified Bartlett -39 dB (fixed width=2.3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_HAMMING

Hamming Min. Sidelobe -43 dB (cosine, order 2, fixed width=2)

WIN_COS3MAXROLLOFF O

C3 Max. Rolloff -47 dB (cosine, order 3, fixed width=3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS3BLACKMAN

Blackman -58 dB (cosine, order 3, fixed width=3)

WIN_COS3BHARRIS62 O

Blackman-Harris -62 dB (cosine, order 3, fixed width=3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS3NUTALL O

C1 Nutall -64 dB (cosine, order 3, fixed width=3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS3BLACKMANEXACT O

Blackman Exact -68 dB (cosine, order 3, fixed width=3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS3BHARRIS68 O

Blackman-Harris -68 dB (cosine, order 3, fixed width=3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS3MINSIDELOBE O

Nutall -71 dB (cosine, order 3, fixed width=3)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS4MAXROLLOFF O

C5 Max. Rolloff -61 dB (cosine, order 4, fixed width=4)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS4BHARRIS74 O

Blackman-Harris -74 dB (cosine, order 4, fixed width=4)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS4NUTALL83 O

C3 Nutall -83 dB (cosine, order 4, fixed width=4)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS4BHARRIS92 O

Blackman-Harris -92 dB (cosine, order 4, fixed width=4)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS4NUTALL93 O

C1 Nutall -93 dB (cosine, order 4, fixed width=4)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COS4NUTALL96 O

Nutall -96 dB (cosine, order 4, fixed width=4)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_FLATTOP

Flattop -68 dB (cosine, order 5, fixed width=5)

WIN_BETA O

Beta, Max. Rolloff (adjustable width=1.5-6)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COSMAXROLLOFF O

Cosine Max. Rolloff (adjustable width=1.5-6)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_KAISERBESSEL

Kaiser-Bessel (fixed width=3, adjustable width=1.5-6 with the Spectral Analysis option installed)

WIN_VANDERMAAS O

VanderMaas (adjustable width=1.5-6)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_CHEBYSHEV O

Chebyshev (adjustable width=1.75-5.75)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_CHEBYSHEVAPPROX O

Chebyshev Approx. (adjustable width=2.1-5)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_SLEPIAN O

Slepian DPSS-1 (adjustable width=2-5)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_GAUSS O

Gaussian (adjustable width=2-6)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

WIN_COSTAPER O

Tapered Cosine (adjustable width=1-2)

O This constant requires the option Order Tracking or the option Spectral Analysis to be licensed.

Permitted data structures are scalar value. All integral data types are permitted.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value WIN_HANNING.

Adjustment

The one-sided Fourier width as a multiple of the frequency interval. The valid range is window specific within 1.0 to 6.0. The default is 1.5 for a tapered cosine window and 3.0 for all other adjustable data windows.

Permitted data structures are scalar value. All real data types are permitted.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

SegmentLength

The length of individual data segments. The valid range is between 2 and the data length / 2. The default value of 0 sets the segment length to the data length / 4.

Permitted data structures are scalar value. All integral data types are permitted.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value 0.

OverlapOrGap

If this argument is specified as a positive number, then it specifies the percentage overlap of the individual data segments. If it is specified as a negative number, then its amount specifies the gap between the individual data segments in samples.

Permitted data structures are scalar value. All real data types are permitted.

The value must be less or equal to 95.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value 50.

FFTLength

The length of the Fourier transform. Zero padding applies if the FFT length is greater than the segment length. The valid range is from the segment length to the maximum limit of FFT. The default value is 0, which sets the FFT length equal to the segment length.

Permitted data structures are scalar value. All integral data types are permitted.

The value must be greater or equal to 0 and less or equal to 2147483648.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

If this argument is omitted, it will be set to the default value 0.

Peaks

If specified, then only band-interpolated peaks of the spectrum are output. The peaks can be specified as a number or determined using a dB threshold. Specify a number as a positive number from 1 to 100 without a unit. You can specify a dB threshold as a quantity with the unit dB between 0.01 dB and 300 dB, or as a negative number between -0.01 and -300 without a unit.

Permitted data structures are scalar value. All real data types are permitted.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

Remarks

The data structure of the result is a signal or signal series. If the argument SignalA is a data series or data matrix, then the X component of the result contains Nyquist-normalized frequencies. If both data sets have an X component, then these must be identical. The number of values in each data set and, in case of data matrices or signal series, also the number of columns must match. For example, you can combine a signal series with a signal. In this case the spectrum of the signal is combined with the spectra of each column in the signal series.

Available in

Option Spectral Analysis

Examples

Coherence('Signal A', 'Signal B', COHERENCE_MAGNITUDE2, WIN_COS3MINSIDELOBE + WIN_NORMALIZEPOWER, 3, 0, 50, 0)

Calculates the coherence spectrum of 'signal A' and 'signal B'. The window used is Cos 3 Minimum Sidelobe -71dB W=3, normalized to the power. The segment length amounts to data length/4, and the FFT length is set to the segment length. This is an example from the Cross Spectral Analysis Tutorial.

See Also

CrossPeriodogram Function

CrossSpectrum Function

TransferFunction Function

Spectral Analysis Option

Fourier Cross Spectral Analysis Object

Cross Spectral Measurements

Data Tapering Window

Fourier Spectral Analysis

Cross Spectral Analysis Tutorial

Share article or send as email:

You might be interested in these articles