parameters

[imago.git] / pcf.c

diff --git a/pcf.c b/pcf.c
index 1682dbb..cc41aa3 100644 (file)
--- a/pcf.c
+++ b/pcf.c
@@ -1,6 +1,9 @@
 #include <Python.h>
 #include <math.h>
 
+/* TODO delete or document this
+ *
+ */
 static PyObject* py_combine(PyObject* self, PyObject* args)
 {
        const unsigned char *im_bg;
@@ -25,6 +28,12 @@ static PyObject* py_combine(PyObject* self, PyObject* args)
        return Py_BuildValue("d", ((double) sum) / area);
 }
 
+/* Hough transform
+ *
+ * Takes dimentions of the image, the image, initial angle and TODO dt is what?.
+ * Computes Hough transform of the image. TODO size etc.
+ *
+ */
 static PyObject* py_hough(PyObject* self, PyObject* args)
 {
        const unsigned char *image;
@@ -48,6 +57,9 @@ static PyObject* py_hough(PyObject* self, PyObject* args)
        PyObject *result;
 
        if (!PyArg_ParseTuple(args, "(ii)s#dd", &x, &y, &image, &size, &init_angle, &dt)) return NULL;
+       // x and y are width and height of the image as ints
+       // Python sends image as (byte)string and since it is not null-terminated, must send its size
+       // init_angle and dt are doubles
        
 
        matrix = (int*) malloc(size * sizeof(int));
@@ -95,6 +107,10 @@ static PyObject* py_hough(PyObject* self, PyObject* args)
        return result;
 }
 
+/* Edge detection
+ *
+ * Takes image size, the image, and the size of TODO what?
+ */
 static PyObject* py_edge(PyObject* self, PyObject* args)
 {
        const unsigned char *image;
@@ -110,6 +126,8 @@ static PyObject* py_edge(PyObject* self, PyObject* args)
        PyObject *result;
 
        if (!PyArg_ParseTuple(args, "(ii)s#", &x, &y, &image, &size)) return NULL;
+       // x and y are width and height of the image as ints
+       // Python sends image as (byte)string and since it is not null-terminated, must send its size
 
        n_image = (char*) malloc(size);
        for (i=0; i < 2 * x; i++) {