pylops.Roll

class pylops.Roll(N, dims=None, dir=0, shift=1, dtype='float64')[source]

Roll along an axis.

Roll a multi-dimensional array along a specified direction dir for a chosen number of samples (shift).

Parameters:
N : int

Number of samples in model.

dims : list, optional

Number of samples for each dimension (None if only one dimension is available)

dir : int, optional

Direction along which rolling is applied.

shift : int, optional

Number of samples by which elements are shifted

dtype : str, optional

Type of elements in input array.

Notes

The Roll operator is a thin wrapper around numpy.roll and shifts elements in a multi-dimensional array along a specified direction for a chosen number of samples.

Attributes:
shape : tuple

Operator shape

explicit : bool

Operator contains a matrix that can be solved explicitly (True) or not (False)

Methods

__init__(self, N[, dims, dir, shift, dtype]) Initialize this LinearOperator.
adjoint(self) Hermitian adjoint.
apply_columns(self, cols) Apply subset of columns of operator
cond(self, \*\*kwargs_eig) Condition number of linear operator.
conj(self) Complex conjugate operator
div(self, y[, niter]) Solve the linear problem \(\mathbf{y}=\mathbf{A}\mathbf{x}\).
dot(self, x) Matrix-matrix or matrix-vector multiplication.
eigs(self[, neigs, symmetric, niter]) Most significant eigenvalues of linear operator.
matmat(self, X) Matrix-matrix multiplication.
matvec(self, x) Matrix-vector multiplication.
rmatmat(self, X) Adjoint matrix-matrix multiplication.
rmatvec(self, x) Adjoint matrix-vector multiplication.
todense(self) Return dense matrix.
transpose(self) Transpose this linear operator.

Examples using pylops.Roll