iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImageFilesSource.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies (voorhies@usc.edu)
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 
36 #ifndef INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_IMAGEFILESSOURCE_H
37 #define INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_IMAGEFILESSOURCE_H
38 
41 
42 namespace nrt
43 {
44  namespace imagefilessource
45  {
46  NRT_DECLARE_PARAMETER_WITH_CALLBACK(path, std::string, "Path", "", nrt::imagesource::ParamCateg);
47  }
48 
49  //! A SeekableImageSourceType for opening sequences of images
50  /*! This ImageSourceType is used to read a sequence of image files as a
51  continuous stream. The files are selected by setting the 'images'
52  parameter, using a syntax like /path/to/my/images#.jpg. Image files are
53  decoded using the nrt::readImage() method, and available Image readers can
54  be found in nrt/ImageProc/IO/ImageSource/ImageReaders */
55  class ImageFilesSource : public SeekableImageSourceType, public Parameter<imagefilessource::path>
56  {
57  public:
58  //! Constructor
59  ImageFilesSource(std::string const & instanceName);
60 
61  //! Read the next image in the stream
62  GenericImage const in();
63 
64  //! Seek to the requested frame number
65  /*! \return Whether or not the seek was successful */
66  bool const seek(size_t const frameNumber);
67 
68  //! Return whether or not the next call to in() will return a valid GenericImage
69  bool const ok() const;
70 
71  //! Get the FrameRange of this source
72  FrameRange const frameRange() const;
73 
74  //! Get the current frame number
75  size_t const nextFrameNumber() const;
76 
77  //! Get the name associated with our --in type
78  static std::string const id() { return "images"; }
79 
80  //! Get a description to show for --help
81  static std::string const description() { return "Reads a sequence of images."; }
82 
83  private:
84  nrt::ParameterDef<std::string> createPathDef();
85 
86  void onParamChange(nrt::imagefilessource::path const & param, std::string const & filename);
87 
88  // implementation of pure virtual callback defined in base class:
89  void onParamChange(nrt::seekableimagesource::frames const & param, nrt::FrameRange const & range);
90 
91  std::map<size_t/*framenumber*/, std::string/*path*/> itsFrameFilenames;
92 
93  bool itsOk;
94 
95  size_t itsNextFrameNumber;
96  };
97 
98 } // nrt
99 
100 #endif // INCLUDE_NRT_IMAGEPROC_IO_IMAGESOURCE_IMAGEFILESSOURCE_H