Full library setup. Unit tests. Doxygen docs.

Author: StefanoLusardiTC

Doxyfile

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-    Copyright 2024 TeiaCare
+    Copyright 2025 TeiaCare
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this project except in compliance with the License.

LICENSE

@@ -1,6 +1,6 @@
 function(add_example EXAMPLE_NAME)
-    add_executable(${EXAMPLE_NAME} src/${EXAMPLE_NAME}.cpp src/utils/video_data_path.cpp)
+    add_executable(${EXAMPLE_NAME} examples/${EXAMPLE_NAME}.cpp)
     target_compile_features(${EXAMPLE_NAME} PUBLIC cxx_std_20)
-    target_link_libraries(${EXAMPLE_NAME} PRIVATE teiacare::video_io)
+    target_link_libraries(${EXAMPLE_NAME} PRIVATE teiacare::image)
     install(TARGETS ${EXAMPLE_NAME} DESTINATION examples)
 endfunction()

cmake/examples.cmake

@@ -5,7 +5,7 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 set(WINDOWS_EXPORT_ALL_SYMBOLS ON)
 set(CONAN_CMAKE_SILENT_OUTPUT ON)
 
-option(TC_ENABLE_UNIT_TESTS "Enable Unit Tests" False)
+option(TC_ENABLE_UNIT_TESTS "Enable Unit Tests" True)
 cmake_print_variables(TC_ENABLE_UNIT_TESTS)
 
 option(TC_ENABLE_UNIT_TESTS_COVERAGE "Enable Unit Tests Coverage" False)

cmake/options.cmake

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright 2024 TeiaCare
+# Copyright 2025 TeiaCare
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

conanfile.py

@@ -10,12 +10,19 @@ configure_file(
 )
 
 set(TARGET_HEADERS
-    include/teiacare/image/img.hpp
+    include/teiacare/image/image_color.hpp
+    include/teiacare/image/image_draw.hpp
+    include/teiacare/image/image_io.hpp
+    include/teiacare/image/image_processing.hpp
+    include/teiacare/image/image_resize.hpp
     include/teiacare/image/version.hpp
 )
 
 set(TARGET_SOURCES
-    src/img.cpp
+    src/image_color.cpp
+    src/image_io.cpp
+    src/image_draw.cpp
+    src/image_resize.cpp
     src/version.cpp
 )
 
@@ -61,16 +68,19 @@ if(TC_ENABLE_UNIT_TESTS)
 
     set(UNIT_TESTS_SRC
         tests/main.cpp
+        tests/test_image_color.cpp
+        tests/test_image_draw.cpp
+        tests/test_image_io.cpp
+        tests/test_image_processing.cpp
+        tests/test_image_resize.cpp
     )
 
     add_executable(${TEST_TARGET_NAME})
     target_sources(${TEST_TARGET_NAME} PRIVATE ${UNIT_TESTS_SRC})
-    target_include_directories(${TEST_TARGET_NAME} PRIVATE  ${CMAKE_CURRENT_BINARY_DIR}/proto)
     target_compile_features(${TEST_TARGET_NAME} PUBLIC cxx_std_20)
     target_link_libraries(${TEST_TARGET_NAME}
         PRIVATE
             GTest::gtest
-            GTest::gmock
             teiacare::image
     )
 
@@ -91,8 +101,9 @@ endif()
 #################################################################
 # Examples
 if(TC_ENABLE_EXAMPLES)
-    add_executable(example_image examples/example.cpp)
-    target_compile_features(example_image PUBLIC cxx_std_20)
-    target_link_libraries(example_image PRIVATE teiacare::image)
-    install(TARGETS example_image DESTINATION examples)
+    include(examples)
+    add_example(example_image_io)
+    add_example(example_image_draw)
+    add_example(example_image_resize)
+    add_example(example_image_preprocessing)
 endif()

image/CMakeLists.txt

@@ -0,0 +1,62 @@
+// Copyright 2025 TeiaCare
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @example example_image_draw.cpp
+ * @brief Drawing primitives example demonstrating tc::img::draw_rectangle, tc::img::draw_polygon, and tc::img::color usage
+ */
+
+#include <teiacare/image/image_draw.hpp>
+#include <teiacare/image/image_io.hpp>
+
+#include <filesystem>
+#include <iostream>
+#include <vector>
+
+int main(int, char**)
+{
+    // Load image from jpeg file
+    const std::filesystem::path input_image_path = "img.jpeg";
+    auto [img_data, width, height, channels] = tc::img::image_load(input_image_path);
+
+    {
+        std::array<int, 4> box = {50, 50, 200, 100};
+        tc::img::color color = tc::img::color::red();
+        int thickness = 1;
+        draw_rectangle(img_data, width, height, box[0], box[1], box[2], box[3], color, thickness);
+    }
+
+    {
+        std::array<int, 4> box = {300, 200, 150, 250};
+        tc::img::color color(255, 165, 0); // Orange color
+        int thickness = 3;
+        draw_rectangle(img_data, width, height, box[0], box[1], box[2], box[3], color, thickness);
+    }
+
+    {
+        std::vector<std::pair<int, int>> polygon = {{100, 500}, {200, 600}, {50, 600}};
+        draw_polygon(img_data, width, height, polygon, tc::img::color(0, 0, 255), 3);
+    }
+
+    {
+        std::vector<std::pair<int, int>> polygon = {{150, 350}, {250, 320}, {320, 380}, {280, 450}, {200, 480}, {120, 460}, {80, 400}};
+        draw_polygon(img_data, width, height, polygon, tc::img::color(0, 255, 127), 2);
+    }
+
+    // Save image to png file
+    const std::filesystem::path output_image_path = "img_draw.png";
+    tc::img::image_save(output_image_path, img_data, width, height, channels);
+
+    return 0;
+}

