PromoteStatistic()

The PromoteStatistic() function allows you to copy a specified statistic value from the test to the overview report. These copied statistics appear in the "Statistic Results" section of the overview report between the design specifications and the spreadsheet-compatible results. This function also allows you to rename the statistics.

In this Topic ShowHide

Example
Using PromoteStatistic() as a Script Function

The PromoteStatistic() function has two versions:

PromoteStatistic(statistic_name)

PromoteStatistic(statistic_name, overview_statistic_name)

Argument	Range	Description
statistic_name	n/a	An ASCII string value only with no spaces or other non-alphanumeric characters.
overview_statistic_name	n/a	A string value that may contain spaces and other non-alphanumeric characters.*

* The spaces and non-alphanumeric characters in the overview_statistic_name helps to clarify what the statistic value represents on the overview report since an auto-generated statistic name is often not as descriptive as it could be.

▲ back to top

Example

A statistic value exists with the name "NOM(VOUT)" and a value of 1.223. The following calls in the testplan will promote the statistic value to the overview report.

PromoteStatistic(AVG(VOUT))
PromoteStatistic(AVG(VOUT), Average Output Voltage (V))

Note: The statistic_name argument, AVG(VOUT), contains no spaces. The overview_statistic name, Average Output Voltage (V), uses spaces and parentheses to clarify the description on the report.

▲ back to top

Using PromoteStatistic() as a Script Function

PromoteStatistic() also exists as a SIMetrix script function and can be called from a post-process or final-process script. The arguments for this function when called from a script are slightly different than the testplan version. The script function syntax is as follows:

SimplisDVMAdvancedUtilMeasurementPromoteStatistic(array, log_file)

where array is a SIMetrix string array with two or three elements:

statistic_name
value
overview_statistic_name (optional)

The examples above could be generated in a PostProcess script with the following calls:

Let return = SimplisDVMAdvancedUtilMeasurementPromoteStatistic([ 'AVG(VOUT)', '1.223' ], log_file)

Let return = SimplisDVMAdvancedUtilMeasurementPromoteStatistic([ 'AVG(VOUT)', '1.223', 'Average Output Voltage (V)' ], log_file)

The script function return value may be safely ignored.

▲ back to top