00001 /*!@file Raster/PnmWriter.H Write pbm/pgm/ppm image files */ 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/Raster/PnmWriter.H $ 00035 // $Id: PnmWriter.H 7807 2007-01-26 23:07:08Z rjpeters $ 00036 // 00037 00038 #ifndef RASTER_PNMWRITER_H_DEFINED 00039 #define RASTER_PNMWRITER_H_DEFINED 00040 00041 #include "Raster/RasterWriter.H" 00042 #include "Util/Types.H" 00043 00044 #include <iosfwd> 00045 00046 template <class T> class Image; 00047 template <class T> class PixRGB; 00048 00049 /// Write pbm/pgm/ppm image files 00050 class PnmWriter : public RasterWriter 00051 { 00052 public: 00053 PnmWriter(const bool forcepbm = false, const byte pbmthresh = 0); 00054 00055 virtual ~PnmWriter(); 00056 00057 virtual std::string writeFrame(const GenericFrame& image, 00058 const std::string& fname); 00059 00060 /// Write the RGB image in PPM (P6) format to the given ostream 00061 /** There is no checking done on the stream state; so, if you want 00062 to know whether the write succeded you need to explicitly check 00063 strm.fail(). */ 00064 static void writeRGB(const Image<PixRGB<byte> >& image, 00065 std::ostream& strm); 00066 00067 /// Write the grayscale image in PGM (P5) format to the given ostream 00068 /** There is no checking done on the stream state; so, if you want 00069 to know whether the write succeded you need to explicitly check 00070 strm.fail(). */ 00071 static void writeGray(const Image<byte>& image, 00072 std::ostream& strm); 00073 00074 /// Write the grayscale image in raw PBM (P4) format to the given ostream 00075 /** Pixels with values greater than or equal to thresh will be 00076 written as white, and other pixels will be written as black. */ 00077 static void writeRawBW(const Image<byte>& image, const byte thresh, 00078 std::ostream& strm); 00079 00080 /// Write the grayscale image in ascii PBM (P1) format to the given ostream 00081 /** Pixels with values greater than or equal to thresh will be 00082 written as white, and other pixels will be written as black. */ 00083 static void writeAsciiBW(const Image<byte>& image, const byte thresh, 00084 std::ostream& strm); 00085 00086 /// Write the RGB image in PPM (P6) format to the named file 00087 static void writeRGB(const Image<PixRGB<byte> >& image, 00088 const std::string& fname); 00089 00090 /// Write the grayscale image in PGM (P5) format to the named file 00091 static void writeGray(const Image<byte>& image, 00092 const std::string& fname); 00093 00094 /// Write the grayscale image in raw PBM (P4) format to the named file 00095 /** Pixels with values greater than or equal to thresh will be 00096 written as white, and other pixels will be written as black. */ 00097 static void writeRawBW(const Image<byte>& image, const byte thresh, 00098 const std::string& fname); 00099 00100 /// Write the grayscale image in ascii PBM (P1) format to the named file 00101 /** Pixels with values greater than or equal to thresh will be 00102 written as white, and other pixels will be written as black. */ 00103 static void writeAsciiBW(const Image<byte>& image, const byte thresh, 00104 const std::string& fname); 00105 00106 private: 00107 const bool itsForcePBM; 00108 const byte itsPBMThresh; 00109 }; 00110 00111 // ###################################################################### 00112 /* So things look consistent in everyone's emacs... */ 00113 /* Local Variables: */ 00114 /* mode: c++ */ 00115 /* indent-tabs-mode: nil */ 00116 /* End: */ 00117 00118 #endif // RASTER_PNMWRITER_H_DEFINED