Skip to content

Commit

Permalink
fixed error in rotate documentation [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
RainerHeintzmann committed Aug 27, 2022
1 parent 078dabc commit 04bb0c8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/fourier_rotate.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export rotate, rotate!
"""
rotate(arr, θ, rotation_plane=(1,2), adapt_size=true, keep_new_size=false)
Rotate an `arr` in the plane `rotation_plane` with an angle `θ` in degree around the center pixel. Note that, in contrast to `ImageTransformations.imrotate`, the rotation is done around the Fourier-center pixel (size()÷2+1) and not the geometric mid point.
Rotate an `arr` in the plane `rotation_plane` with an angle `θ` in rad around the center pixel. Note that, in contrast to `ImageTransformations.imrotate`, the rotation is done around the Fourier-center pixel (size()÷2+1) and not the geometric mid point.
# Arguments:
+ `arr`: the array to rotate
Expand Down Expand Up @@ -78,7 +78,7 @@ end
"""
rotate!(arr, θ, rotation_plane=(1,2))
In-place rotate an `arr` in the plane spanned by the two dimensions in the tuple `rotation_plane` with an angle `θ` in degree
In-place rotate an `arr` in the plane spanned by the two dimensions in the tuple `rotation_plane` with an angle `θ` in rad
around the center pixel. Note that, in contrast to `ImageTransformations.imrotate`, the rotation is done around the Fourier-center pixel (size()÷2+1) and not the geometric mid point.
Note also that due to the operation being performed by successive cyclic shear operations in-place, pixels near the corner will be experiencing a massive wrap-around problem.
Use the out-of-place version `rotate` to avoid this.
Expand Down

0 comments on commit 04bb0c8

Please sign in to comment.