changeset 1805:3e449fcd75bb

Added some documentation
author bert <bert>
date Fri, 04 Jun 2004 21:21:57 +0000
parents 6ee56f38f3f7
children ef2d8ae4468b
files libsrc2/convert.c
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libsrc2/convert.c
+++ b/libsrc2/convert.c
@@ -116,6 +116,7 @@
     return (MI_NOERROR);
 }
 
+/** Convert a */
 int 
 miconvert_3D_voxel_to_spatial_frequency(mihandle_t volume,
                                         const double voxel[MI2_3D],
@@ -134,6 +135,10 @@
     return (MI_NOERROR);
 }
 
+/**
+ * This function converts coordinates in voxel coordinates to world 
+ * coordinates.  Only the spatial coordinates are converted.
+ */
 int
 miconvert_voxel_to_world(midimhandle_t dimensions[],
                          int ndims,
@@ -143,6 +148,10 @@
     return (MI_NOERROR);
 }
 
+/**
+ * This function converts coordinates in world coordinates to voxel
+ * coordinates.  Only the spatial coordinates are converted.
+ */
 int
 miconvert_world_to_voxel(midimhandle_t dimensions[],
                          int ndims,