Differences

This shows you the differences between two versions of the page.

--- jvs:cigal:manual:chapter3:matmul [2011/03/31 14:49]
127.0.0.1 external edit
+++ jvs:cigal:manual:chapter3:matmul [2023/02/23 18:43] (current)
@@ Line 1: / Line 1: @@
 **CIGAL Reference Manual, Chapter 3 (Functions): matmul**
-===== matmul -- (unimplemented) =====
+===== matmul -- multiply vector(s) by a transformation matrix =====
-**        **
+**usage:  v2 = matmul(v1,mtx)**
-          (unimplemented)
-**See Also:**\\
+The MATMUL function multiplies a vector, or an array of vectors, by a 2D matrix, MTX. The input vectors can have dimensionality (NDIM) of 2 or 3 (e.g. XY or XYZ values). The matrix, MTX, is a square affine transform that has dimensions (NDIM+1) X (NDIM+1).
+V1 can be a single 2D or 3D vector, an array of vectors stored as a vector list, or a matrix where each row is treated as a vector (e.g. matrix with dimensions 2xN, or 3xN).
+Each vector in V1 will be multiplied by the transformation matrix, MTX, to yield an output variable, V2, with the same dimensions as V1.
+**See Also:**\\
 [[jvs:cigal|CIGAL Home]],
 [[jvs:cigal:manual|CIGAL Manual]],

Brain Imaging & Analysis Center