pylops_distributed.Roll

class pylops_distributed.Roll(N, dims=None, dir=0, shift=1, compute=(False, False), todask=(False, False), dtype='float64')

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

compute : tuple, optional

Compute the outcome of forward and adjoint or simply define the graph and return a dask.array

todask : tuple, optional

Apply dask.array.from_array to model and data before applying forward and adjoint respectively

dtype : str, optional

Type of elements in input array.

Raises:

ValueError

If M is different from N and chunks is not provided

Notes

Refer to pylops.basicoperators.Roll for implementation details.

Attributes:

shape : tuple

Operator shape

explicit : bool

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

Methods

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