-
Notifications
You must be signed in to change notification settings - Fork 286
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1396 from s-trinh/add_testNPZ
Add basic I/O tests for visp::cnpy::npz_load(), visp::cnpy::npz_save() functions
- Loading branch information
Showing
2 changed files
with
228 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
/**************************************************************************** | ||
* | ||
* ViSP, open source Visual Servoing Platform software. | ||
* Copyright (C) 2005 - 2024 by Inria. All rights reserved. | ||
* | ||
* This software is free software; you can redistribute it and/or modify | ||
* it under the terms of the GNU General Public License as published by | ||
* the Free Software Foundation; either version 2 of the License, or | ||
* (at your option) any later version. | ||
* See the file LICENSE.txt at the root directory of this source | ||
* distribution for additional information about the GNU GPL. | ||
* | ||
* For using ViSP with software that can not be combined with the GNU | ||
* GPL, please contact Inria about acquiring a ViSP Professional | ||
* Edition License. | ||
* | ||
* See https://visp.inria.fr for more information. | ||
* | ||
* This software was developed at: | ||
* Inria Rennes - Bretagne Atlantique | ||
* Campus Universitaire de Beaulieu | ||
* 35042 Rennes Cedex | ||
* France | ||
* | ||
* If you have questions regarding the use of this file, please contact | ||
* Inria at [email protected] | ||
* | ||
* This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE | ||
* WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. | ||
* | ||
* Description: | ||
* Test visp::cnpy::npz_load() / visp::cnpy::npy_save() functions. | ||
* | ||
*****************************************************************************/ | ||
|
||
#include <iostream> | ||
#include <visp3/core/vpConfig.h> | ||
#include <visp3/core/vpEndian.h> | ||
|
||
#if defined(VISP_HAVE_CATCH2) && \ | ||
(defined(_WIN32) || (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__)))) && \ | ||
defined(VISP_LITTLE_ENDIAN) | ||
#define CATCH_CONFIG_RUNNER | ||
#include <catch.hpp> | ||
|
||
#include <visp3/core/vpIoTools.h> | ||
|
||
namespace | ||
{ | ||
std::string createTmpDir() | ||
{ | ||
std::string username; | ||
vpIoTools::getUserName(username); | ||
|
||
#if defined(_WIN32) | ||
std::string tmp_dir = "C:/temp/" + username; | ||
#elif (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__))) | ||
std::string tmp_dir = "/tmp/" + username; | ||
#endif | ||
std::string directory_filename = tmp_dir + "/testNPZ/"; | ||
|
||
vpIoTools::makeDirectory(directory_filename); | ||
return directory_filename; | ||
} | ||
} | ||
|
||
TEST_CASE("Test visp::cnpy::npy_load/npz_save", "[visp::cnpy I/O]") | ||
{ | ||
std::string directory_filename = createTmpDir(); | ||
REQUIRE(vpIoTools::checkDirectory(directory_filename)); | ||
std::string npz_filename = directory_filename + "/test_npz_read_write.npz"; | ||
|
||
SECTION("Read/Save string data") | ||
{ | ||
const std::string save_string = "Open Source Visual Servoing Platform"; | ||
std::vector<char> vec_save_string(save_string.begin(), save_string.end()); | ||
const std::string identifier = "String"; | ||
visp::cnpy::npz_save(npz_filename, identifier, &vec_save_string[0], { vec_save_string.size() }, "w"); | ||
|
||
visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename); | ||
visp::cnpy::NpyArray arr_string_data = npz_data[identifier]; | ||
std::vector<char> vec_arr_string_data = arr_string_data.as_vec<char>(); | ||
// For null-terminated character handling, see: | ||
// https://stackoverflow.com/a/8247804 | ||
// https://stackoverflow.com/a/45491652 | ||
const std::string read_string = std::string(vec_arr_string_data.begin(), vec_arr_string_data.end()); | ||
CHECK(save_string == read_string); | ||
} | ||
|
||
SECTION("Read/Save multi-dimensional array") | ||
{ | ||
size_t height = 5, width = 7, channels = 3; | ||
std::vector<int> save_vec; | ||
save_vec.reserve(height*width*channels); | ||
for (size_t i = 0; i < height*width*channels; i++) { | ||
save_vec.push_back(i); | ||
} | ||
|
||
const std::string identifier = "Array"; | ||
visp::cnpy::npz_save(npz_filename, identifier, &save_vec[0], { height, width, channels }, "a"); // append | ||
visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename); | ||
visp::cnpy::NpyArray arr_vec_data = npz_data[identifier]; | ||
std::vector<int> read_vec = arr_vec_data.as_vec<int>(); | ||
|
||
REQUIRE(save_vec.size() == read_vec.size()); | ||
for (size_t i = 0; i < read_vec.size(); i++) { | ||
CHECK(save_vec[i] == read_vec[i]); | ||
} | ||
} | ||
|
||
REQUIRE(vpIoTools::remove(directory_filename)); | ||
REQUIRE(!vpIoTools::checkDirectory(directory_filename)); | ||
} | ||
|
||
// https://en.cppreference.com/w/cpp/types/integer | ||
// https://github.com/catchorg/Catch2/blob/devel/docs/test-cases-and-sections.md#type-parametrised-test-cases | ||
using BasicTypes = std::tuple<uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float, double>; | ||
TEMPLATE_LIST_TEST_CASE("Test visp::cnpy::npy_load/npz_save", "[BasicTypes][list]", BasicTypes) | ||
{ | ||
std::string directory_filename = createTmpDir(); | ||
REQUIRE(vpIoTools::checkDirectory(directory_filename)); | ||
std::string npz_filename = directory_filename + "/test_npz_read_write.npz"; | ||
|
||
const std::string identifier = "data"; | ||
TestType save_data = std::numeric_limits<TestType>::min(); | ||
visp::cnpy::npz_save(npz_filename, identifier, &save_data, { 1 }, "w"); | ||
|
||
visp::cnpy::npz_t npz_data = visp::cnpy::npz_load(npz_filename); | ||
visp::cnpy::NpyArray arr_data = npz_data[identifier]; | ||
TestType read_data = *arr_data.data<TestType>(); | ||
CHECK(save_data == read_data); | ||
|
||
save_data = std::numeric_limits<TestType>::max(); | ||
visp::cnpy::npz_save(npz_filename, identifier, &save_data, { 1 }, "a"); // append | ||
|
||
npz_data = visp::cnpy::npz_load(npz_filename); | ||
arr_data = npz_data[identifier]; | ||
read_data = *arr_data.data<TestType>(); | ||
CHECK(save_data == read_data); | ||
|
||
REQUIRE(vpIoTools::remove(directory_filename)); | ||
REQUIRE(!vpIoTools::checkDirectory(directory_filename)); | ||
} | ||
|
||
int main(int argc, char *argv[]) | ||
{ | ||
Catch::Session session; // There must be exactly one instance | ||
|
||
// Let Catch (using Clara) parse the command line | ||
session.applyCommandLine(argc, argv); | ||
|
||
int numFailed = session.run(); | ||
|
||
// numFailed is clamped to 255 as some unices only use the lower 8 bits. | ||
// This clamping has already been applied, so just return it here | ||
// You can also do any post run clean-up here | ||
return numFailed; | ||
} | ||
#else | ||
int main() { return EXIT_SUCCESS; } | ||
#endif |