rotatePosition->angleAxisRotation

Author: OrtnerMichael

CHANGELOG.md

@@ -19,7 +19,7 @@ Click here for [Unreleased Changes]
   - getBsweep and multiprocessing options have been completely removed, this functionality
     should be overtaken by the new getBv function
 - Docstrings are being adjusted to work with intellisense
-- public rotatePosition() is now called angleAxisRotation_priv()
+- public angleAxisRotation() is now called angleAxisRotation_priv()
 
 ### Added
 - Vector functionality in form of the top-level function getBv applying vectorized code

docs/_pages/0_documentation.md

@@ -388,14 +388,14 @@ The math package provides some functions for easier use of the angle-axis (Quate
   print(ax)                                 #Output = [-0.24834468  0.96858637  0.01285925]
   ```
 
-- `rotatePosition(pos, angle, axis, anchor=[0,0,0])`: This function uses angle-axis rotation to rotate the position vector `pos` by the `angle` argument about an axis defined by the `axis` vector which passes through the `anchor` position.
+- `angleAxisRotation(pos, angle, axis, anchor=[0,0,0])`: This function uses angle-axis rotation to rotate the position vector `pos` by the `angle` argument about an axis defined by the `axis` vector which passes through the `anchor` position.
   ```python
   import magpylib as magpy
   pos0 = [1,1,0]
   angle = -90
   axis = [0,0,1]
   anchor = [1,0,0]
-  positionNew = magpy.math.rotatePosition(pos0,angle,axis,anchor)
+  positionNew = magpy.math.angleAxisRotation(pos0,angle,axis,anchor)
   print(positionNew)                  #Output = [2. 0. 0.]
   ```
 

docs/pyplots/examples/03b_Bsweep2.py

@@ -24,7 +24,7 @@
 for th in np.linspace(1,thMAX,30):
 
     #rotation of the magnet position outwards
-    posis = [math.rotatePosition(p0,th,ax,anchor=[0,0,gap+H+d]) for ax in axes]
+    posis = [math.angleAxisRotation(p0,th,ax,anchor=[0,0,gap+H+d]) for ax in axes]
 
     #generate INPUT
     INPUT += [[[0,0,0],pos,[th,ax]] for pos,ax in zip(posis,axes)]

magpylib/_lib/classes/sensor.py

@@ -24,7 +24,7 @@
 
 from magpylib._lib.classes.base import RCS
 from magpylib._lib.utility import addUniqueSource, addListToCollection, isSource
-from magpylib._lib.mathLib import rotatePosition
+from magpylib._lib.mathLib import angleAxisRotation
 
 class Sensor(RCS):
     """
@@ -107,7 +107,7 @@ def getB(self, *sources, dupWarning=True):
 
         # Read the field from all nominated sources
         Btotal = sum([s.getB(self.position) for s in sources])
-        return rotatePosition(Btotal,
+        return angleAxisRotation(Btotal,
                               -self.angle,  # Rotate in the opposite direction
                               self.axis,
                               [0, 0, 0])

magpylib/_lib/displaySystem.py

@@ -34,7 +34,7 @@
 from magpylib._lib.utility import drawCurrentArrows, drawMagAxis, drawDipole, isDisplayMarker
 from magpylib._lib.utility import drawSensor, isSensor
 from magpylib._lib.mathLib import angleAxisRotation_priv
-from magpylib._lib.mathLib import rotatePosition
+from magpylib._lib.mathLib import angleAxisRotation
 from magpylib import Collection
 
 
@@ -358,7 +358,7 @@ def displaySystem(sources, markers=listOfPos, subplotAx=None,
                 currentsList.append(sCopyWithVertices)
 
         elif type(s) is Dipole:
-            P = rotatePosition(s.position, s.angle, s.axis)
+            P = angleAxisRotation(s.position, s.angle, s.axis)
             maxSize = amax(abs(P))
             if maxSize > SYSSIZE:
                 SYSSIZE = maxSize

magpylib/_lib/getBvector.py

@@ -23,7 +23,7 @@
 # -------------------------------------------------------------------------------
 from magpylib._lib.fields.PM_Box_vector import Bfield_BoxV
 from magpylib._lib.fields.PM_Sphere_vector import Bfield_SphereV
-from magpylib._lib.mathLib_vector import QconjV, QrotationV, QmultV, getRotQuatV, rotatePositionV
+from magpylib._lib.mathLib_vector import QconjV, QrotationV, QmultV, getRotQuatV, angleAxisRotationV_priv
 import numpy as np
 
 def getBv(type,MAG,DIM,POSo,POSm,ANG=[],AX=[],ANCH=[]):
@@ -81,7 +81,7 @@ def getBv(type,MAG,DIM,POSo,POSm,ANG=[],AX=[],ANCH=[]):
     #apply rotation operations
     for ANGLE,AXIS,ANCHOR in zip(ANG,AX,ANCH):
         Q = QmultV(getRotQuatV(ANGLE,AXIS),Q)
-        Pm = rotatePositionV(ANGLE,AXIS,Pm-ANCHOR)+ANCHOR
+        Pm = angleAxisRotationV_priv(ANGLE,AXIS,Pm-ANCHOR)+ANCHOR
 
     #calculate the B-field
     POSrel = POSo-Pm        #relative position

magpylib/_lib/mathLib.py

@@ -313,7 +313,7 @@ def anglesFromAxis(axis):
     return array([PHI, TH])
 
 
-def rotatePosition(position, angle, axis, anchor=[0, 0, 0]):
+def angleAxisRotation(position, angle, axis, anchor=[0, 0, 0]):
     """
     This function uses angle-axis rotation to rotate the `position` vector by
     the `angle` argument about an axis defined by the `axis` vector which passes
@@ -348,7 +348,7 @@ def rotatePosition(position, angle, axis, anchor=[0, 0, 0]):
     >>> angle = -90
     >>> axis = [0,0,1]
     >>> centerOfRotation = [1,0,0]
-    >>> positionNew = magPy.math.rotatePosition(position0,angle,axis,anchor=centerOfRotation)
+    >>> positionNew = magPy.math.angleAxisRotation(position0,angle,axis,anchor=centerOfRotation)
     >>> print(positionNew)
       [2. 0. 0.]
     """

magpylib/_lib/mathLib_vector.py

@@ -62,7 +62,7 @@ def getRotQuatV(angle, axis):
     return np.swapaxes(Q,0,1)
 
 '''
-def rotatePositionV(angle, axis, v):
+def angleAxisRotationV_priv(angle, axis, v):
     """
     rotates the vector v about axis by angle
     the anchor is the origin    
@@ -121,7 +121,7 @@ def anglesFromAxisV():
     print('WIP')
     return 0
 
-def rotatePositionV(ANGLE, AXIS, V):
+def angleAxisRotationV_priv(ANGLE, AXIS, V):
     """
     rotates the vector v about axis by angle
     the anchor is the origin    

magpylib/_lib/utility.py

@@ -107,8 +107,8 @@ def drawMagnetizationVector(position, magnetization, angle, axis, color, SYSSIZE
         pyplot canvas to draw on
 
     """
-    from magpylib._lib.mathLib import rotatePosition
-    M = rotatePosition(magnetization, angle, axis)
+    from magpylib._lib.mathLib import angleAxisRotation
+    M = angleAxisRotation(magnetization, angle, axis)
     P = position
     # Get a lil different but unique tone
     c = [color[0]/2, color[1]/2, color[2]/2, color[3]]
@@ -131,8 +131,8 @@ def drawSensor(sensor, SYSSIZE, ax):
         pyplot canvas to draw on
 
     """
-    from magpylib._lib.mathLib import rotatePosition
-    M = rotatePosition([1,0,0],sensor.angle,sensor.axis)
+    from magpylib._lib.mathLib import angleAxisRotation
+    M = angleAxisRotation([1,0,0],sensor.angle,sensor.axis)
     P = sensor.position
     ax.quiver(P[0], P[1], P[2],  # X position
               M[0], M[1], M[2],  # Components of the Vector
@@ -141,15 +141,15 @@ def drawSensor(sensor, SYSSIZE, ax):
                   color='r')
     ax.text(M[0]+P[0], M[1]+P[1], M[2]+P[2], "x", None)
 
-    M = rotatePosition([0,1,0],sensor.angle,sensor.axis)
+    M = angleAxisRotation([0,1,0],sensor.angle,sensor.axis)
     ax.quiver(P[0], P[1], P[2],  # Y position
               M[0], M[1], M[2],  # Components of the Vector
                   normalize=True,
                   length=SYSSIZE/4,
                   color='g')
     ax.text(M[0]+P[0], M[1]+P[1], M[2]+P[2], "y", None)
 
-    M = rotatePosition([0,0,1],sensor.angle,sensor.axis)
+    M = angleAxisRotation([0,0,1],sensor.angle,sensor.axis)
     ax.quiver(P[0], P[1], P[2],  # Z position
               M[0], M[1], M[2],  # Components of the Vector
                   normalize=True,
@@ -245,9 +245,9 @@ def drawDipole(position, moment, angle, axis, SYSSIZE, ax):
         canvas to draw on
 
     """
-    from magpylib._lib.mathLib import rotatePosition
-    P = rotatePosition(position, angle, axis)
-    M = rotatePosition(moment, angle, axis)
+    from magpylib._lib.mathLib import angleAxisRotation
+    P = angleAxisRotation(position, angle, axis)
+    M = angleAxisRotation(moment, angle, axis)
 
     ax.quiver(P[0], P[1], P[2],  # X,Y,Z position
                   M[0], M[1], M[2],  # Components of the Vector

magpylib/math/__init__.py

@@ -26,14 +26,14 @@
 relations and genmeralized rotations.
 """
 #__all__ = ["randomAxis", "axisFromAngles", "anglesFromAxis",
-#           "rotatePosition"]  # This is for Sphinx
+#           "angleAxisRotation"]  # This is for Sphinx
 
 from magpylib._lib.mathLib import randomAxis
 from magpylib._lib.mathLib import axisFromAngles
 from magpylib._lib.mathLib import anglesFromAxis
-from magpylib._lib.mathLib import rotatePosition
+from magpylib._lib.mathLib import angleAxisRotation
 
 from magpylib._lib.mathLib_vector import randomAxisV
 from magpylib._lib.mathLib_vector import axisFromAnglesV
 from magpylib._lib.mathLib_vector import anglesFromAxisV
-from magpylib._lib.mathLib_vector import rotatePositionV
+from magpylib._lib.mathLib_vector import angleAxisRotationV_priv

tests/test_Math.py

@@ -2,7 +2,7 @@
 from magpylib._lib.mathLib import Qmult, Qnorm2, Qunit, Qconj, getRotQuat, angleAxisRotation_priv
 from magpylib._lib.mathLib import elliptic, ellipticK, ellipticE, ellipticPi
 from numpy import pi,array
-from magpylib._lib.mathLib import randomAxis, axisFromAngles, anglesFromAxis, rotatePosition
+from magpylib._lib.mathLib import randomAxis, axisFromAngles, anglesFromAxis, angleAxisRotation
 import numpy
 
 # -------------------------------------------------------------------------------
@@ -13,11 +13,11 @@ def test_randomAxis():
     assert all(abs(axis)<=1 for axis in result), "bad randomAxis"
 
 # -------------------------------------------------------------------------------
-def test_rotatePosition():
+def test_angleAxisRotation():
     sol = [-0.26138058, 0.59373138, 3.28125372]
-    result = rotatePosition([1,2,3],234.5,(0,0.2,1),anchor=[0,1,0])
+    result = angleAxisRotation([1,2,3],234.5,(0,0.2,1),anchor=[0,1,0])
     for r,s in zip(result,sol):
-        assert round(r,4) == round(s,4), "bad rotatePosition"
+        assert round(r,4) == round(s,4), "bad angleAxisRotation"
 
 # -------------------------------------------------------------------------------
 def test_anglesFromAxis():

tests/test_magpyVector.py

@@ -4,7 +4,7 @@
 from magpylib.source.magnet import Box
 from magpylib import getBv
 from magpylib.math import axisFromAngles
-from magpylib.math import rotatePositionV
+from magpylib.math import angleAxisRotationV_priv
 
 def test_magpyVector():
 
@@ -54,7 +54,7 @@ def getB(phi,th,psi):
 
     ANG2 = np.array([a for a in TH for _ in range(Nphi*Npsi)])
     angles = np.array([a for a in PSI for _ in range(Nphi)]*Nth)
-    AX2 = rotatePositionV(angles,np.array([[0,0,1]]*NN),np.array([[1,0,0]]*NN))  
+    AX2 = angleAxisRotationV_priv(angles,np.array([[0,0,1]]*NN),np.array([[1,0,0]]*NN))  
     ANCH2 = np.array([anch]*NN)
 
     Bv = getBv('box',MAG,DIM,POSo,POSm,[ANG1,ANG2],[AX1,AX2],[ANCH1,ANCH2])