ossimInfo.h

Go to the documentation of this file.

//---
// File: ossimInfo.h
// 
// License: MIT
//
// Author:  David Burken
//
// Description: ossimInfo class declaration
//
// See class doxygen descriptions below for more.
// 
//---
// $Id$

#ifndef ossimInfo_HEADER
#define ossimInfo_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/util/ossimTool.h>
#include <ostream>

class ossimGpt;

class OSSIM_DLL ossimInfo : public ossimTool
{
public:
   static const char* DESCRIPTION;

   ossimInfo();

   virtual ~ossimInfo();

   virtual void setUsage(ossimArgumentParser& ap);

   virtual bool initialize(ossimArgumentParser& ap);

   virtual bool execute();

   virtual ossimString getClassName() const { return "ossimInfo"; }

   ossim_uint32 executeImageOptions(const ossimFilename& file);

   void getImageInfo( const ossimFilename& file,
                      bool dumpFlag,
                      bool dnoFlag,
                      bool imageGeomFlag,
                      bool imageInfoFlag,
                      bool metaDataFlag,
                      bool paletteFlag,
                      ossimKeywordlist& kwl ) const;

   bool getImageInfo( const ossimFilename& file,
                      ossim_uint32 entry,
                      ossimKeywordlist& kwl ) const;
   
   void openImage(const ossimFilename& file);

   void openImageFromState(const ossimFilename& file);

   void closeImage();

   ossimRefPtr<ossimImageHandler> getImageHandler();

   void prettyPrint(const ossimFilename& file) const;

   void dumpImage(const ossimFilename& file,
                  bool dnoFlag,
                  ossimKeywordlist& kwl) const;

   void printFactories(bool keywordListFlag) const;

   void getImageMetadata(ossimKeywordlist& kwl) const;

   void getImagePalette(ossimKeywordlist& kwl);

   void getImageInfo(ossimKeywordlist& kwl, bool dnoFlag);

   bool getImageInfo(ossim_uint32 entry, ossimKeywordlist& kwl, bool dnoFlag);

   void getImageGeometryInfo(ossimKeywordlist& kwl, bool dnoFlag);

   bool getImageGeometryInfo( ossim_uint32 entry, 
                              ossimKeywordlist& kwl, 
                              bool dnoFlag );

   void getCenterImage(ossimKeywordlist& kwl);

   void getImageBounds(ossimKeywordlist& kwl);

   void getCenterGround(ossimKeywordlist& kwl);

   void getImg2grd(ossimKeywordlist& kwl);

   void getGrd2img(ossimKeywordlist& kwl);

   void getUpIsUpAngle(ossimKeywordlist& kwl);

   void getUpIsUpAngle(ossim_uint32 entry, ossimKeywordlist& kwl);

   void getImageToGround(ossimKeywordlist& kwl);

   void getImageToGround(ossim_uint32 entry, ossimKeywordlist& kwl);
   
   void getNorthUpAngle(ossimKeywordlist& kwl);

   void getNorthUpAngle(ossim_uint32 entry, ossimKeywordlist& kwl);
   
   void getImageRect(ossimKeywordlist& kwl);

   void getImageRect(ossim_uint32 entry, ossimKeywordlist& kwl);

   bool isImageEntryOverview() const;

   void printConfiguration() const;

   std::ostream& printConfiguration(std::ostream& out) const;

   void printDatums() const;

   std::ostream& printDatums(std::ostream& out) const;

   void printFonts() const;

   std::ostream& printFonts(std::ostream& out) const;

   void deg2rad(const ossim_float64& degrees) const;

   std::ostream& deg2rad(const ossim_float64& degrees, std::ostream& out) const;
   
   std::ostream& ecef2llh(const ossimEcefPoint& ecefPoint, std::ostream& out) const;

   void rad2deg(const ossim_float64& radians) const;

   std::ostream& rad2deg(const ossim_float64& radians, std::ostream& out) const;

   void ft2mtrs(const ossim_float64& feet, bool us_survey) const;

   std::ostream& ft2mtrs(const ossim_float64& feet, bool us_survey, std::ostream& out) const;

   void mtrs2ft(const ossim_float64& meters, bool us_survey) const;

   std::ostream& mtrs2ft(const ossim_float64& meters, bool us_survey, std::ostream& out) const;

   void mtrsPerDeg(const ossim_float64& latitude) const;

   std::ostream& mtrsPerDeg(const ossim_float64& latitude, std::ostream& out) const;

   void outputHeight(const ossimGpt& gpt) const;

   std::ostream& outputHeight(const ossimGpt& gpt, std::ostream& out) const;

   void printExtensions() const;

   std::ostream& printExtensions(std::ostream& out) const;

