Skip to content

Identity

torchlinops.linops.Identity

Bases: NamedLinop

Identity operator \(I(x) = x\).

Returns the input unchanged. The adjoint, normal, and any power of the identity are also the identity.

Source code in src/torchlinops/linops/identity.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class Identity(NamedLinop):
    """Identity operator $I(x) = x$.

    Returns the input unchanged. The adjoint, normal, and any power of the
    identity are also the identity.
    """

    def __init__(self, ishape=("...",), oshape=None):
        super().__init__(NS(ishape, oshape))

    def adjoint(self):
        return self

    def normal(self, inner=None):
        if inner is None:
            return self
        return inner

    @staticmethod
    def fn(linop: NamedLinop, x, /):
        return x

    @staticmethod
    def adj_fn(linop: NamedLinop, x, /):
        return x

    @staticmethod
    def normal_fn(linop: NamedLinop, x, /):
        # A bit faster
        return x

    def split_forward(self, ibatch, obatch):
        # TODO: Allow non-diagonal splitting
        assert ibatch == obatch, "Identity linop must be split identically"
        return self

    def __pow__(self, _: float | Tensor):
        return copy(self)

__init__ 

__init__(ishape=('...',), oshape=None)
Source code in src/torchlinops/linops/identity.py 
18
19
def __init__(self, ishape=("...",), oshape=None):
    super().__init__(NS(ishape, oshape))

__pow__ 

__pow__(_: float | Tensor)
Source code in src/torchlinops/linops/identity.py 
47
48
def __pow__(self, _: float | Tensor):
    return copy(self)

torchlinops.linops.ShapeSpec

Bases: Identity

Identity operator that renames dimensions.

Functionally identical to Identity but maps from one set of named dimensions to another, acting as a shape adapter between linops.

Source code in src/torchlinops/linops/identity.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
class ShapeSpec(Identity):
    """Identity operator that renames dimensions.

    Functionally identical to ``Identity`` but maps from one set of named
    dimensions to another, acting as a shape adapter between linops.
    """

    def adjoint(self):
        new = copy(self)
        new.shape = self.shape.adjoint()
        return new

    def normal(self, inner=None):
        if inner is None:
            # Behaves like a diagonal linop
            return ShapeSpec(self.ishape, self.ishape)
        pre = copy(self)
        post = self.adjoint()
        pre.oshape = inner.ishape
        post.ishape = inner.oshape
        normal = post @ inner @ pre
        normal._shape_updates = getattr(inner, "_shape_updates", {})
        return normal