Visual Servoing Platform version 3.5.0
testIoPGM.cpp
1/****************************************************************************
2 *
3 * ViSP, open source Visual Servoing Platform software.
4 * Copyright (C) 2005 - 2019 by Inria. All rights reserved.
5 *
6 * This software is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 * See the file LICENSE.txt at the root directory of this source
11 * distribution for additional information about the GNU GPL.
12 *
13 * For using ViSP with software that can not be combined with the GNU
14 * GPL, please contact Inria about acquiring a ViSP Professional
15 * Edition License.
16 *
17 * See http://visp.inria.fr for more information.
18 *
19 * This software was developed at:
20 * Inria Rennes - Bretagne Atlantique
21 * Campus Universitaire de Beaulieu
22 * 35042 Rennes Cedex
23 * France
24 *
25 * If you have questions regarding the use of this file, please contact
26 * Inria at visp@inria.fr
27 *
28 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
29 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
30 *
31 * Description:
32 * Read and write PGM images on the disk.
33 *
34 * Authors:
35 * Eric Marchand
36 * Fabien Spindler
37 *
38 *****************************************************************************/
39
40#include <stdio.h>
41#include <stdlib.h>
42#include <visp3/core/vpDebug.h>
43#include <visp3/core/vpImage.h>
44#include <visp3/core/vpIoTools.h>
45#include <visp3/io/vpImageIo.h>
46#include <visp3/io/vpParseArgv.h>
47
55// List of allowed command line options
56#define GETOPTARGS "cdi:o:h"
57
58/*
59
60 Print the program options.
61
62 \param name : Program name.
63 \param badparam : Bad parameter name.
64 \param ipath: Input image path.
65 \param opath : Output image path.
66 \param user : Username.
67
68 */
69void usage(const char *name, const char *badparam, const std::string &ipath, const std::string &opath,
70 const std::string &user)
71{
72 fprintf(stdout, "\n\
73Read and write PGM images on the disk. Also test exceptions.\n\
74\n\
75SYNOPSIS\n\
76 %s [-i <input image path>] [-o <output image path>]\n\
77 [-h]\n \
78", name);
79
80 fprintf(stdout, "\n\
81OPTIONS: Default\n\
82 -i <input image path> %s\n\
83 Set image input path.\n\
84 From this path read \"Klimt/Klimt.pgm\"\n\
85 image.\n\
86 Setting the VISP_INPUT_IMAGE_PATH environment\n\
87 variable produces the same behaviour than using\n\
88 this option.\n\
89\n\
90 -o <output image path> %s\n\
91 Set image output path.\n\
92 From this directory, creates the \"%s\"\n\
93 subdirectory depending on the username, where \n\
94 Klimt_grey.pgm output image is written.\n\
95\n\
96 -h\n\
97 Print the help.\n\n", ipath.c_str(), opath.c_str(), user.c_str());
98
99 if (badparam)
100 fprintf(stdout, "\nERROR: Bad parameter [%s]\n", badparam);
101}
102
115bool getOptions(int argc, const char **argv, std::string &ipath, std::string &opath, const std::string &user)
116{
117 const char *optarg_;
118 int c;
119 while ((c = vpParseArgv::parse(argc, argv, GETOPTARGS, &optarg_)) > 1) {
120
121 switch (c) {
122 case 'i':
123 ipath = optarg_;
124 break;
125 case 'o':
126 opath = optarg_;
127 break;
128 case 'h':
129 usage(argv[0], NULL, ipath, opath, user);
130 return false;
131 break;
132
133 case 'c':
134 case 'd':
135 break;
136
137 default:
138 usage(argv[0], optarg_, ipath, opath, user);
139 return false;
140 break;
141 }
142 }
143
144 if ((c == 1) || (c == -1)) {
145 // standalone param or error
146 usage(argv[0], NULL, ipath, opath, user);
147 std::cerr << "ERROR: " << std::endl;
148 std::cerr << " Bad argument " << optarg_ << std::endl << std::endl;
149 return false;
150 }
151
152 return true;
153}
154
155int main(int argc, const char **argv)
156{
157 try {
158 std::string env_ipath;
159 std::string opt_ipath;
160 std::string opt_opath;
161 std::string ipath;
162 std::string opath;
163 std::string filename;
164 std::string username;
165
166 // Get the visp-images-data package path or VISP_INPUT_IMAGE_PATH
167 // environment variable value
169
170 // Set the default input path
171 if (!env_ipath.empty())
172 ipath = env_ipath;
173
174// Set the default output path
175#if defined(_WIN32)
176 opt_opath = "C:/temp";
177#else
178 opt_opath = "/tmp";
179#endif
180
181 // Get the user login name
182 vpIoTools::getUserName(username);
183
184 // Read the command line options
185 if (getOptions(argc, argv, opt_ipath, opt_opath, username) == false) {
186 exit(-1);
187 }
188
189 // Get the option values
190 if (!opt_ipath.empty())
191 ipath = opt_ipath;
192 if (!opt_opath.empty())
193 opath = opt_opath;
194
195 // Append to the output path string, the login name of the user
196 opath = vpIoTools::createFilePath(opath, username);
197
198 // Test if the output path exist. If no try to create it
199 if (vpIoTools::checkDirectory(opath) == false) {
200 try {
201 // Create the dirname
203 } catch (...) {
204 usage(argv[0], NULL, ipath, opt_opath, username);
205 std::cerr << std::endl << "ERROR:" << std::endl;
206 std::cerr << " Cannot create " << opath << std::endl;
207 std::cerr << " Check your -o " << opt_opath << " option " << std::endl;
208 exit(-1);
209 }
210 }
211
212 // Compare ipath and env_ipath. If they differ, we take into account
213 // the input path comming from the command line option
214 if (!opt_ipath.empty() && !env_ipath.empty()) {
215 if (ipath != env_ipath) {
216 std::cout << std::endl << "WARNING: " << std::endl;
217 std::cout << " Since -i <visp image path=" << ipath << "> "
218 << " is different from VISP_IMAGE_PATH=" << env_ipath << std::endl
219 << " we skip the environment variable." << std::endl;
220 }
221 }
222
223 // Test if an input path is set
224 if (opt_ipath.empty() && env_ipath.empty()) {
225 usage(argv[0], NULL, ipath, opt_opath, username);
226 std::cerr << std::endl << "ERROR:" << std::endl;
227 std::cerr << " Use -i <visp image path> option or set VISP_INPUT_IMAGE_PATH " << std::endl
228 << " environment variable to specify the location of the " << std::endl
229 << " image path where test images are located." << std::endl
230 << std::endl;
231 exit(-1);
232 }
233
234 //
235 // Here starts really the test
236 //
237
238 // Create a grey level image
240
241 // Load a grey image from the disk
242 filename = vpIoTools::createFilePath(ipath, "Klimt/Klimt.pgm");
243 std::cout << "Read image: " << filename << std::endl;
244 vpImageIo::read(I, filename);
245 // Write the content of the image on the disk
246 filename = vpIoTools::createFilePath(opath, "Klimt_grey.pgm");
247 std::cout << "Write image: " << filename << std::endl;
248 vpImageIo::write(I, filename);
249
250 try {
251 // Try to load a non existing image (test for exceptions)
252 // Load a non existing grey image
253 filename = vpIoTools::createFilePath(ipath, "image-that-does-not-exist.pgm");
254 std::cout << "Read image: " << filename << std::endl;
255 vpImageIo::read(I, filename);
256 } catch (const vpException &e) {
257 std::cout << "Catch an exception due to a non existing file: " << e << std::endl;
258 }
259
260 try {
261 // Try to write an image to a non existing directory
262 filename = vpIoTools::createFilePath(opath, "directory-that-does-not-exist/Klimt.pgm");
263 std::cout << "Write image: " << filename << std::endl;
264 vpImageIo::write(I, filename);
265 } catch (const vpException &e) {
266 std::cout << "Catch an exception due to a non existing file: " << e << std::endl;
267 }
268 return 0;
269 } catch (const vpException &e) {
270 std::cout << "Catch an exception: " << e << std::endl;
271 return 1;
272 }
273}
error that can be emited by ViSP classes.
Definition: vpException.h:72
static void read(vpImage< unsigned char > &I, const std::string &filename, int backend=IO_DEFAULT_BACKEND)
Definition: vpImageIo.cpp:149
static void write(const vpImage< unsigned char > &I, const std::string &filename, int backend=IO_DEFAULT_BACKEND)
Definition: vpImageIo.cpp:293
static std::string getViSPImagesDataPath()
Definition: vpIoTools.cpp:1365
static bool checkDirectory(const std::string &dirname)
Definition: vpIoTools.cpp:420
static std::string getUserName()
Definition: vpIoTools.cpp:316
static std::string createFilePath(const std::string &parent, const std::string &child)
Definition: vpIoTools.cpp:1670
static void makeDirectory(const std::string &dirname)
Definition: vpIoTools.cpp:570
static bool parse(int *argcPtr, const char **argv, vpArgvInfo *argTable, int flags)
Definition: vpParseArgv.cpp:69