Skip to content

Commit

Permalink
Update HCOM documentaion
Browse files Browse the repository at this point in the history
  • Loading branch information
peterNordin committed Jul 11, 2022
1 parent fd7d8a9 commit 1b651af
Showing 1 changed file with 36 additions and 5 deletions.
41 changes: 36 additions & 5 deletions doc/userHCOMScripting.dox
Original file line number Diff line number Diff line change
Expand Up @@ -595,6 +595,10 @@ Usage: e = bdf2(f)
Rounds the value of each vector element to the smallest integer larger than the value<br>
Usage: ceil(vector)

\subsection cut cut()
Removes all samples x[i] for which y[i]<0.5<br>
Usage: cut(x, y)

\subsection ddt ddt()
Differentiates vector with respect to time (or to custom vector)<br>
Usage: ddt(vector)<br>
Expand All @@ -609,6 +613,11 @@ Index-wise fuzzy equal check between vectors and/or scalars (equivalent to "=="
Usage: eq(varName, threshold, eps)<br>
Usage: eq(var1, var2, eps)

\subsection esd esd()
Generates energy spectral density from vector<br>
Usage: esd(vector, [timevector], [windowing]([rectangular]/flattop/hann), [mintime], [maxtime])<br>


\subsection euler euler()
Transforms derivatives in a symbolic expression using the forward Euler method<br>
Usage: e = euler(f)
Expand Down Expand Up @@ -646,11 +655,9 @@ Converts variable to frequency domain.<br>
Usage: y = fd(x)

\subsection fft fft()
Generates frequency spectrum plot from vector<br>
Usage: fft(vector)<br>
Usage: fft(vector, power[true/false])<br>
Usage: fft(vector, timevector)<br>
Usage: fft(vector, timevector, power[true/false])
Generates frequency spectrum plot from vector (deprecated)<br>
Usage: fft(vector, [type]([power]/energy/rms), [windowing]([rectangular]/flattop/hann), [min], [max])<br>
Usage: fft(vector, [timevector], [type]([power]/energy/rms), [windowing]([rectangular]/flattop/hann), [min], [max])

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

\subsection psd psd()
Generates power spectral density from vector<br>
Usage: psd(vector, [timevector], [windowing]([rectangular]/flattop/hann), [mintime], [maxtime])<br>


\subsection rand rand()
Generates a random value between 0 and 1<br>
Usage: rand()
Expand All @@ -764,6 +776,15 @@ Usage: e = removeDivisors(f)
Returns the right-hand side of a SymHop equation<br>
Usage: e = right(f)

\subsection rms rms()
Computes the root mean square of given vector<br>
Usage: rms(vector)

\subsection rmsd rmsd()
Generates root mean square spectral density from vector<br>
Usage: rmsd(vector, [timevector], [windowing]([rectangular]/flattop/hann), [mintime], [maxtime])<br>


\subsection round round()
Rounds the value of each vector element to closest integer value<br>
Usage: round(vector)
Expand All @@ -776,6 +797,16 @@ Usage: e = simplify(f)
Calculate the size of a vector<br>
Usage: size(vector)

\subsection ssi ssi()
Identifies steady-state for specified variable<br>
Usage: ssi(vector, method, arguments)<br>
Method 0 (rectangular window):<br>
ssi(vector, 0, tolerance, windowlength)<br>
Method 1 (ratio of differently estimated variances):<br>
ssi(vector, 1, tolerance, windowlength, noiseamplitude<br>
Method 2 (ratio of differently estimated variances using weighted moving average):<br>
ssi(vector, 2, tolerance, lambda1, lambda2, lambda3, noiseamplitude)

\subsection td td()
Converts variable to time domain.<br>
Usage: y = td(x)
Expand Down

0 comments on commit 1b651af

Please sign in to comment.