   void printPlugins() const;

   std::ostream& printPlugins(std::ostream& out) const;

   void testPlugin(const ossimFilename& plugin) const;

   std::ostream& testPlugin(const ossimFilename& plugin, std::ostream& out) const;

   void printOverviewTypes() const;

   std::ostream& printOverviewTypes(std::ostream& out) const;

   void printProjections() const;

   std::ostream& printProjections(std::ostream& out) const;

   void printReaderProps() const;

   std::ostream& printReaderProps(std::ostream& out) const;

   void printResamplerFilters() const;

   std::ostream& printResamplerFilters(std::ostream& out) const;

   void printWriters() const;

   std::ostream& printWriters(std::ostream& out) const;

   void printWriterProps() const;

   std::ostream& printWriterProps(std::ostream& out) const;

   void printZoomLevelGsds() const;

   std::ostream& printZoomLevelGsds(std::ostream& out) const;

   void getRadiometry(ossimScalarType scalar, std::string& s) const;

   void getBuildDate(std::string& s) const;

   void getRevisionNumber(std::string& s) const;

   void getVersion(std::string& s) const;

private:

   void getImageMetadata( const ossimImageHandler* ih, 
                          ossimKeywordlist& kwl ) const;
 
   void getImagePalette( ossimImageHandler* ih, 
                         ossimKeywordlist& kwl ) const;
  
   void getImageInfo( ossimImageHandler* ih, 
                      ossimKeywordlist& kwl, 
                      bool dnoFlag ) const;

   bool getImageInfo( ossimImageHandler* ih, 
                      ossim_uint32 entry, 
                      ossimKeywordlist& kwl, 
                      bool dnoFlag ) const;
   
   void getImageGeometryInfo( ossimImageHandler* ih,
                              ossimKeywordlist& kwl, 
                              bool dnoFlag ) const;

   bool getImageGeometryInfo( ossimImageHandler* ih,
                              ossim_uint32 entry, 
                              ossimKeywordlist& kwl, 
                              bool dnoFlag ) const;

   void getCenterImage( ossimImageHandler* ih,
                        ossimKeywordlist& kwl ) const;
   void getCenterImage( ossimImageHandler* ih,
                        ossim_uint32 entry, 
                        ossimKeywordlist& kwl ) const;

   void getImageBounds( ossimImageHandler* ih,
                        ossimKeywordlist& kwl ) const;
   void getImageBounds( ossimImageHandler* ih,
                        ossim_uint32 entry, 
                        ossimKeywordlist& kwl ) const;

   void getCenterGround( ossimImageHandler* ih,
                         ossimKeywordlist& kwl ) const;
   void getCenterGround( ossimImageHandler* ih,
                         ossim_uint32 entry, 
                         ossimKeywordlist& kwl ) const;

   void getImg2grd( ossimImageHandler* ih,
                    ossimKeywordlist& kwl ) const;
   void getImg2grd( ossimImageHandler* ih,
                    ossim_uint32 entry, 
                    ossimKeywordlist& kwl ) const;

   void getGrd2img( ossimImageHandler* ih,
                    ossimKeywordlist& kwl ) const;
   void getGrd2img( ossimImageHandler* ih,
                    ossim_uint32 entry, 
                    ossimKeywordlist& kwl ) const;
   
   void getUpIsUpAngle( ossimImageHandler* ih,
                        ossimKeywordlist& kwl ) const;

   void getUpIsUpAngle( ossimImageHandler* ih,
                        ossim_uint32 entry, 
                        ossimKeywordlist& kwl ) const;
   
   void getNorthUpAngle( ossimImageHandler* ih,
                         ossimKeywordlist& kwl ) const;

   void getNorthUpAngle( ossimImageHandler* ih,
                         ossim_uint32 entry, 
                         ossimKeywordlist& kwl ) const;

   void getImageRect( ossimImageHandler* ih,
                      ossimKeywordlist& kwl ) const;

   void getImageRect( ossimImageHandler* ih,
                      ossim_uint32 entry, 
                      ossimKeywordlist& kwl ) const;

   bool getRgbBands( ossimImageHandler* ih,
                     ossim_uint32 entry,
                     ossimKeywordlist& kwl ) const;

   bool isImageEntryOverview( const ossimImageHandler* ih ) const;

   void outputXml( const ossimKeywordlist& kwl ) const;
   
   void outputXml( const ossimKeywordlist& kwl, const ossimFilename& file ) const;
  
   ossimRefPtr<ossimImageHandler> openImageHandler(const ossimFilename& file) const;
   
   bool keyIsTrue( const std::string& key ) const;

   ossimRefPtr<ossimImageHandler> m_img;
};

#endif /* #ifndef ossimInfo_HEADER */