quickpaver.make_rlg_spatial_permutation_matrices#

quickpaver.make_rlg_spatial_permutation_matrices(grid: RectilinearGrid, sub_selection: ndarray[tuple[Any, ...], dtype[int64]] | None = None) → Tuple[csc_array, csc_array, csc_array][source]#

Make matrices to compute the spatial permutations along x and y axes of a field.

Parameters:

  • grid (RectilinearGrid) – Grid of the field

  • sub_selection (Optional[NDArrayInt], optional) – Optional sub selection of the field. Non selected elements will be ignored in the gradient computation (as if non existing). If None, all elements are used. By default None.

Returns:

Spatial permutation matrices for x and y axes.

Return type:

Tuple[csc_array, csc_array]