Metric#

class Metric(name, getter, units=None, element=None)[source]#

Create a Metric object that serves as an argument for Model objects.

Parameters:

  • name (str) – Name of metric.

  • units (str) – Metric units of measure.

  • getter (function) – Should take no arguments and return the metric value.

  • element (str) – Element corresponding to metric

__call__()[source]#

Call self as a function.

get()[source]#

Return value of metric. This method used cached values.

difference()[source]#

Return the difference between the current metric value and the last one evaluated by calling this object.