getMetricDistribution

Class: slmetric.Engine
Namespace: slmetric

(To be removed) Get metric distribution

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.

Syntax

getMetricDistribution(metric_engine,MetricID)

Description

getMetricDistribution(metric_engine,MetricID) generates distribution for a specific metric, MetricID, for the metric data in the slmetric.Engine object, metric_engine. The distribution is on the metric data from the Value property of a slmetric.metric.Result object.

Input Arguments

metric_engine — Collects and accesses metric data

slmetric.Engine object

When you call execute, metric_engine collects metric data for all available metrics or for the specified MetricID. Calling getMetrics accesses the collected metric data in metric_engine.

MetricID — Metric identifier

character vector

Metric identifier for a model metric, specified as a character vector.

Example: 'mathworks.metrics.DescriptiveBlockNames'

Output Arguments

dist — Distribution of the metric data

slmetric.metric.MetricDistribution object

Distribution of the metric data contains the following properties:

• MetricID is a char array that returns the metric ID specified in the getMetricDistribution function call.

• BinCounts is an uint64 array of the number of components corresponding to a bin.

• BinEdges is a double array of equally spaced edges of each bin.

Examples

Generate Metric Distribution

To generate the distribution for a specific metric, create a slmetric.Engine object, set the analysis root for the sldemo_fuelsys model, and create a histogram of the data. The histogram shows the number of components corresponding to a number of blocks.

% Open the example model
openExample('sldemo_fuelsys')

% Create an slmetric.Engine object
metric_engine = slmetric.Engine();

% Specify model for metric analysis
setAnalysisRoot(metric_engine, 'Root', 'sldemo_fuelsys');

% Collect model metrics and get distribution
metricID = 'mathworks.metrics.SimulinkBlockCount';
execute(metric_engine, metricID);
dist = getMetricDistribution(metric_engine, metricID);

% View the distribution using a histogram.
histogram('BinEdges',dist.BinEdges,'BinCounts',dist.BinCounts);

Version History

Introduced in R2017a

R2022a: Metrics Dashboard will be removed

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.