jan/fdfd_tools
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

Fix docstring for rotation

Browse Source
This commit is contained in:
Jan Petykiewicz 2017-05-20 21:22:43 -07:00
parent 5033472342
commit 9d33744427
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
fdfd_tools/operators.py
View File

@ -284,7 +284,8 @@ def m2j(omega: complex,
def rotation(axis: int, shape: List[int], shift_distance: int=1) -> sparse.spmatrix:
"""
Utility operator for performing a circular shift along a specified axis by 1 element.
Utility operator for performing a circular shift along a specified axis by a
specified number of elements.
:param axis: Axis to shift along. x=0, y=1, z=2
:param shape: Shape of the grid being shifted