ossimImageUtil.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
// File: ossimImageUtil.h
// 
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description: ossimImageUtil
//
// See class descriptions below for more.
// 
//----------------------------------------------------------------------------
// $Id$

#ifndef ossimImageUtil_HEADER
#define ossimImageUtil_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimFileProcessorInterface.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/imaging/ossimOverviewBuilderBase.h>
#include <ostream>
#include <vector>
#include <mutex>

class ossimArgumentParser;
class ossimFileWalker;
class ossimGpt;
class ossimPropertyInterface;
class ossimApplicationUsage;
class ossimImageHandler;
class OSSIM_DLL ossimImageUtil :
   public ossimReferenced, public ossimFileProcessorInterface
{
public:

   ossimImageUtil();

   virtual ~ossimImageUtil();

   void addOptions(ossimApplicationUsage* au);
   void addArguments(ossimArgumentParser& ap);

   bool initialize(ossimArgumentParser& ap);

   ossim_int32 execute();

   virtual void processFile(const ossimFilename& file);

   void setCreateOverviewsFlag(bool flag);

   bool createOverviews() const;

   void setCreateThumbnailsFlag(bool flag);

   void setThumbnailType(const std::string& value);

   void setThumbnailStretchType(const std::string& value);

   bool createThumbnails() const;

   void setRebuildOverviewsFlag( bool flag );

   bool rebuildOverviews() const;

   void setRebuildHistogramFlag( bool flag );

   bool rebuildHistogram() const;

   void setOverviewType( const std::string& type );
   
   void setOverviewStopDimension( ossim_uint32 dimension );
   void setOverviewStopDimension( const std::string& dimension );

   void setTileSize( ossim_uint32 tileSize );

   bool getTileSize( ossimIpt& tileSize ) const;

   ossim_uint32 getOverviewStopDimension() const;

   void setCreateHistogramFlag( bool flag );
   
   bool createHistogram() const;

   void setCreateHistogramFastFlag( bool flag );

   bool createHistogramFast() const;

   void setCreateHistogramR0Flag( bool flag );

   bool createHistogramR0() const;

   bool hasHistogramOption() const;

   ossimHistogramMode getHistogramMode() const;

   void setScanForMinMax( bool flag );
   
   bool scanForMinMax() const;

   void setScanForMinMaxNull( bool flag );

   bool scanForMinMaxNull() const;

   void setCompressionQuality( const std::string& quality );

   void setCompressionType( const std::string& type );

   void setCopyAllFlag( bool flag );

   bool getCopyAllFlag() const;

   void setDumpFilteredImageListFlag( bool flag );

   bool getDumpFilterImagesFlag() const;

   void setInternalOverviewsFlag( bool flag );

   bool getInternalOverviewsFlag() const;
   
   void setOutputDirectory( const std::string& directory );
 
   void setOutputFileNamesFlag( bool flag );

   bool getOutputFileNamesFlag() const;

   void setOverrideFilteredImagesFlag( bool flag );

   bool getOverrideFilteredImagesFlag() const;
   
   void setNumberOfThreads( ossim_uint32 threads );
   void setNumberOfThreads( const std::string& threads );

   const std::vector<std::string>& getFilteredImages() const;

   std::vector<std::string>& getFilteredImages();

private:

   bool keyIsTrue( const std::string& key ) const;

   bool isFiltered(const ossimFilename& f) const;
   
   void initializeDefaultFilterList();

   void dumpFilteredImageList() const;

   void createOverview(ossimRefPtr<ossimImageHandler>& ih,
                       bool& consumedHistogramOptions,
                       bool& consumedCmmOptions);

   void createOverview(ossimRefPtr<ossimImageHandler>& ih,
                       ossimRefPtr<ossimOverviewBuilderBase>& ob,
                       ossim_uint32 entry,
                       bool useEntryIndex,
                       bool& consumedHistogramOptions);

   void createThumbnail(ossimRefPtr<ossimImageHandler> &ih);

   bool hasRequiredOverview( ossimRefPtr<ossimImageHandler>& ih,
                             ossimRefPtr<ossimOverviewBuilderBase>& ob );

   bool hasCmmOption() const;

   void createHistogram(ossimRefPtr<ossimImageHandler>& ih);

   void createHistogram(ossimRefPtr<ossimImageHandler>& ih,
                       ossim_uint32 entry,
                       bool useEntryIndex);

   void computeMinMax(ossimRefPtr<ossimImageHandler>& ih);

   void computeMinMax(ossimRefPtr<ossimImageHandler>& ih,
                      ossim_uint32 entry,
                      bool useEntryIndex);
   
   void usage(ossimArgumentParser& ap);

   void outputOverviewWriterTypes() const;

   bool isDirectoryBasedImage(const ossimImageHandler* ih) const;

   void getOverviewType(std::string& type) const;

   void setProps(ossimPropertyInterface* pi) const;
   
   ossim_uint32 getNumberOfThreads() const;

   ossim_uint32 getNextWriterPropIndex() const;

   ossim_uint32 getNextReaderPropIndex() const;

   ossim_uint32 getThumbnailSize() const;

   int getThumbnailStretchType()const;
   std::string getThumbnailType()const;
   std::string getThumbnailFilename(ossimImageHandler *ih) const;
   void addOption(const std::string &key, ossim_uint32 value);
   void addOption( const std::string& key, const std::string& value );

   void setErrorStatus( ossim_int32 status );

   void executePrepCommands() const;

   void executeFileCommands( const ossimFilename& file ) const;

   void executePostCommands() const;

   void executeCommands( const std::string& prefix,
                         const ossimFilename& file ) const;

   void substituteCommandString( const ossimFilename& file,
                                 const std::string& prefix,
                                 const std::string& commandKey,
                                 ossimString& command ) const;

   void substituteFileStrings( const ossimFilename& file,
                               ossimString& command ) const;

   void gsubDate( const std::string& commandPrefix,
                  ossimString& command ) const;
   
   ossimRefPtr<ossimKeywordlist> m_kwl;

   ossimFileWalker*   m_fileWalker;
   std::mutex m_mutex;

   ossim_int32 m_errorStatus;

   std::vector<std::string> m_filteredImages; 
};

#endif /* #ifndef ossimImageUtil_HEADER */