statistics

R2026b

Statistics of past execution periods

Syntax

stats = statistics(rate)

Description

stats = statistics(rate) returns statistics of previous periods of code execution. stats is a struct with these fields: Periods, NumPeriods, AveragePeriod, StandardDeviation, and NumOverruns.

The statistics are computed over the most recent 1,000 execution periods. If fewer than 1,000 periods are available, all available periods are used for the calculation.

Here is a sample execution graphic using the default setting, 'slip', for the OverrunAction property in the Rate object. See OverrunAction for more information on overrun code execution.

The output of statistics is:

stats = 

              Periods: [0.7 0.11 0.7 0.11]
           NumPeriods: 4
        AveragePeriod: 0.09
    StandardDeviation: 0.0231
          NumOverruns: 2

Input Arguments

rate — Rate object

handle

Rate object, specified as an object handle. This object contains the information for the DesiredRate and other info about the execution. See rateControl for more information.

Output Arguments

stats — Time execution statistics

structure

Time execution statistics, returned as a structure. This structure contains the following fields:

• Periods — All time periods (returned in seconds) used to calculate statistics as an indexed array. stats.Periods(end) is the most recent period.

• NumPeriods — Number of elements in Periods

• AveragePeriod — Average time in seconds

• StandardDeviation — Standard deviation of all periods in seconds, centered around the mean stored in AveragePeriod

• NumOverruns — Number of periods with overrun

Examples

Get Statistics from Rate Object Execution

Create a rateControl object for running at 20 Hz.

r = rateControl(20);

Start a loop and control operation using the rateControl object.

for i = 1:30
    % Your code goes here
    waitfor(r);
end

Get Rate object statistics after loop operation.

stats = statistics(r)

stats = struct with fields:
              Periods: [0.0523 0.0483 0.0501 0.0499 0.0519 0.0477 0.0499 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500 0.0500]
           NumPeriods: 30
        AveragePeriod: 0.0500
    StandardDeviation: 7.6266e-04
          NumOverruns: 0

Version History

Introduced in R2016a