主要内容

本页采用了机器翻译。点击此处可查看英文原文。

slmetric.metric.Metric 类

命名空间: slmetric.metric
超类:

(待删除)用于创建模型度量的抽象类

以后的版本中将会删除度量仪表板用户界面、metricdashboard 函数、slmetric 包 API 以及相应的自定义项。有关详细信息,请参阅从度量盘迁移到模型可维护性仪表盘

描述

用于创建模型度量的抽象基类。要创建模型度量,请创建一个继承自 slmetric.metric.Metric 类的 MATLAB® 类。

属性

全部展开

度量计算的编译模式。如果您的模型度量需要模型编译,请指定 PostCompile。如果您的模型度量不需要模型编译,请指定 None

示例: 'PostCompile'

数据类型: char

计算度量的模型组件。对所有符合该类型的组件进行度量计算。

度量描述。

数据类型: char

唯一度量标识符

数据类型: char

使用此属性将度量算法的更改传达给度量引擎。

数据类型: uint32

为自定义度量算法指定一个名称。

数据类型: char

为度量收集的值指定一个名称。在度量仪表板中查看详细结果时,ValueName 是表格和树状视图中收集值的列标题。

数据类型: char

为度量收集的聚合值指定一个名称。要指定此属性,请将 AggregationMode 设置为 None。在度量仪表板中查看详细结果时,AggregatedValueName 是表格和树状视图中收集的聚合值的列标题。

数据类型: char

指定度量收集的度量名称。仅当度量算法将度量值写入算法返回的结果对象时,才设置此属性。在度量板中查看详细结果时,MeasuresNames 是表格和树状视图中收集的度量的列标题。

数据类型: char

指定度量收集的聚合度量的名称。仅当度量算法将度量写入算法返回的结果对象,并且 AggregationMode 设置为 None 时,才设置此属性。当您在度量仪表板中查看详细结果时,AggregatedMeasuresNames 是表格和树状视图中收集的聚合度量的列标题。

数据类型: char

如果 true,则仅当模型或库源文件发生变化时,度量算法产生的结果才会发生变化。如果源文件和度量 Version 没有改变,则不会重新生成度量数据。如果 false,则每次调用 slmetric.Engine.execute 都会收集此度量的新数据并将其存储在度量存储库中。

数据类型: logical

指定在组件层次结构中聚合 slmetric.metric.Result 对象属性 ValueMeasure 的操作。度量算法将聚合值输出到 slmetric.metric.Result 对象属性 AggregatedValuesAggregatedMeasures 中。选项包括:

  • Sum:返回组件层次结构中所有子组件的 Value 属性和 Value 属性的总和。

  • Max:返回组件层次结构中所有子组件的 Value 属性和 Value 属性的最大值。

  • None:度量值不进行聚合。

数据类型: char

指定 slmetric.metric.Result 对象属性 Details 是否包含数据。默认值为 false。当您将此属性的值设置为 false 时,度量仪表板过滤器将被启用。

数据类型: logical

方法

algorithm(即将删除)指定度量数据分析的逻辑

版本历史记录

在 R2016a 中推出

全部折叠