| Function Name |
Description |
| abs |
Magnitude of a number x. |
| abssum |
Sums the magnitude of each element in x. |
| ang |
Phase of a complex number x in radians. |
| ang360 |
Phase of a complex number x in radians. |
| acos |
Inverse cosine of x. |
| acosh |
Inverse hyperbolic cosine of x. |
| array |
builds an array with dimensions x by y by ... (can take in any number of arguments, but at least 1). |
| asin |
Inverse sine of x. |
| asinh |
Inverse hyperbolic sine of x. |
| atan |
Inverse tangent of x. |
| atanh |
Inverse hyperbolic tangent of x. |
| beta |
Evaluates the Beta function for corresponding elements of z and w, which must be non-negative real values. |
| betacdf |
Returns the cumulative distribution function of the Beta distribution with parameters a and b evaluated at the
elements of x. |
| betainc |
Evaluates the incomplete Beta function for corresponding elements of x, z, and w. x must be between 0 and 1. z and
w must be non-negative real values. |
| betainv |
Returns the inverse of the Beta cumulative distribution function with parameters a and b evaluated at the elements of p. |
| betaln |
Evaluates the natural logarithm of the Beta function for corresponding elements of z and w, which must be non-negative
real values. |
| betapdf |
Returns the probability distribution function of the Beta distribution with parameters a and b evaluated at the elements of x. |
| ceil |
Returns the smallest integer greater than or equal to x. If x is complex, only the real part is used. |
| column |
Force a row or column vector x to be a column vector. |
| complex |
Returns the complex number x + jy. |
| concatcolumns |
Concatenates matrices or vectors x and y. The number of rows of x and y must be equal. |
| conj |
Complex conjugate of x. |
| cos |
Cosine of x, where x is in radians. |
| cosh |
Hyperbolic cosine of x. |
| cp |
Process capability index. |
| cpk |
Process capability index accounting for the mean. |
| cplower |
Lower process capability index. |
| cpupper |
Upper process capability index. |
| db |
x expressed in decibels as 20*log(x). |
| db10 |
x expressed in decibels as 10*log(x). |
| dbm |
Returns the dBm equivalent of x Watts. |
| dbmtow |
Returns the Watts equivalent of x dBm. |
| dbpolar |
Returns the complex value of a voltage in dB and the angle in degrees. |
| derivative |
returns a vector that is the derivative at each point of the dependent with respect to independent vector. |
| dev_lin_phase |
returns a vector in radians of deviation from linear phase; this function is a clone of the ADS function by the same name. |
| diag |
If the argument is a matrix, this returns a vector with the diagonal elements. Otherwise, the argument must be a vector,
and diag creates a matrix with the vector on the diagonal and all other elements zero. |
| erf |
Computes the error function of each element x. |
| erfc |
Computes the complementary error function of each element of x. |
| exp |
e to the power of x, where e = 2.7182817... |
| eye |
Function to build an eye diagram from transient data. symbolRate is in Hz, numCycles is the number of cycles to plot before
wrapping (optional), and delay is the number of samples of delay (optional). |
| fft |
Discrete Fourier Transform (DFT) of data, computed with FFT algorithm when possible. The len argument (the FFT Length) is
optional. |
| floor |
Returns the largest integer less than or equal to x. If x is complex, only the real part is used. |
| gamma |
Evaluates the Gamma function for each element of x, which must be real. |
| gammainc |
Evaluates the incomplete Gamma function for each element of x, which must be real. |
| gammaln |
Evaluates the natural logarithm of the Gamma function for each element of x without computing the Gamma function itself. |
| gammatoz |
Returns the complex impedance given the normalizing impedance and the voltage reflection coefficient (gamma). |
| getdbunit |
Returns the appropriate dB unit: RelDB10 if the input units are power or RelDB20 if the input units are voltage/current. |
| getindep |
Returns the string property containing the path to the independent value of a variable x. (ie. the reference to the independent
variable) |
| getindepvalue |
Returns the value of the independent variable of a variable x. x must have only one independent value. |
| getunits |
Returns an integer corresponding to the units of a variable x. This integer may be used by setunits. |
| hb_gain |
Calculates the complex gain for selected spectral component. |
| hb_getspcomp |
Returns the complex amplitude of the spectral component in Watts. |
| hb_getspcompdbm |
Returns the amplitude of the spectral component in dBm. |
| hb_iipn |
Returns the input intercept point of two components IndexS1 and IndexS2 of the power spectrum SpectrPout. |
| hb_ipn |
Calculates the common part of the input and output intercept point functions (hb_iipn and hb_oipn). |
| hb_larges |
Calculates the Large Signal S-parameter for a 1-tone HB analysis. |
| hb_largesmix |
Calculates the LargeSignal S-parameter for multi-tone HB analyses. |
| hb_oipn |
Calculates the output intercept of the two components IndexS1 and IndexS2 of the power Spectrum SpectrPout. |
| hb_spurious |
Calculates the max amplitude of spurious spectral components in the spectrum SpectrVout. |
| hb_totalsp |
Calculates total amplitude for spectral components having the same frequency and sets all of them to the same total amplitude. |
| hb_transgain |
Calculates the transducer gain. |
| hb_transgaindb |
Calculates the transducer gain in dB. |
| histogram |
creates bins for the data in x and returns the number of elements in each container. |
| hermitian |
conjugate transpose of a matrix or swept matrix x |
| identity |
Returns an nxn identity matrix. (Datatype is Complex) |
| iff |
Returns value1 if boolean expression is true, otherwise value2. |
| ifft |
Inverse Discrete Fourier Transform (IDFT) of data, computed with IFFT algorithm when possible. The len argument (IFFT length)
is optional. |
| iftrue |
If x is true, return y. x and y may be vectors. |
| imag |
Imaginary part of a (complex) number x. |
| im |
Same as imag(x). |
| integrate |
Numerically integrate the dependent with respect to independent, from index = start to index = stop. |
| interpolate |
Produces an array where the independent value of var is changed to new_indep, interpolating as necessary. |
| intersect |
Produces a vector representing a set which is the intersection of two sets (vectors) x and y. |
| inverse |
Returns the inverse of a non-singular matrix x. |
| kurtosis |
Returns the sample Kurtosis of x. |
| largeS |
returns the largeSij for this HB dataset |
| lininterp |
Returns the linear interpolation of the output values given the data values of indep and dep. |
| ln |
Natural logarithm of x. |
| log |
Logarithm (base 10) of x. |
| mag |
Same as abs(x). |
| matrix |
Builds an x by y matrix of complex numbers. Elements are initialized to zero. |
| max |
Returns the maximum (magnitude) element of any array x on the dimension iDim. |
| mean |
Returns average of all elements in a vector or an array on the dimension iDim. |
| median |
Returns the median of all elements in a vector or an array on the dimension iDim. |
| min |
Returns the minimum (magnitude) element of any array x on the dimension iDim. |
| mode |
Returns the mode of all elements in a vector or an array on the dimension iDim. |
| moment |
Returns the central moment of order order of a vector x. |
| ndim |
Number of dimensions of an array x. |
| nftovni |
Converts noise factor into an equivalent input noise resistance. |
| norm |
Magnitude-squared of a complex number x. |
| normcdf |
Returns the cumulative distribution function of the normal distribution with mean mu and standard deviation sigma evaluated at
the values of x. |
| norminv |
Returns the inverse cumulative distribution function of the normal distribution with mean mu and standard deviation sigma evaluated
at the values of x. |
| normpdf |
Returns the probability distribution function of the normal distribution with mean mu and standard deviation sigma evaluated at the
values of x. |
| numcols |
Returns the number of columns in a matrix x. |
| numrows |
Returns the number of rows in a matrix x. |
| ones |
if n argument is omitted: generate a vector of m 1's, otherwise generate an mxn matrix of 1's. |
| posterror |
Converts the argument to a string (if necessary) and posts the string to the error log. The error stays on the log until the equations
are recalculated. This causes the equations to error out and not calculate, as well as posting the error. |
| postwarning |
Converts the argument to a string (if necessary) and posts the string to the error log as a warning. The warning stays on the log until
the equations are recalculated. This does not cause the equations to error out. The equations will calculate. |
| pow |
Returns x to the power of y. |
| prctile |
Returns the p'th percentiles of a vector x (p can be a scalar or a vector of percent values). |
| prod |
Calculates the product of all the elements in x. |
| quantile |
Returns the q'th quantiles of a vector x (q can be a scalar or a vector of quantile values). |
| rand |
Generate uniformly distributed random numbers on the interval [0, 1). Both arguments are optional. If both arguments are omitted,
the function returns a random scalar. If the second argument is omitted, generate a vector of m random numbers. Otherwise, generate
an mxn matrix of random numbers. |
| randn |
Generate Gaussian distributed random numbers with mean 0 and variance 1. Both arguments are optional. If both arguments are
omitted, the function returns a random scalar. If the second argument is omitted, generate a vector of m random numbers. Otherwise,
generate an mxn matrix of random numbers. |
| real |
Real part of a (complex) number x |
| re |
Same as real(x) |
| reshape |
sets the dimensions of the variable x to be that described by newshape. Swept-dimensions are NOT counted. (eg. if S is the variable
produced by a 100 point linear analysis of a 2-port circuit, reshape(S, [4;1]) would return a variable containing S, but having
dimensions 100x4x1) |
| resize |
sets the dimensions of the variable x to be that described by newshape. Swept-dimensions are counted. (eg. if S is the variable
produced by a 100 point linear analysis of a 2-port circuit, resize(S, [100;4;1]) would return a variable containing S, but having
dimensions 100x4x1) |
| reverse |
returns the reverse of a vector, so [1,2,3,4] becomes [4,3,2,1]; for matrices this will reverse the columns |
| rltogamma |
Returns the voltage reflection coefficient (gamma) based on the return loss in dB and the angle in radians |
| rltoz |
Returns the complex impedance based on the normalizing impedance, return loss in dB and the angle in radians |
| rotate |
rotates a vector by the integer rotate; if vector = [1,2,3,4], rotate(vector,2) returns [3,4,1,2]; for matrices this will rotate
the rows. |
| setindep |
set the independent reference for a swept dependent variable to indepvar(s). A minimum of two arguments is required.
This function can be used to remove all independent values of a variable by passing in a blank string for the second argument. |
| setplottype |
sets the plot-type property of a variable. Valid plot types include "" (Empty string), "Discrete", "Spectrum", "Level", "Spur",
"SpurFree", "OutOfRange", "ValidIF", "Contour", "PointPlot", and "Histogram". |
| setunits |
sets a variable named varname to have units specified by unit. unit may be an integer or a string. Example setunits( "totaltime","msec")
or setunits( "frqsweep", "MHz"). The units are used to by graphs to determine the axis labels and values. They can also by used by the
Tune window. Use UseMKS if you are settings units of variables manually to avoid confusion. |
| shape |
Returns a vector containing the number of elements in each dimension of x. Swept-dimensions are NOT counted. (eg. if S is the
variable produced by a 100 point linear analysis of a 2-port circuit, shape(S) returns the vector [2;2] ). |
| sin |
Sine of x, where x is in radians. |
| sinc |
Sin(x)
/ x, or 1 if x = 0. |
| sinh |
Hyperbolic sine of x. |
| size |
Returns a vector containing the number of elements in each dimension of x. Swept-dimensions are counted. (eg. if S is the
variable produced by a 100 point linear analysis of a 2-port circuit, size(S) returns the vector [100;2;2] ). |
| skewness |
Returns the sample skewness of a vector x. |
| sort |
Sorts a vector x in ascending order. |
| std |
Calculates the standard deviation of x. |
| sqr |
Square-root of x. |
| sqrt |
Same as sqr(x). |
| stoy |
convert S-parameters to Y-parameters |
| stoz |
convert S-parameters to Z-parameters |
| stos |
renormalize S-parameters to a different impedance |
| substrateer |
return the dielectric constant (Er) of the substrated named SubstName. |
| substratetand |
return the loss tangent of substrate named SubstName. |
| substraterho |
return the relative resistivity of substrate named SubstName. |
| substratetmet |
return the metal thickness of substrate named SubstName. |
| substraterough |
return the surface roughness of substrate named SubstName. |
| substrateh |
return the height of substrate named SubstName. |
| sum |
Calculates the sum of all the elements of x on the dimension iDim. |
| tan |
Tangent of x, where x is in radians. |
| tanh |
Hyperbolic tangent of x. |
| tcdf |
Returns the cumulative distribution function of the Student's T distribution with degrees of freedom parameter v evaluated at the
elements of x. |
| tinv |
Returns the inverse of the cumulative distribution function of the Student's T distribution with degrees of freedom parameter v
evaluated at the elements of p. |
| time |
constructs a time-domain waveform from complex spectra at arbitrary frequencies.
(Eg: time( V1, Freq, Time) where V1, Freq, and Time are variables in a HarBEC Dataset) |
| times |
Returns the element-by-element product of the two arguments. If one entry is a scalar and one is an array, the return value is
the scalar multiplied by every element in the array. This is in contrast to the * operator that does matrix multiplication. |
| timevector |
Creates a vector of times from start to stop with a specified step size. |
| tpdf |
Returns the probability distribution function of the Student's T distribution with degrees of freedom parameter v evaluated at
the elements of x. |
| transpose |
Transposes a matrix or swept matrices x |
| union |
Produces a vector representing a set which is the union of two sets (vectors) x and y |
| unwrap |
returns a vector of unwrapped phase; both input and output of the function are radians (note that ang() returns radians so
this is already self-consistent; z = unwrap( ang(Linear1.S[2,1]) ) is an example. |
| using |
sets the current context in an equation block to the dataset called Dataset. |
| var |
Calculates the variance of x. |
| vector |
Builds a vector of complex numbers of length x. Elements are initialized to zero. |
| zeros |
if n argument is omitted: generate a vector of m 0's, otherwise generate an mxn matrix of 0's |
Log In
Getting Started