ossimChipProcTool.h

Go to the documentation of this file.

//**************************************************************************************************
//
//     OSSIM Open Source Geospatial Data Processing Library
//     See top level LICENSE.txt file for license information
//
//**************************************************************************************************

#ifndef ossimChipProcUtil_HEADER
#define ossimChipProcUtil_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/base/ossimGrect.h>
#include <ossim/imaging/ossimImageSource.h>
#include <ossim/imaging/ossimSingleImageChain.h>
#include <ossim/imaging/ossimImageFileWriter.h>
#include <ossim/imaging/ossimRectangleCutFilter.h>
#include <ossim/projection/ossimMapProjection.h>
#include <ossim/projection/ossimImageViewAffineTransform.h>
#include <ossim/base/ossimProcessInterface.h>
#include <ossim/base/ossimListenerManager.h>
#include <ossim/util/ossimTool.h>
#include <map>
#include <vector>

/**************************************************************************************************
 * Base class for all utilities that process chips of image (or DEM) pixels.
 *
 * Many utilities share parameters in common, especially ROI (bounding box), input imagery,
 * color look-up tables, DEM file specification, etc. This class does the following:
 *   * Consolidates the parsing of common parameters,
 *   * Provides for creating input chains with needed handlers and resamplers. The derived classes
 *     would finish populating the processing chain(s) according to their requirements.
 *   * Inserts the chipper filter at the end of the processing chain
 *   * Appends the appropriate writer
 *   * Provides a functional, default implementation of execute() and getChip()
 *
 * @note Almost all methods use throw for stack unwinding.  This is not in
 * method declarations to alleviate build errors on windows.  Sorry...
 **************************************************************************************************/
class OSSIM_DLL ossimChipProcTool : public ossimTool,
                                    public ossimProcessInterface,
                                    public ossimListenerManager

{
public:
   ossimChipProcTool();

   virtual ~ossimChipProcTool();

   virtual void setUsage(ossimArgumentParser& ap);

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

   virtual void initialize(const ossimKeywordlist& kwl);

   virtual bool execute();

   virtual void abort();

   virtual bool isChipProcessor() const { return true; }

   virtual ossimListenerManager* getManager();
   virtual ossimObject* getObject();
   virtual const ossimObject* getObject() const;

   virtual ossimRefPtr<ossimImageData> getChip(const ossimIrect& img_rect);
   virtual ossimRefPtr<ossimImageData> getChip(const ossimGrect& gnd_rect);
   ossimRefPtr<ossimImageData> getChip(const ossimDrect& map_bounding_rect, const ossimDpt& gsd);

   ossimRefPtr<ossimImageData> getChip();

   const ossimFilename& getProductFilename() const { return m_productFilename; }

protected:
   void processRemainingArgs(ossimArgumentParser& ap);

   virtual void initProcessingChain() = 0;

   virtual void finalizeChain();

   virtual void loadImageFiles();
   
   virtual void loadDemFiles();

   ossimRefPtr<ossimSingleImageChain> createInputChain(const ossimFilename& image_file,
                                                       ossim_uint32 entry_index=0);

   void createOutputProjection();
   
   ossimRefPtr<ossimMapProjection>  newIdentityProjection();

   ossimRefPtr<ossimMapProjection> newUtmProjection();

   virtual void initializeProjectionGsd();

   virtual void initializeAOI();

   bool getProjectionOrigin(ossimGpt& gpt);

   ossimRefPtr<ossimImageFileWriter> newWriter();

   void propagateGeometryToChains();

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

   void computeAdjustedViewFromGrect();

   void setAoiToInputs();

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

   void setReaderProps( ossimImageHandler* ih ) const;
   
   ossimChipProcTool( const ossimChipProcTool& obj );

   const ossimChipProcTool& operator=( const ossimChipProcTool& /*rhs*/ ) { return *this; }

   ossimRefPtr<ossimGeoPolygon>  createClipPolygon()const;

   void findCenterGpt(ossimGpt& gpt);

   ossimRefPtr<ossimImageSource>  mosaicDemSources();

   ossimRefPtr<ossimImageGeometry> m_geom; //> Product chip/image geometry
   ossimIrect m_aoiViewRect;
   ossimGrect m_aoiGroundRect;
   std::vector< ossimRefPtr<ossimSingleImageChain> > m_imgLayers;
   std::vector< ossimFilename > m_demSources; //> Stores list of DEMs provided to the utility (versus pulled from the elevation database)
   mutable ossimRefPtr<ossimImageFileWriter> m_writer;
   ossimRefPtr<ossimImageChain> m_procChain;
   ossimRefPtr<ossimRectangleCutFilter> m_cutRectFilter;
   bool m_projIsIdentity;
   ossimDpt m_gsd; // meters
   bool m_geoScaled;
   ossimFilename m_productFilename;
   ossimScalarType m_productScalarType;
   bool m_needCutRect; // True when a specific AOI, different from the input, was requested
};

#endif /* #ifndef ossimChipProcUtil_HEADER */