Metrics
=======

.. _metrics_api:

The metrics module provides classes for computing specific metrics from PyBaMM solutions at particular operating conditions.

Base Class
------------

.. autoclass:: ionworkspipeline.data_fits.models.metrics.BaseMetric
    :members:

Time-Based Metrics
------------------

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Time
    :members:

Condition-Based Metrics
-----------------------

.. autoclass:: ionworkspipeline.data_fits.models.metrics.SOC
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Voltage
    :members:

Aggregation Metrics
-------------------

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Maximum
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Minimum
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Mean
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Sum
    :members:

Point-Based Metrics
-------------------

.. autoclass:: ionworkspipeline.data_fits.models.metrics.PointBased
    :members:

Action Classes
--------------

Actions wrap metrics and define how they contribute to the optimization cost landscape.

.. autoclass:: ionworkspipeline.data_fits.models.metrics.BaseAction
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Maximize
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.Minimize
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.GreaterThan
    :members:

.. autoclass:: ionworkspipeline.data_fits.models.metrics.LessThan
    :members: