summaryrefslogtreecommitdiff
path: root/macros/mscohere.sci
diff options
context:
space:
mode:
authoravinashlalotra2025-04-26 20:09:12 +0530
committeravinashlalotra2025-04-26 20:09:12 +0530
commitea7dcdba3b83696b97cc431ee050b58f9a0f3507 (patch)
tree49ea8ba898b88535c261546f4e3accbdf4c83bdf /macros/mscohere.sci
parent725d9ee2ddb254f57a896bb47e0e727759eb5901 (diff)
downloadFOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.tar.gz
FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.tar.bz2
FOSSEE-Signal-Processing-Toolbox-ea7dcdba3b83696b97cc431ee050b58f9a0f3507.zip
formated source documentation pattern for generating docs
Diffstat (limited to 'macros/mscohere.sci')
-rw-r--r--macros/mscohere.sci26
1 files changed, 13 insertions, 13 deletions
diff --git a/macros/mscohere.sci b/macros/mscohere.sci
index b9a45f8..4411a5c 100644
--- a/macros/mscohere.sci
+++ b/macros/mscohere.sci
@@ -1,17 +1,17 @@
-/*Description:
-Estimate (mean square) coherence of signals x and y. Use the Welch (1967) periodogram/FFT method.
-Calling Sequence:
- [Pxx, freq] = mscohere (x, y)
- […] = mscohere (x, y, window)
- […] = mscohere (x, y, window, overlap)
- […] = mscohere (x, y, window, overlap, Nfft)
- […] = mscohere (x, y, window, overlap, Nfft, Fs)
- […] = mscohere (x, y, window, overlap, Nfft, Fs, range)
- mscohere (…)
-See "help pwelch" for description of arguments, hints and references
-Dependencies : pwelch
-*/
function varargout = mscohere(varargin)
+// Estimate (mean square) coherence of signals x and y. Use the Welch (1967) periodogram/FFT method.
+// Calling Sequence:
+// [Pxx, freq] = mscohere (x, y)
+// […] = mscohere (x, y, window)
+// […] = mscohere (x, y, window, overlap)
+// […] = mscohere (x, y, window, overlap, Nfft)
+// […] = mscohere (x, y, window, overlap, Nfft, Fs)
+// […] = mscohere (x, y, window, overlap, Nfft, Fs, range)
+// mscohere (…)
+// Description:
+// See "help pwelch" for description of arguments, hints and references
+// Dependencies : pwelch
+
// Check fixed argument
if (nargin < 2 || nargin > 7)
error("Invalid number of arguments");