# #############################################################################
#  pySAP - Copyright (C) CEA, 2017 - 2018                                     #
#  Distributed under the terms of the CeCILL-B license,                       #
#  as published by the CEA-CNRS-INRIA. Refer to the LICENSE file or to        #
#  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html for details.   #
# #############################################################################


[docs]class OperatorBase(object):
    """ Base Operator class. Every linear operator inherits from this class,
    to ensure that we have all the functions rightly implemented
    as required by Modopt
    """

[docs]    def op(self, data):
        """ This method calculates operator transform.

        Parameters
        ----------
        data: np.ndarray
            input as array.

        Returns
        -------
        result: np.ndarray
            operator transform of the input.
        """

        raise NotImplementedError("'op' is an abstract method.")

[docs]    def adj_op(self, x):
        """ This method calculates adjoint operator transform.

        Parameters
        ----------
        x: np.ndarray
            input data array.

        Returns
        -------
        results: np.ndarray
            adjoint operator transform.
        """

        raise NotImplementedError("'adj_op' is an abstract method.")