summaryrefslogtreecommitdiff
path: root/transform.py
diff options
context:
space:
mode:
authorAnthony LaTorre <telatorre@gmail.com>2011-05-17 16:58:36 -0400
committerAnthony LaTorre <telatorre@gmail.com>2011-05-17 16:58:36 -0400
commit909309302c83423994e9c1dd36a3309890a67b90 (patch)
treeade31f97ba43172820efd7bb80d5dd70bffa87c5 /transform.py
parent8df5c2109151613d6ed1c124095c8e6e0f98f3af (diff)
downloadchroma-909309302c83423994e9c1dd36a3309890a67b90.tar.gz
chroma-909309302c83423994e9c1dd36a3309890a67b90.tar.bz2
chroma-909309302c83423994e9c1dd36a3309890a67b90.zip
added documentation
Diffstat (limited to 'transform.py')
-rw-r--r--transform.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/transform.py b/transform.py
index 4e5eb9c..cab23fb 100644
--- a/transform.py
+++ b/transform.py
@@ -1,6 +1,12 @@
import numpy as np
def rotate(x, phi, n):
+ """
+ Rotate an array of points `x` through an angle phi counter-clockwise
+ around the axis `n` (when looking towards +infinity).
+
+ Source: Weisstein, Eric W. "Rotation Formula." Mathworld.
+ """
x = np.asarray(x)
n = np.asarray(n)