ossimBandMergeTool.cpp

Go to the documentation of this file.

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

#include <ossim/init/ossimInit.h>
#include <ossim/base/ossimApplicationUsage.h>
#include <ossim/base/ossimApplicationUsage.h>
#include <ossim/base/ossimNotify.h>
#include <ossim/base/ossimKeywordNames.h>
#include <ossim/base/ossimException.h>
#include <ossim/imaging/ossimBandMergeSource.h>
#include <ossim/imaging/ossimHistogramRemapper.h>
#include <ossim/base/ossimMultiResLevelHistogram.h>
#include <ossim/base/ossimMultiBandHistogram.h>
#include <ossim/imaging/ossimImageHistogramSource.h>
#include <ossim/util/ossimBandMergeTool.h>
#include <iostream>

using namespace std;

const char* ossimBandMergeTool::DESCRIPTION  =
      "Merges multiple band files into a single RGB image.";

static const std::string HISTO_STRETCH_KW = "histo_stretch";

ossimBandMergeTool::ossimBandMergeTool()
:  m_stretchProduct(false)
{
}

ossimBandMergeTool::~ossimBandMergeTool()
{
}

void ossimBandMergeTool::setUsage(ossimArgumentParser& ap)
{
   // Add options.
   ossimApplicationUsage* au = ap.getApplicationUsage();
   ossimString usageString = ap.getApplicationName();
   usageString += " bandmerge --red <red_band> --green <green_band> --blue <blue_band> [--stretch] <output-rgb-image>";
   au->setCommandLineUsage(usageString);

   // Set the command line options:
   au->setDescription(DESCRIPTION);

   // Base class has its own:
   ossimChipProcTool::setUsage(ap);

   au->addCommandLineOption("--red", "<filename> Filename of red band. ");
   au->addCommandLineOption("--green", "<filename> Filename of green band. ");
   au->addCommandLineOption("--blue", "<filename> Filename of blue band. ");
   au->addCommandLineOption("--stretch", "Optionally histogram-stretch the product image. ");
}

bool ossimBandMergeTool::initialize(ossimArgumentParser& ap)
{
   if (!ossimChipProcTool::initialize(ap))
      return false;
   if (m_helpRequested)
      return true;

   ostringstream xmsg;

   std::string ts1;
   ossimArgumentParser::ossimParameter sp1 (ts1);
   int band_count = 0;

   if ( ap.read("--red", sp1))
   {
      ostringstream key;
      key<<ossimKeywordNames::IMAGE_FILE_KW<<"0";
      m_kwl.addPair( key.str(), ts1 );
      ++band_count;
   }
   if ( ap.read("--green", sp1))
   {
      ostringstream key;
      key<<ossimKeywordNames::IMAGE_FILE_KW<<"1";
      m_kwl.addPair( key.str(), ts1 );
      ++band_count;
   }
   if ( ap.read("--blue", sp1))
   {
      ostringstream key;
      key<<ossimKeywordNames::IMAGE_FILE_KW<<"2";
      m_kwl.addPair( key.str(), ts1 );
      ++band_count;
   }
   if (band_count != 3)
   {
      ossimNotify(ossimNotifyLevel_NOTICE)<<"ossimBandMergeUtil:"<<__LINE__
            <<" Must supply three band filenames."<<endl;
      return false;
   }

   if ( ap.read("--stretch"))
   {
      m_kwl.addPair(HISTO_STRETCH_KW, string("true") );
   }

   processRemainingArgs(ap);
   return true;
}

void ossimBandMergeTool::initialize(const ossimKeywordlist& kwl)
{
   kwl.getBoolKeywordValue(m_stretchProduct, HISTO_STRETCH_KW.c_str());

   m_kwl.add( ossimKeywordNames::PROJECTION_KW, "input", false );
   ossimChipProcTool::initialize(kwl);
}

void ossimBandMergeTool::initProcessingChain()
{
   if (m_imgLayers.size() != 3)
   {
      ostringstream errMsg;
      errMsg<<"ERROR ossimBandMergeUtil:"<<__LINE__<<"  Expected 3 input layers but found "
            <<m_imgLayers.size() <<". Cannot continue. "<<ends;
      throw ossimException(errMsg.str());
   }

   ossimConnectableObject::ConnectableObjectList bandList;
   for (int band=0; band<3; band++)
   {
      ossimSingleImageChain* band_image = m_imgLayers[band].get();
      bandList.push_back(band_image);

      // If performing histo stretch, try using existing histogram files before creating new ones:
      if (m_stretchProduct)
         initHistogramStretch(band_image);
   }
   ossimRefPtr<ossimBandMergeSource> combiner = new ossimBandMergeSource(bandList);
   m_procChain->add(combiner.get());
}

void ossimBandMergeTool::initHistogramStretch(ossimSingleImageChain* image)
{
   ostringstream errMsg;

   // Check if this image already has a histogram file associated with it:
   ossimRefPtr<ossimImageHandler> handler = image->getImageHandler();
   if (!handler.valid())
   {
      errMsg<<"ERROR ossimBandMergeUtil:"<<__LINE__<<"  Bad handler returned for image chain.";
      throw ossimException(errMsg.str());
   }

   ossimRefPtr<ossimMultiResLevelHistogram> histogram = handler->getImageHistogram();
   if (!histogram.valid())
   {
      errMsg<<"ERROR ossimBandMergeUtil:"<<__LINE__<<"  Bad histogram returned from image handler.";
      throw ossimException(errMsg.str());
   }

   ossimRefPtr<ossimHistogramRemapper> histogramRemapper = new ossimHistogramRemapper();
   histogramRemapper->setEnableFlag(true);
   histogramRemapper->setStretchMode( ossimHistogramRemapper::LINEAR_AUTO_MIN_MAX );
   histogramRemapper->setHistogram(histogram);
   image->add(histogramRemapper.get());
}

bool ossimBandMergeTool::execute()
{
   return ossimChipProcTool::execute();
}

void ossimBandMergeTool::getKwlTemplate(ossimKeywordlist& kwl)
{
   ossimChipProcTool::getKwlTemplate(kwl);

   ossimString keybase (ossimKeywordNames::IMAGE_FILE_KW );
   ossimString key = keybase + "0";
   kwl.add(key.chars(), "<red-band>", true);
   key = keybase + "1";
   kwl.add(key.chars(), "<green-band>", true);
   key = keybase + "2";
   kwl.add(key.chars(), "<blue-band>", true);

   kwl.add(HISTO_STRETCH_KW.c_str(), "true|false", true);
}