iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImageFilesSink.H
Go to the documentation of this file.
1 /*! @file
2  @author Randolph Voorhies
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_IMAGESINK_IMAGEFILESSINK_H
37 #define INCLUDE_NRT_IMAGEPROC_IO_IMAGESINK_IMAGEFILESSINK_H
38 
41 
42 namespace nrt
43 {
44  namespace imagesink
45  {
46  NRT_DECLARE_PARAMETER_WITH_CALLBACK(prefix, std::string, "String to prepend to all image filenames written", "",
48 
49  NRT_DECLARE_PARAMETER(ext, std::string, "File extension", "", imagesink::ParamCateg);
50 
51  NRT_DECLARE_PARAMETER(framenumfieldwidth, size_t,
52  "Field width of the frame numbers appended to each filename. "
53  "For instance, the filename myimage001234.jpg has a framenumfieldwidth of 6. "
54  "Setting this parameter to 1 will result in a variable field width, e.g. myimage1234.jpg. "
55  "Setting this parameter to 0 will cause the first frame to have no numerical postfix, "
56  "e.g. just myimage.jpg. ",
58  }
59 
60  class ImageFilesSink : public ImageSinkType,
61  public nrt::Parameter<imagesink::prefix, imagesink::ext, imagesink::framenumfieldwidth>
62  {
63  public:
64  ImageFilesSink(std::string const& instanceID="images");
65 
66  void out(GenericImage img, std::string label="");
67 
68  //! Get the name associated with our --in type
69  static std::string const id() { return "images"; }
70 
71  //! Get a description to show for --help
72  static std::string const description() { return "Writes a sequence of images."; }
73 
74  private:
75  std::string itsPrefix;
76  void onParamChange(nrt::imagesink::prefix const & param, std::string const & pfx);
77  nrt::ParameterDef<std::string> createExtensionDef();
78  std::map<std::string/*filename*/, size_t/*framenumber*/> itsFrameNumbers;
79  };
80 }
81 
82 #endif // INCLUDE_NRT_IMAGEPROC_IO_IMAGESINK_IMAGEFILESSINK_H
83