RasterOutputSeries.H

Go to the documentation of this file.
00001 /*!@file Transport/RasterOutputSeries.H */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Rob Peters <rjpeters at usc dot edu>
00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Transport/RasterOutputSeries.H $
00035 // $Id: RasterOutputSeries.H 9547 2008-03-28 23:32:43Z rjpeters $
00036 //
00037 
00038 #ifndef TRANSPORT_RASTEROUTPUTSERIES_H_DEFINED
00039 #define TRANSPORT_RASTEROUTPUTSERIES_H_DEFINED
00040 
00041 #include "Component/ModelParam.H"
00042 #include "Raster/RasterFileFormat.H"
00043 #include "Transport/FrameOstream.H"
00044 
00045 //! FrameOstream subclass that writes raster files
00046 class RasterOutputSeries : public FrameOstream
00047 {
00048 public:
00049   //! Constructor
00050   RasterOutputSeries(OptionManager& mgr);
00051 
00052   //! Destructor
00053   virtual ~RasterOutputSeries();
00054 
00055   //! Override from FrameOstream; just calls setFileStem()
00056   virtual void setConfigInfo(const std::string& filestem);
00057 
00058   //! Set the current frame number and remember it
00059   virtual bool setFrameNumber(int n);
00060 
00061   //! Write a frame to disk
00062   virtual void writeFrame(const GenericFrame& frame,
00063                           const std::string& shortname,
00064                           const FrameInfo& auxinfo);
00065 
00066   //! No-op
00067   virtual void closeStream(const std::string& shortname);
00068 
00069   //! Specify the output filename stem
00070   void setFileStem(const std::string& s);
00071 
00072   //! Get the output raster file format for this series
00073   virtual RasterFileFormat getRasterFileFormat() const = 0;
00074 
00075 private:
00076   //! compute filename corresponding to args and return as string
00077   /*! Use sformat() to generate shortname if you need printf-style
00078       formatting. */
00079   std::string computeOutputFileName(const std::string& shortname) const;
00080 
00081   //! text log file name
00082   OModelParam<std::string> itsLogFile;
00083 
00084   //! output filename prefix
00085   std::string itsPrefix;
00086 
00087   int itsFrameNumber;
00088 
00089   int itsNumericFieldWidth;
00090 };
00091 
00092 //! Implements RasterOutputSeries using a command-line option to determine the output format
00093 class GenericRasterOutputSeries : public RasterOutputSeries
00094 {
00095 public:
00096   //! Constructor
00097   GenericRasterOutputSeries(OptionManager& mgr);
00098 
00099   //! Destructor
00100   virtual ~GenericRasterOutputSeries();
00101 
00102   //! Get the output raster file format for this series
00103   virtual RasterFileFormat getRasterFileFormat() const;
00104 
00105 private:
00106   //! output file format
00107   OModelParam<RasterFileFormat> itsRasterFileFormat;
00108 };
00109 
00110 
00111 //! Implements RasterOutputSeries with a fixed file type
00112 template <RasterFileFormat F>
00113 class FixedRasterOutputSeries : public RasterOutputSeries
00114 {
00115 public:
00116   //! Constructor
00117   FixedRasterOutputSeries(OptionManager& mgr);
00118 
00119   //! Destructor
00120   virtual ~FixedRasterOutputSeries();
00121 
00122   //! Get the output raster file format for this series
00123   virtual RasterFileFormat getRasterFileFormat() const;
00124 };
00125 
00126 // ######################################################################
00127 /* So things look consistent in everyone's emacs... */
00128 /* Local Variables: */
00129 /* indent-tabs-mode: nil */
00130 /* End: */
00131 
00132 #endif // TRANSPORT_RASTEROUTPUTSERIES_H_DEFINED
Generated on Sun May 8 08:42:24 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3