image/examples/example_image_draw.cpp

@@ -1,4 +1,4 @@
-// Copyright 2024 TeiaCare
+// Copyright 2025 TeiaCare
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,35 +12,38 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include <teiacare/image/img.hpp>
+/**
+ * @example example_image_io.cpp
+ * @brief Image input/output example demonstrating tc::img::image_load, tc::img::image_save, tc::img::image_load_as_binary, and tc::img::image_load_from_memory
+ */
+
+#include <teiacare/image/image_io.hpp>
 
 #include <filesystem>
-#include <iostream>
-#include <vector>
 
-int main(int argc, char** argv)
+int main(int, char**)
 {
     {
         // Load image from jpeg file
         const std::filesystem::path input_image_path = "img.jpeg";
-        auto [img_data, width, height, channels] = tc::img::load_image(input_image_path);
+        auto [img_data, width, height, channels] = tc::img::image_load(input_image_path);
 
         // Save image to png file
         const std::filesystem::path output_image_path = "img.png";
-        tc::img::save_image(output_image_path, img_data, width, height, channels);
+        tc::img::image_save(output_image_path, img_data, width, height, channels);
     }
 
     {
         // Load image from binary data
         const std::filesystem::path input_image_path = "img.jpeg";
-        auto bin_img = tc::img::load_image_as_binary(input_image_path);
+        auto bin_img = tc::img::image_load_as_binary(input_image_path);
 
         // Create image data from binary image data
-        auto [img_data, width, height, channels] = tc::img::load_image_from_memory(bin_img.data(), bin_img.size());
+        auto [img_data, width, height, channels] = tc::img::image_load_from_memory(bin_img.data(), bin_img.size());
 
         // Save image to png file
         const std::filesystem::path output_image_path = "out.png";
-        tc::img::save_image(output_image_path, img_data, width, height, channels);
+        tc::img::image_save(output_image_path, img_data, width, height, channels);
     }
 
     return 0;

image/examples/example.cpp image/examples/example_image_io.cppimage/examples/example.cpp renamed to image/examples/example_image_io.cpp

@@ -0,0 +1,50 @@
+// Copyright 2025 TeiaCare
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @example example_image_preprocessing.cpp
+ * @brief Image preprocessing pipeline example demonstrating tc::img::image_resize_aspect_ratio and tc::img::create_blob for ML preprocessing
+ */
+
+#include <teiacare/image/image_io.hpp>
+#include <teiacare/image/image_processing.hpp>
+#include <teiacare/image/image_resize.hpp>
+
+#include <cassert>
+#include <filesystem>
+#include <iostream>
+#include <vector>
+
+int main(int argc, char** argv)
+{
+    // Load image from jpeg file
+    const std::filesystem::path input_image_path = "img.jpeg";
+    auto [img_data, width, height, channels] = tc::img::image_load(input_image_path);
+
+    // Preprocess image with aspect ratio resizing and blob creation
+    const int target_width = 640;
+    const int target_height = 640;
+    const float scale_factor = 1.0f / 255.0f;
+    const std::vector<float> mean = {0.0f, 0.0f, 0.0f};
+    const bool swapRB_channels = false;
+
+    const std::vector<std::uint8_t> resized_image = tc::img::image_resize_aspect_ratio(img_data, width, height, channels, target_width, target_height);
+    const std::vector<float> blob = tc::img::create_blob(resized_image, target_width, target_height, channels, scale_factor, mean, swapRB_channels);
+
+    std::cout << "Blob size: " << blob.size() << std::endl;
+    std::cout << "Img size: " << target_width * target_height * channels << std::endl;
+    assert(blob.size() == target_width * target_height * channels);
+
+    return 0;
+}

image/examples/example_image_preprocessing.cpp

@@ -0,0 +1,43 @@
+// Copyright 2025 TeiaCare
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @example example_image_resize.cpp
+ * @brief Image resizing example demonstrating tc::img::image_resize_aspect_ratio for preserving aspect ratio during resize operations
+ */
+
+#include <teiacare/image/image_io.hpp>
+#include <teiacare/image/image_resize.hpp>
+
+#include <filesystem>
+#include <iostream>
+#include <vector>
+
+int main(int argc, char** argv)
+{
+    // Load image from jpeg file
+    const std::filesystem::path input_image_path = "img.jpeg";
+    auto [img_data, width, height, channels] = tc::img::image_load(input_image_path);
+
+    // Resize image to 300x300 while preserving aspect ratio
+    const int target_width = 300;
+    const int target_height = 300;
+    auto resized_image = tc::img::image_resize_aspect_ratio(img_data, width, height, channels, target_width, target_height);
+
+    // Save image to png file
+    const std::filesystem::path output_image_path = "img_resized.png";
+    tc::img::image_save(output_image_path, resized_image, target_width, target_height, channels);
+
+    return 0;
+}