Defining Traces Using Range Functions
Range functions use a 2D dataset as input, along with zero or more additional parameters. Use range functions to produce a 2D report that displays a collection of traces and their attributes. The trace collection and attributes generate a portion of a report definition that generates a family of curves in the report window.
Apply range functions to a range (subset) of points on an X-Y plot; they will then calculate a single-number representation of the specified range, and display that number directly over a plotted wave-form. Use range functions to extract trace characteristics (such as maximum, minimum, and overshoot) from a plot and use those values for additional plotting. You can also use the values to export to a file, where the data table formats are supported. Range functions appear in the Range Function dialog box. Extracted trace characteristics may also be used in Optimetrics.
For example, with a wave-form in a transient plot that contains a square pulse, a range function can calculate and display a single value that represents the High-to-Low/Low-to-High transition states. Or, with a plot that shows a pulse, the PulseWidth and RiseTime range functions use the entire plotted curve to calculate a single number that represents the width or rise-time, and display that single-number representation directly over the specified range of plotted points.
- Range functions trace characteristics appear on the report window as a column in legend window.
- Range functions are available from reporter and optimetrics.
- Numerous range functions are available in these
categories:
- Math functions
- Pulse width functions
- Overshoot/Undershoot functions
- TR & DC functions
- Error functions
- Period functions
- Radiation functions
- Eye Measurements functions
This table lists the available range functions:
|
Range Function |
Category |
Description |
Parameters |
|
*avg |
Math |
Returns the average of the values of the selected quantity. avg = (Area between the curve and the X-axis) / ( X length of the curve) |
N/A |
|
avgabs |
Math |
Returns the mean of the absolute value of the selected quantity. |
N/A |
|
crestfactor |
TR & DC |
Returns the crest factor (peak/RMS) for the selected quantity. |
N/A |
|
deadtime |
TR & DC |
Obtains the latest time when the qtyl is within a tolerance of zero. |
Tolerance: The +/- bandwidth around zero . |
|
delaytime |
TR & DC |
Obtains the time from zero to 50% of the target point. |
Target: The target value for input. |
|
distortion |
TR & DC |
Returns the total distortion for the selected simulation quantity and an additional argument frequency, which is the frequency in Hz at which to calculate the fundamental RMS of the simulation quantity. |
Frequency: Freq in Hz at which to calculate the RMS value of the selected quantity. |
|
formfactor |
TR & DC |
Returns the form factor (RMS/Mean Absolute Value) for the selected quantity. |
N/A |
|
fundamentalmag |
TR & DC |
Returns the RMS value of the fundamental frequency for the selected quantity, and an additional argument, Frequency, which specifies the fundamental frequency. |
Frequency: Freq in Hz at which to calculate the RMS value of the selected quantity. |
|
iae |
Error |
Returns the integral of the absolute deviation of the selected quantity from a target value that is entered via the additional argument. |
Target: Target value. |
|
integ |
Math |
Integral of the selected quantity. Uses trapezoidal area. |
N/A |
|
integabs |
Math |
Returns the integral of the absolute value of the selected qty. |
N/A |
|
ise |
Error |
Returns the integral of the squared deviation of the selected quantity from a target value that is entered via an additional argument. |
Target: Target value. |
|
itae |
Error |
Returns the time-weighted absolute deviation of the selected quantity from a target value that is entered via an additional argument. |
Target: Target value. |
|
itse |
Error |
Returns the time-weighted squared deviation of the selected qty from a target value that is entered via an additional argument. |
Target: Target value. |
|
max |
Math |
Maximum (of magnitudes).
|
N/A
|
|
mean |
Math |
Returns the average in the set of quantities selected. mean = sum( all y-value) / (number of y-values) |
N/A |
|
min |
Math |
Minimum (of magnitudes). |
N/A |
|
overshoot |
Overshoot/Undershoot |
Calculates peak overshoot given a threshold value and number of evenly spaced points over entire time range. |
Threshold: The reference value from where the overshoot/undershoot is calculated. Number of Points: Number of evenly spaced time points. |
|
per |
Period
|
Calculates period.
|
Threshold: Y transition value which determines the period. Number of Points: Number of evenly spaced time points. |
|
pk2pk |
Math |
Difference between maximum and minimum of the first parameter over the second parameter. Returns the peak-to-peak value for the selected simulation quantity. |
N/A |
|
pkavg |
Math |
Returns the ratio of the peak to peak-to-average for the selected quantity. |
N/A |
|
pmax |
Period |
Maximum period of input stream. |
Threshold: Y transition value which determines the period. Number of Points: Number of evenly spaced time points. |
|
pmin |
Period |
Minimum period of input stream. |
Threshold: Y transition value which determines the period. Number of Points: Number of evenly spaced time points. |
|
prms |
Period |
Rms of period of input stream. |
Threshold: Y transition value which determines the period. Number of Points: Number of evenly spaced time points. |
|
pulsefall9010 |
Pulse Width |
Returns the pulse fall time of the selected quantity according to the 90%-10% estimate. |
N/A |
|
pulsefront1090 |
Pulse Width |
Returns the pulse front time of the selected quantity according to the 10%-90% estimate. |
N/A |
|
pulsefront3090 |
Pulse Width |
Returns the pulse front time of the selected quantity according to the 30%-90% estimate. |
N/A |
|
pulsemax |
Pulse Width |
Returns the pulse maximum from the front and tail estimates for the selected quantity. |
N/A |
|
pulsemaxtime |
Pulse Width |
Returns the time at which the maximum pulse value of the selected quantity is reached. |
N/A |
|
pulsemin |
Pulse Width |
Returns the pulse minimum from the front and tail estimates for the selected quantity. |
N/A |
|
pulsemintime |
Pulse Width |
Returns the time at which the minimum pulse value of the selected quantity is reached. |
N/A |
|
pulsetail50 |
Pulse Width |
Returns the pulse tail time of the selected quantity from the virtual peak to 50%. |
N/A |
|
pulsewidth5050 |
Pulse Width |
Returns the pulse width of the selected quantity as measured from the 50% points on the pulse front and pulse tail. |
N/A |
|
pw_minus |
Pulse Width |
Pulse width of the first negative pulse. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_minus_avg |
Pulse Width |
Average of the negative pulse width input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_minus_max |
Pulse Width |
Maximum pulse width of the negative pulse of input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_minus_min |
Pulse Width |
Minimum pulse width of the negative pulse of input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_minus_rms |
Pulse Width |
RMS of the negative pulse width input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_plus |
Pulse Width |
Pulse width of first positive pulse. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_plus_avg |
Pulse Width |
Average of the positive pulse width input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_plus_max |
Pulse Width |
Maximum pulse width of the positive pulse of input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_plus_min |
Pulse Width |
Minimum pulse width of the positive pulse of input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
pw_plus_rms |
Pulse Width |
RMS of the positive pulse width input stream. |
Threshold: Y transition value which determines the pulse width. Number of Points: Number of evenly spaced time points. |
|
ripple |
Math |
Returns the ripple factor (AC RMS/Mean) for the selected quantity. |
N/A |
|
risetime |
TR & DC |
Obtains the time taken to go from 10% to 90% of target point. |
Target: The target value for input. |
|
rms |
Math |
Returns total RMS of the selected quantity. |
N/A |
|
rmsAC |
Math |
Returns the AC RMS for the selected quantity. |
N/A |
|
settlingtime |
TR & DC |
Returns the latest time at which the value of the selected simulation quantity fell outside its tolerance band. The target value of the quantity and the +/- bandwidth of the tolerance band are the additional args. |
Target: Tolerance. |
|
stddev |
Math |
Returns the standard deviation of given values. |
N/A |
|
sum |
Math |
Returns the sum of given values. |
N/A |
|
undershoot |
Overshoot/Undershoot |
Calculates peak undershoot given a threshold value and number of evenly spaced points over entire time range. |
Threshold: The reference value from where the overshoot/undershoot is calculated. Number of Points: Number of evenly spaced time points. |
|
variance |
Math |
Returns the variance of given values. |
N/A |
|
XAtYMax |
Math |
Returns the X value at maximum Y. |
N/A |
|
XAtYMin |
Math |
Returns the X value at minimum Y. |
N/A |
|
XAtYVal |
Math |
Returns the X value at the first occurrence of Y value. |
Y Value: Y value at which we need to find X. |
|
YAtXMax |
Math |
Returns the Y value at maximum X. |
N/A |
|
YAtXMin |
Math |
Returns the Y value at minimum X. |
N/A |
|
YAtXVal |
Math |
Returns the Y value at the first occurrence of X value. |
X Value: X value at which we need to find Y. |