statistics

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.

Here is a sample execution graphic using the default setting, 'slip', for the OverrunAction property in the Rate object. See OverrunAction (Robotics System Toolbox) 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 (Robotics System Toolbox) for more information.

Output Arguments

stats — Time execution statistics

structure

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

• Period — All time periods (returned in seconds) used to calculate statistics as an indexed array. stats.Period(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

Version History

Introduced in R2019b