ossimChipperUtil.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// File: ossimChipperUtil.h
// 
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description:
// 
// Utility class to for chipping out images. Orthorectifying imagery with an
// added slant toward doing digital elevation model(DEM) operations.
// 
//----------------------------------------------------------------------------
// $Id: ossimChipperUtil.h 23423 2015-07-13 19:07:38Z dburken $

#ifndef ossimChipperUtil_HEADER
#define ossimChipperUtil_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimReferenced.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/imaging/ossimImageSource.h>
#include <ossim/imaging/ossimSingleImageChain.h>
#include <ossim/imaging/ossimImageFileWriter.h>
#include <ossim/projection/ossimMapProjection.h>

#include <map>
#include <vector>

// Forward class declarations:
class ossimAnnotationSource;
class ossimArgumentParser;
class ossimDpt;
class ossimFilename;
class ossimGeoPolygon;
class ossimGpt;
class ossimImageData;
class ossimImageFileWriter;
class ossimImageGeometry;
class ossimImageViewAffineTransform;
class ossimIrect;
class ossimKeywordlist;

class OSSIM_DLL ossimChipperUtil : public ossimReferenced
{
public:

   enum ossimChipperOperation
   {
      OSSIM_CHIPPER_OP_UNKNOWN      = 0,
      OSSIM_CHIPPER_OP_HILL_SHADE   = 1,
      OSSIM_CHIPPER_OP_COLOR_RELIEF = 2,
      OSSIM_CHIPPER_OP_ORTHO        = 3,
      OSSIM_CHIPPER_OP_2CMV         = 4, // two color multiview
      OSSIM_CHIPPER_OP_CHIP         = 5, // image space
      OSSIM_CHIPPER_OP_PSM          = 6  // pan sharpened multispectral
   };

   enum ossimChipperOutputProjection
   {
      OSSIM_CHIPPER_PROJ_UNKNOWN    = 0,
      OSSIM_CHIPPER_PROJ_GEO        = 1,
      OSSIM_CHIPPER_PROJ_GEO_SCALED = 2,
      OSSIM_CHIPPER_PROJ_INPUT      = 3,
      OSSIM_CHIPPER_PROJ_UTM        = 4
   };

   ossimChipperUtil();

   virtual ~ossimChipperUtil();

   void clear();
   
   bool initialize(ossimArgumentParser& ap);


   void initialize(const ossimKeywordlist& kwl);

   void execute();

   void abort();

//   ossimRefPtr<ossimImageData> getChip();

   ossimRefPtr<ossimImageData> getChip(const ossimKeywordlist& optionsKwl= ossimKeywordlist());

   void getOutputFilename(ossimFilename& f) const;

private:

   void initialize();

   ossimRefPtr<ossimImageSource> initializeChain( ossimIrect& aoi );

   void setOptionsToChain( ossimIrect& aoi, const ossimKeywordlist& kwl );

   ossimRefPtr<ossimImageSource> initializeColorReliefChain();

   ossimRefPtr<ossimImageSource> initializeBumpShadeChain();

   ossimRefPtr<ossimImageSource> initialize2CmvChain();

   ossimRefPtr<ossimImageSource> initializePsmChain();

   void initializeOutputProjection();
   
   void addDemSources();
   
   void addDemSource(const ossimFilename& file,
                     ossim_uint32 entryIndex);

   void addDemSource(const ossimSrcRecord& rec);

   void addImgSources();
   
   void addImgSource(const ossimFilename& file,
                     ossim_uint32 entryIndex);

   void addImgSource(const ossimSrcRecord& rec);

   ossimRefPtr<ossimSingleImageChain> createChain(const ossimFilename& file,
                                                  ossim_uint32 entryIndex,
                                                  bool isDemSource) const;

   ossimRefPtr<ossimSingleImageChain> createChain(const ossimSrcRecord& rec,
                                                  bool isDemSource) const;

   void createOutputProjection();
   
   void createIdentityProjection();

   ossimRefPtr<ossimMapProjection> getFirstInputProjection();

   ossimRefPtr<ossimMapProjection> getNewGeoProjection();

   ossimRefPtr<ossimMapProjection> getNewGeoScaledProjection();

   ossimRefPtr<ossimMapProjection> getNewProjectionFromSrsCode(
      const std::string& code );

   ossimRefPtr<ossimMapProjection> getNewUtmProjection();

   ossimRefPtr<ossimMapProjection> getMapProjection();

   void intiailizeProjectionTiePoint();

   void initializeProjectionGsd();   

   void initializeIvtScale();   

   void getTiePoint(ossimGpt& tie);

   void getTiePoint(ossimSingleImageChain* chain, ossimGpt& tie);

   void getTiePoint(ossimDpt& tie);

   void getTiePoint(ossimSingleImageChain* chain, ossimDpt& tie);

   void getMetersPerPixel(ossimDpt& gsd);

