pylops.Imag

class pylops.Imag(dims, dtype='complex128', name='I')[source]

Imag operator.

Return the imaginary component of the input as a real value. The adjoint returns a complex number with zero real component and the imaginary component set to the real component of the input.

Parameters:
dimsint or tuple

Number of samples for each dimension

dtypestr, optional

Type of elements in input array.

namestr, optional

Added in version 2.0.0.

Name of operator (to be used by pylops.utils.describe.describe)

Attributes:
dimstuple

Shape of the array after the adjoint, but before flattening.

For example, x_reshaped = (Op.H * y.ravel()).reshape(Op.dims).

dimsdtuple

Shape of the array after the forward, but before flattening. In this case, same as dims.

rdtypenumpy.dtype

Real dtype corresponding to dtype.

shapetuple

Operator shape.

Notes

In forward mode:

\[y_{i} = \Im\{x_{i}\} \quad \forall i=0,\ldots,N-1\]

In adjoint mode:

\[x_{i} = 0 + i\Re\{y_{i}\} \quad \forall i=0,\ldots,N-1\]

Methods

__init__(dims[, dtype, name])

adjoint()

apply_columns(cols)

Apply subset of columns of operator

cond([uselobpcg])

Condition number of linear operator.

conj()

Complex conjugate operator

div(y[, niter, densesolver])

Solve the linear problem \(\mathbf{y}=\mathbf{A}\mathbf{x}\).

dot(x)

Matrix-matrix or matrix-vector multiplication.

eigs([neigs, symmetric, niter, uselobpcg])

Most significant eigenvalues of linear operator.

matmat(X)

Matrix-matrix multiplication.

matvec(x)

Matrix-vector multiplication.

reset_count()

Reset counters

rmatmat(X)

Matrix-matrix multiplication.

rmatvec(x)

Adjoint matrix-vector multiplication.

todense([backend])

Return dense matrix.

toimag([forw, adj])

Imag operator

toreal([forw, adj])

Real operator

tosparse()

Return sparse matrix.

trace([neval, method, backend])

Trace of linear operator.

transpose()

Examples using pylops.Imag

Imag

Imag