breidablik.interpolate.scalar
=============================

.. py:module:: breidablik.interpolate.scalar


Classes
-------

.. autoapisummary::

   breidablik.interpolate.scalar.Scalar


Module Contents
---------------

.. py:class:: Scalar

   Scalar class used to scale data. Can create a scalar, scale input data, save and load previous scalars.



   .. py:attribute:: mean
      :value: None



   .. py:attribute:: std
      :value: None



   .. py:method:: fit(data)

      Create scalar.

      :param data: Needs to be in the form [num of objects x num of parameters].
      :type data: 2darray



   .. py:method:: _check(data)

      Check that the input data is valid data.

      :param data: Needs to be in the form [num of objects x num of parameters].
      :type data: 2darray



   .. py:method:: transform(data)

      Scale input data.

      :param data: Needs to be in the form [num of objects x num of parameters].
      :type data: 2darray

      :returns: **scaled_data** -- The scaled data in the form [num of objects x num of parameters].
      :rtype: 2darray



   .. py:method:: untransform(data)

      Unscale input data.

      :param data: Needs to be in the form [num of objects x num of parameters].
      :type data: 2darray

      :returns: **unscaled_data** -- The unscaled data in the form [num of objects x num of parameters].
      :rtype: 2darray



   .. py:method:: save(name)

      Save scalar

      :param name: The name to save the scalar under.
      :type name: str



   .. py:method:: load(name)

      Load scalar.

      :param name: The name of the saved scalar.
      :type name: str