This function retrieves the values assigned to the parameter that was stepped to obtain the vector data supplied. It will only return a meaningful result for data vectors generated by a multi-step analysis. For example, if an analysis was performed which stepped the value of the resistor R7 from ???MATH???100\Omega???MATH??? to ???MATH???500\Omega???MATH??? in ???MATH???100\Omega???MATH??? steps, this function would return [100, 200, 300, 400, 500]. If the analysis was a Monte Carlo run, the function will return the run numbers starting from 1.
If there is more than one stepped parameter, the second argument may be used to identify for which parameter the values are returned.
If this function is applied to single division data as returned by a normal single step run, the return value will be an empty vector.
Number | Type | Compulsory | Default | Description |
1 | real/complex array | Yes | Vector | |
2 | real | No | 0 | index |
Identifies parameter when there is more than one
Return type: real array
▲Function Summary▲ | ||
◄ GetVecStepParameter | GetWidgetInfo ▶ |