Source code for cil.optimisation.operators.ZeroOperator

#  Copyright 2019 United Kingdom Research and Innovation
#  Copyright 2019 The University of Manchester
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
#
# Authors:
# CIL Developers, listed at: https://github.com/TomographicImaging/CIL/blob/master/NOTICE.txt

import numpy as np
from cil.framework import ImageData
from cil.optimisation.operators import LinearOperator



class ZeroOperator(LinearOperator):
    r''' `ZeroOperator`:  :math:`\mathrm{O}: X \rightarrow Y`,  maps any element of :math:`x\in X` into the zero element in the space :math:`Y`, so  :math:`\mathrm{O}(x) = \mathrm{O}_{Y}`.

        Parameters
        ----------
        
        domain_geometry: CIL Geometry
            domain of the operator
        range_geometry: CIL Geometry, optional
            range of the operator, default: same as domain

        Note
        -----

        .. math::
                O^{*}: Y^{*} -> X^{*} \text{(Adjoint)} \quad \text{such that} \quad
                \langle O(x), y \rangle = \langle x, O^{*}(y) \rangle
     '''
    def __init__(self, domain_geometry, range_geometry=None):
        if range_geometry is None:
            range_geometry = domain_geometry.clone()
        super(ZeroOperator, self).__init__(domain_geometry=domain_geometry,
                                           range_geometry=range_geometry)



    def direct(self,x,out=None):
        r'''Returns an element of the range space filled with zeros
        
        Parameters
        ----------
        x : DataContainer or BlockDataContainer
            Input data
        out : DataContainer or BlockDataContainer, optional
            If out is not None the output of the Operator will be filled in out, otherwise a new object is instantiated and returned. The default is None.
        
        Returns
        -------
        DataContainer
            :math:`\mathrm{O}(x)`
        '''
        if out is None:
            return self.range_geometry().allocate(value=0)
        else:
            out.fill(self.range_geometry().allocate(value=0))
            return out




    def adjoint(self,x, out=None):
        r'''Returns an element of the domain space filled with zeros
        
        Parameters
        ----------
        x : DataContainer or BlockDataContainer
            Input data
        out : DataContainer or BlockDataContainer, optional
            If out is not None the output of the Operator will be filled in out, otherwise a new object is instantiated and returned. The default is None.
        
        Returns
        -------
        DataContainer
            :math:`\mathrm{O}^{*}(y)`
        
        '''
        if out is None:
            return self.domain_geometry().allocate(value=0)
        else:
            out.fill(self.domain_geometry().allocate(value=0))
            return out




    def calculate_norm(self, **kwargs):
        r'''Evaluates operator norm of `ZeroOperator`'''
        return 0