ossimWriter.h

Go to the documentation of this file.

//---
//
// License: MIT
// 
// Author:  David Burken
//
// Description: Generic image writer class.
// 
//---
// $Id$
#ifndef ossimWriter_HEADER
#define ossimWriter_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimIpt.h>
#include <ossim/imaging/ossimImageFileWriter.h>
#include <iosfwd>
#include <vector>

class ossimKeywordlist;
class ossimProperty;

class OSSIM_DLL ossimWriter : public ossimImageFileWriter
{
public:
   
   ossimWriter();

   virtual ~ossimWriter();

   virtual ossimString getShortName() const;

   virtual ossimString getLongName() const;

   virtual ossimString getClassName() const;

   virtual ossimString getExtension() const;
   
   virtual void getImageTypeList(std::vector<ossimString>& imageTypeList) const;

   virtual bool isOpen()const; 

   virtual bool open();

   virtual void close();
   
   bool hasImageType(const ossimString& imageType) const;

   virtual bool writeStream();

   virtual bool setOutputStream(std::ostream& str);

   virtual void setTileSize(const ossimIpt& tileSize);

   virtual const ossimIpt& getOutputTileSize() const;

   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;
   
   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);

   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name) const;

   virtual void getPropertyNames(std::vector<ossimString>& propertyNames) const;

 
   
protected:
   
   virtual bool writeFile();

private:
   
   bool writeStreamTtbs();

   bool writeTiffHdr();

   bool writeTiffTags( const std::vector<ossim_uint64>& tile_offsets,
                       const std::vector<ossim_uint64>& tile_byte_counts,
                       const std::vector<ossim_float64>& minBands,
                       const std::vector<ossim_float64>& maxBands );

   bool writeMinMaxTiffTags( std::streamoff& arrayWritePos  );


   bool writeSMinSMaxTiffTags( const std::vector<ossim_float64>& minBands,
                             const std::vector<ossim_float64>& maxBands,
                             std::streamoff& arrayWritePos  );

   template <class T> void writeTiffTag(ossim_uint16 tag, ossim_uint16 type,
                                        ossim_uint64 count,
                                        const T* value,
                                        std::streamoff& arrayWritePos );

   bool writeTiffTilesBandSeparate( std::vector<ossim_uint64>& tile_offsets,
                                    std::vector<ossim_uint64>& tile_byte_counts,
                                    std::vector<ossim_float64>& minBands,
                                    std::vector<ossim_float64>& maxBands );

   ossim_uint16 getTiffSampleFormat() const;

   bool isTiled() const;

   bool getAlignTilesFlag() const;

   ossim_int64 getBlockSize() const;

   bool getFlushTilesFlag() const;
  
   bool getWriteBlanksFlag() const;

   bool needsMinMax() const;
  
   std::ostream* m_str;
   bool          m_ownsStreamFlag;

   ossimRefPtr<ossimKeywordlist> m_kwl;
   
   ossimIpt      m_outputTileSize;
   
}; // End: class ossimWriter

#endif /* End of "#ifndef ossimWriter_HEADER" */