feat: cleaning

Author: edmBernard

.gitignore

@@ -1,8 +1,10 @@
+/.vscode
+
+__pycache__
 *.pyc
 *.egg-info
 *.so
-__pycache__
-/.vscode
+
 /build
 /build*
 /tmp

Readme.md

@@ -2,7 +2,7 @@
 
 Binding between cv::Mat and np.array. And a small code example of how it work. the code work for `OpenCV 2.4`, `OpenCV 3+` and `OpenCV 4+`
 
-The code in this repository create a simple binding, function in c++ are implemented in `example.cpp` file and the script that use them is `test.py`.
+The code in this repository create a simple binding, function in c++ are implemented in `example.cpp` file and the script that use them is `example.py`.
 
 ```bash
 /project folder
@@ -35,10 +35,11 @@ mkdir build
 cd build
 # configure make with vcpkg toolchain
 cmake .. -DCMAKE_TOOLCHAIN_FILE=${VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake
+# on Windows : cmake.exe .. -DCMAKE_TOOLCHAIN_FILE="$Env:VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
 # generate the example.so library
-make
+cmake --build . --config Release
 # move example.so library in example folder
-make install
+cmake --install . --config Release
 ```
 
 ## Generation with setup.py
@@ -47,7 +48,7 @@ make install
 ### install pybind11
 
 ```
-pip3 install pybind11
+python3 -m pip3 install pybind11
 ```
 
 ### Compile

test.py example.pytest.py renamed to example.py

@@ -3,7 +3,7 @@
 import copy
 
 # Read from c++
-a = eb.read_image("test.png")
+a = eb.read_image("tests/images/test.png")
 print('init a: 0x%x' % id(a))
 eb.show_image(a)  # work
 

tests/cpp/test.cpp

@@ -0,0 +1,66 @@
+#include <pybind11/pybind11.h>
+#include <pybind11/stl.h>
+
+
+#include <opencv2/core/core.hpp>
+#include <opencv2/highgui/highgui.hpp>
+#include <opencv2/imgproc.hpp>
+
+#include <iostream>
+#include <string>
+
+#include "ndarray_converter.h"
+
+namespace py = pybind11;
+
+void show_image(cv::Mat image) {
+  cv::imshow("image_from_Cpp", image);
+  cv::waitKey(0);
+}
+
+cv::Mat read_image(std::string image_name) {
+#if CV_MAJOR_VERSION < 4
+  cv::Mat image = cv::imread(image_name, CV_LOAD_IMAGE_COLOR);
+#else
+  cv::Mat image = cv::imread(image_name, cv::IMREAD_COLOR);
+#endif
+  return image;
+}
+
+cv::Mat passthru(cv::Mat image) {
+  return image;
+}
+
+cv::Mat cloneimg(cv::Mat image) {
+  return image.clone();
+}
+
+class AddClass {
+public:
+  AddClass(int value) : value(value) {}
+
+  cv::Mat add(cv::Mat input) {
+    return input + this->value;
+  }
+
+private:
+  int value;
+};
+
+PYBIND11_MODULE(example, m) {
+
+  NDArrayConverter::init_numpy();
+
+  m.def("read_image", &read_image, "A function that read an image",
+        py::arg("image"));
+
+  m.def("show_image", &show_image, "A function that show an image",
+        py::arg("image"));
+
+  m.def("passthru", &passthru, "Passthru function", py::arg("image"));
+  m.def("clone", &cloneimg, "Clone function", py::arg("image"));
+
+  py::class_<AddClass>(m, "AddClass")
+    .def(py::init<int>())
+    .def("add", &AddClass::add);
+}

test.png tests/images/test.pngtest.png renamed to tests/images/test.png

@@ -0,0 +1,41 @@
+import numpy as np
+import test_module.test as test
+import copy
+
+# Read from c++
+a = test.read_image("test.png")
+print('init a: 0x%x' % id(a))
+test.show_image(a)  # work
+
+# Check continuous problem from old version
+b = a[:, :, 0]
+test.show_image(b)  # work no more continous problem
+print('diff b: 0x%x' % id(b))
+
+c = copy.deepcopy(b)
+test.show_image(c)  # still works
+print('diff c: 0x%x' % id(c))
+
+
+# Proves that it's still the same thing
+d = test.passthru(a)
+print('same d: 0x%x' % id(b))
+
+# Make a copy
+e = test.clone(d)
+print('diff e: 0x%x' % id(e))
+
+
+# different allocator
+f = np.zeros(shape=(100, 100), dtype=np.uint8)
+print('\ninit e: 0x%x' % id(f))
+
+g = test.passthru(f)
+print('same f: 0x%x' % id(g))
+
+
+# example of class
+my_class = test.AddClass(1)
+h = my_class.add(f)
+print(f[0, 0])  # expected 0
+print(h[0, 0])  # expected 1