Visual Servoing Platform  version 3.5.0 under development (2022-02-15)
vpDiskGrabber.h
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  * Disk framegrabber.
33  *
34  * Authors:
35  * Eric Marchand
36  *
37  *****************************************************************************/
38 
43 #ifndef vpDiskGrabber_hh
44 #define vpDiskGrabber_hh
45 
46 #include <string>
47 
48 #include <visp3/core/vpDebug.h>
49 #include <visp3/core/vpFrameGrabber.h>
50 #include <visp3/core/vpRGBa.h>
51 #include <visp3/io/vpImageIo.h>
52 
108 class VISP_EXPORT vpDiskGrabber : public vpFrameGrabber
109 {
110 private:
111  long m_image_number;
112  long m_image_number_next;
113  long m_image_step;
114  unsigned int m_number_of_zero;
115 
117  std::string m_directory;
118  std::string m_base_name;
119  std::string m_extension;
120 
121  bool m_use_generic_name;
122  std::string m_generic_name;
123  std::string m_image_name;
124 
125 public:
126  vpDiskGrabber();
127  explicit vpDiskGrabber(const std::string &genericName);
128  explicit vpDiskGrabber(const std::string &dir, const std::string &basename, long number, int step, unsigned int noz,
129  const std::string &ext);
130  virtual ~vpDiskGrabber();
131 
133  void acquire(vpImage<vpRGBa> &I);
134  void acquire(vpImage<float> &I);
135  void acquire(vpImage<unsigned char> &I, long image_number);
136  void acquire(vpImage<vpRGBa> &I, long image_number);
137  void acquire(vpImage<float> &I, long image_number);
138 
139  void close();
140 
144  inline long getImageNumber() const { return m_image_number; };
148  inline std::string getImageName() const { return m_image_name; };
149 
150  void open(vpImage<unsigned char> &I);
151  void open(vpImage<vpRGBa> &I);
152  void open(vpImage<float> &I);
153 
154  void setBaseName(const std::string &name);
155  void setDirectory(const std::string &dir);
156  void setExtension(const std::string &ext);
157  void setGenericName(const std::string &genericName);
158  void setImageNumber(long number);
159  void setNumberOfZero(unsigned int noz);
160  void setStep(long step);
161 };
162 
163 #endif
long getImageNumber() const
virtual void open(vpImage< unsigned char > &I)=0
std::string getImageName() const
Class to grab (ie. read) images from the disk.
Base class for all video devices. It is designed to provide a front end to video sources.
virtual void close()=0
virtual void acquire(vpImage< unsigned char > &I)=0