Skip to content

Commit 1b651af

Browse files
committed
Update HCOM documentaion
1 parent fd7d8a9 commit 1b651af

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

doc/userHCOMScripting.dox

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -595,6 +595,10 @@ Usage: e = bdf2(f)
595595
Rounds the value of each vector element to the smallest integer larger than the value<br>
596596
Usage: ceil(vector)
597597

598+
\subsection cut cut()
599+
Removes all samples x[i] for which y[i]<0.5<br>
600+
Usage: cut(x, y)
601+
598602
\subsection ddt ddt()
599603
Differentiates vector with respect to time (or to custom vector)<br>
600604
Usage: ddt(vector)<br>
@@ -609,6 +613,11 @@ Index-wise fuzzy equal check between vectors and/or scalars (equivalent to "=="
609613
Usage: eq(varName, threshold, eps)<br>
610614
Usage: eq(var1, var2, eps)
611615

616+
\subsection esd esd()
617+
Generates energy spectral density from vector<br>
618+
Usage: esd(vector, [timevector], [windowing]([rectangular]/flattop/hann), [mintime], [maxtime])<br>
619+
620+
612621
\subsection euler euler()
613622
Transforms derivatives in a symbolic expression using the forward Euler method<br>
614623
Usage: e = euler(f)
@@ -646,11 +655,9 @@ Converts variable to frequency domain.<br>
646655
Usage: y = fd(x)
647656

648657
\subsection fft fft()
649-
Generates frequency spectrum plot from vector<br>
650-
Usage: fft(vector)<br>
651-
Usage: fft(vector, power[true/false])<br>
652-
Usage: fft(vector, timevector)<br>
653-
Usage: fft(vector, timevector, power[true/false])
658+
Generates frequency spectrum plot from vector (deprecated)<br>
659+
Usage: fft(vector, [type]([power]/energy/rms), [windowing]([rectangular]/flattop/hann), [min], [max])<br>
660+
Usage: fft(vector, [timevector], [type]([power]/energy/rms), [windowing]([rectangular]/flattop/hann), [min], [max])
654661

655662
\subsection floor floor()
656663
Rounds the value of each vector element to the largest integer smaller than the value<br>
@@ -752,6 +759,11 @@ Usage: optvar(idx)
752759
Returns vector value at specified index<br>
753760
Usage: peek(vector, idx)
754761

762+
\subsection psd psd()
763+
Generates power spectral density from vector<br>
764+
Usage: psd(vector, [timevector], [windowing]([rectangular]/flattop/hann), [mintime], [maxtime])<br>
765+
766+
755767
\subsection rand rand()
756768
Generates a random value between 0 and 1<br>
757769
Usage: rand()
@@ -764,6 +776,15 @@ Usage: e = removeDivisors(f)
764776
Returns the right-hand side of a SymHop equation<br>
765777
Usage: e = right(f)
766778

779+
\subsection rms rms()
780+
Computes the root mean square of given vector<br>
781+
Usage: rms(vector)
782+
783+
\subsection rmsd rmsd()
784+
Generates root mean square spectral density from vector<br>
785+
Usage: rmsd(vector, [timevector], [windowing]([rectangular]/flattop/hann), [mintime], [maxtime])<br>
786+
787+
767788
\subsection round round()
768789
Rounds the value of each vector element to closest integer value<br>
769790
Usage: round(vector)
@@ -776,6 +797,16 @@ Usage: e = simplify(f)
776797
Calculate the size of a vector<br>
777798
Usage: size(vector)
778799

800+
\subsection ssi ssi()
801+
Identifies steady-state for specified variable<br>
802+
Usage: ssi(vector, method, arguments)<br>
803+
Method 0 (rectangular window):<br>
804+
ssi(vector, 0, tolerance, windowlength)<br>
805+
Method 1 (ratio of differently estimated variances):<br>
806+
ssi(vector, 1, tolerance, windowlength, noiseamplitude<br>
807+
Method 2 (ratio of differently estimated variances using weighted moving average):<br>
808+
ssi(vector, 2, tolerance, lambda1, lambda2, lambda3, noiseamplitude)
809+
779810
\subsection td td()
780811
Converts variable to time domain.<br>
781812
Usage: y = td(x)

0 commit comments

Comments
 (0)