summaryrefslogtreecommitdiff
path: root/macros/spectral_adf.sci
diff options
context:
space:
mode:
authoravinashlalotra2025-04-26 20:09:12 +0530
committeravinashlalotra2025-04-26 20:09:12 +0530
commitea7dcdba3b83696b97cc431ee050b58f9a0f3507 (patch)
tree49ea8ba898b88535c261546f4e3accbdf4c83bdf /macros/spectral_adf.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/spectral_adf.sci')
-rw-r--r--macros/spectral_adf.sci33
1 files changed, 17 insertions, 16 deletions
diff --git a/macros/spectral_adf.sci b/macros/spectral_adf.sci
index e1cc5a2..d1ca298 100644
--- a/macros/spectral_adf.sci
+++ b/macros/spectral_adf.sci
@@ -1,20 +1,21 @@
-/* spectral_adf
- Calling Sequence
- spectral_adf (c)
- spectral_adf (c, win)
- spectral_adf (c, win, b)
- Parameters
- c : Vector of autocovariances
- win : The window name . Default window is "triangle"
- b : Bandwidth. Default is 1/sqrt(length(c))
- Description
- Return the spectral density estimator given a vector of autocovariances c, window name win, and bandwidth, b.
- The window name, e.g., "triangle" or "rectangle" is used to search for a function called win_lw.
- If win is omitted, the triangle window is used.
- If b is omitted, 1 / sqrt (length (c)) is used.
- Dependencies: fft1 */
function sde = spectral_adf (c, win, b)
- //c should be a vector
+// spectral_adf
+// Calling Sequence
+// spectral_adf (c)
+// spectral_adf (c, win)
+// spectral_adf (c, win, b)
+// Parameters
+// c : Vector of autocovariances
+// win : The window name . Default window is "triangle"
+// b : Bandwidth. Default is 1/sqrt(length(c))
+// Description
+// Return the spectral density estimator given a vector of autocovariances c, window name win, and bandwidth, b.
+// The window name, e.g., "triangle" or "rectangle" is used to search for a function called win_lw.
+// If win is omitted, the triangle window is used.
+// If b is omitted, 1 / sqrt (length (c)) is used.
+// Dependencies: fft1
+
+ //c should be a vector
if ~isvector(c)
error("spectral_adf: input c should be a vector")
end