   void getMetersPerPixel(ossimSingleImageChain* chain, ossimDpt& gsd);

   ossim_float64 getCentralMeridian() const;

   ossim_float64 getOriginLatitude() const;

   void getSceneCenter(ossimGpt& gpt);

   void getSceneCenter(ossimSingleImageChain* chain, ossimGpt& gpt);

   ossimRefPtr<ossimImageFileWriter> createNewWriter() const;

   void propagateOutputProjectionToChains();

   ossimRefPtr<ossimImageSource> combineLayers(
      std::vector< ossimRefPtr<ossimSingleImageChain> >& layers) const;

   ossimRefPtr<ossimImageSource> combineLayers();

   ossimRefPtr<ossimImageSource> addIndexToRgbLutFilter(
      ossimRefPtr<ossimImageSource> &source) const;

   ossimRefPtr<ossimImageSource> addScalarRemapper(
      ossimRefPtr<ossimImageSource> &source,
      ossimScalarType scalar) const;

   ossimRefPtr<ossimImageSource> addAnnotations(
      ossimRefPtr<ossimImageSource> &source) const;

   void addCrossHairAnnotation(
      ossimRefPtr<ossimAnnotationSource> annotator,
      const std::string& prefix ) const;

   bool setupChainHistogram( ossimRefPtr<ossimSingleImageChain>& chain, 
                             std::shared_ptr<ossimSrcRecord> srcRecordPtr=0) const;

   bool setChainEntry( ossimRefPtr<ossimSingleImageChain>& chain,
                       ossim_uint32 entryIndex ) const;

   void getAreaOfInterest( ossimImageSource* source, ossimIrect& rect ) const;

   bool getIrect( const std::string& s, ossimIrect& rect ) const;

   bool getIrect( ossimRefPtr<ossimSingleImageChain>& chain,
                  const std::string& s, ossimIrect& rect ) const;
   
   bool getIrect( ossimRefPtr<ossimSingleImageChain>& chain,
                  ossimIrect& rect ) const;
   
   void initializeThumbnailProjection(const ossimIrect& originalRect,
                                      ossimIrect& adjustedRect);

   bool hasBandSelection() const;

   void getBandList( std::vector<ossim_uint32>& bandList ) const;

   bool hasAnnotations() const;

   bool hasLutFile() const;

   bool hasBrightnesContrastOperation() const;

   bool hasGeoPolyCutterOption()const;
   
   bool hasBumpShadeArg() const;

   bool hasThumbnailResolution() const;

   bool hasHistogramOperation() const;

   bool isDemFile(const ossimFilename& file) const;

   bool isSrcFile(const ossimFilename& file) const;

   void initializeSrcKwl();

   ossim_uint32 getNumberOfInputs() const;

   ossimChipperOutputProjection getOutputProjectionType() const;

   ossimScalarType getOutputScalarType() const;

   bool scaleToEightBit() const;

   bool snapTieToOrigin() const;

   void getImageSpaceScale(ossimDpt &imageSpaceScale) const;

   void getImageSpacePivot(ossimDpt &imageSpacePivot) const;

   ossim_float64 getRotation() const;

   bool hasRotation() const;

   bool upIsUp() const;

   bool northUp() const;

   bool isChipMode() const;

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

   ossim_uint32 getEntryNumber() const;

   ossim_int32 getZone() const;

   std::string getHemisphere() const;

   bool hasSensorModelInput();

   bool hasCutBoxWidthHeight() const;

   bool hasWmsBboxCutWidthHeight() const;

   bool hasScaleOption() const;
   
   bool isThreeBandOut() const;

   bool padThumbnail() const;

   void setReaderProps( ossimImageHandler* ih ) const;
   
   void addArguments(ossimArgumentParser& ap);

   void getClipPolygon(ossimGeoPolygon& polygon)const;
   ossim_float64 getBrightness() const;

   ossim_float64 getContrast() const;

   std::string getSharpenMode() const;

   int getHistoMode() const;

   void usage(ossimArgumentParser& ap);

   ossimChipperUtil( const ossimChipperUtil& obj );

   const ossimChipperUtil& operator=( const ossimChipperUtil& rhs );

   ossimRefPtr<ossimImageSource> createCombiner()const;

   ossimChipperOperation m_operation;
   
   ossimRefPtr<ossimKeywordlist> m_kwl;

   ossimRefPtr<ossimKeywordlist> m_srcKwl;

   ossimRefPtr<ossimImageGeometry> m_geom;

   ossimRefPtr<ossimImageViewAffineTransform> m_ivt;

   std::vector< ossimRefPtr<ossimSingleImageChain> > m_demLayer;

   std::vector< ossimRefPtr<ossimSingleImageChain> > m_imgLayer;
   
   mutable ossimRefPtr<ossimImageFileWriter> m_writer;

    ossimRefPtr<ossimImageSource> m_source;

};

#endif /* #ifndef ossimChipperUtil_HEADER */