ossimShorelineTool Class Reference

#include <ossimShorelineTool.h>

Inheritance diagram for ossimShorelineTool:

Public Types
enum	AlgorithmId { UNKNOWN, NDWI, AWEI, PAN_THRESHOLD }
enum	ThresholdMode {   NONE =0, MEAN =1, SIGMA =2, VARIANCE =3,   VALUE =4 }
Public Types inherited from ossimProcessInterface
enum	ossimProcessStatus {   PROCESS_STATUS_UNKNOWN = 0, PROCESS_STATUS_EXECUTING = 1, PROCESS_STATUS_ABORTED = 2, PROCESS_STATUS_ABORT_REQUEST = 3,   PROCESS_STATUS_NOT_EXECUTING = 4 }

Public Member Functions
	ossimShorelineTool ()
	~ossimShorelineTool ()
virtual void	setUsage (ossimArgumentParser &ap)
	Initializes the aurgument parser with expected parameters and options. More...
virtual bool	initialize (ossimArgumentParser &ap)
	Initial method to be ran prior to execute. More...
virtual void	initialize (const ossimKeywordlist &kwl)
	This method is responsible for completely setting up the full processing chain according to the specifications given in the kwl passed in. More...
virtual ossimRefPtr< ossimImageData >	getChip (const ossimIrect &img_rect)
	The meat and potatos of this class. More...
virtual bool	execute ()
	Performs the actual product write. More...
virtual ossimString	getClassName () const
Public Member Functions inherited from ossimChipProcTool
	ossimChipProcTool ()
	default constructor More...
virtual	~ossimChipProcTool ()
	virtual destructor More...
virtual void	clear ()
	Disconnects and clears the dem and image layers. More...
virtual void	abort ()
virtual bool	isChipProcessor () const
	Overrides base class implementation to indicate this class supports getChip() calls. More...
virtual ossimListenerManager *	getManager ()
virtual ossimObject *	getObject ()
virtual const ossimObject *	getObject () const
virtual ossimRefPtr< ossimImageData >	getChip (const ossimGrect &gnd_rect)
ossimRefPtr< ossimImageData >	getChip (const ossimDrect &map_bounding_rect, const ossimDpt &gsd)
ossimRefPtr< ossimImageData >	getChip ()
	Get chip method that assumes pre-initialized state. More...
const ossimFilename &	getProductFilename () const
Public Member Functions inherited from ossimTool
	ossimTool ()
virtual	~ossimTool ()
virtual void	loadJSON (const Json::Value &json_request)
	Reads processing params from JSON object provided. More...
virtual void	saveJSON (Json::Value &json) const
	Fetch product as JSON object when applicable Always returns true since using exception on error. More...
virtual const std::string &	getResponse () const
	Fetch product as string (typically JSON) when applicable, otherwise passes back empty string. More...
virtual void	getKwlTemplate (ossimKeywordlist &kwl)
	Assigns a template keywordlist to string for initializing derived classes. More...
void	getAPI (std::string &out) const
	Outputs a JSON representation of the Utility's API. More...
std::string	getAPI () const
void	getBuildDate (std::string &s) const
	Gets build date. More...
void	getRevision (std::string &s) const
	Gets revision. More...
void	getVersion (std::string &s) const
	Gets version. More...
void	setOutputStream (std::ostream *os)
	Redirects any console output to the supplied stream for logging or JNI application. More...
bool	helpRequested () const
	Returns true when the initialization detects a "--help" option, so caller can avoid subsequent execute() call. More...
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const
Public Member Functions inherited from ossim::JsonInterface
	JsonInterface ()
virtual	~JsonInterface ()
Public Member Functions inherited from ossimProcessInterface
	ossimProcessInterface ()
virtual	~ossimProcessInterface ()
bool	needsAborting () const
bool	isAbortRequested () const
bool	isAborted () const
bool	isExecuting () const
ossimProcessStatus	getProcessStatus () const
virtual void	setProcessStatus (ossimProcessStatus processStatus)
virtual double	getPercentComplete () const
virtual void	setPercentComplete (double percentComplete)
void	enableEvents ()
void	disableEvents ()
void	setCurrentMessage (const ossimString &message)
virtual std::ostream &	print (std::ostream &out) const
Public Member Functions inherited from ossimListenerManager
	ossimListenerManager ()
virtual	~ossimListenerManager ()
virtual void	fireEvent (ossimEvent &event)
virtual bool	addListener (ossimListener *listener)
virtual bool	removeListener (ossimListener *listener)
virtual bool	findListener (ossimListener *listener)

Static Public Attributes
static const char *	DESCRIPTION
	Used by ossimUtilityFactory. More...

Protected Member Functions
virtual void	initProcessingChain ()
	Derived classes initialize their custom chains here. More...
void	initLandsat8 ()
	ossimShorelineTool (const ossimShorelineTool &obj)
	Hidden from use copy constructor. More...
const ossimShorelineTool &	operator= (const ossimShorelineTool &rhs)
	Hidden from use assignment operator. More...
void	usage (ossimArgumentParser &ap)
	Initializes arg parser and outputs usage. More...
void	addArguments (ossimArgumentParser &ap)
void	doThreshold ()
void	autoComputeThreshold ()
Protected Member Functions inherited from ossimChipProcTool
void	processRemainingArgs (ossimArgumentParser &ap)
	Intended to be called after derived class has picked off its own options from the parser, and arguments remain (such as input and output filenames). More...
virtual void	finalizeChain ()
	Called after initProcessingChain() to append common items to the processing chain. More...
virtual void	loadImageFiles ()
	Creates chains for image entries associated with specified keyword. More...
virtual void	loadDemFiles ()
	Loads all DEM files specified in master KWL into the elev manager's database. More...
ossimRefPtr< ossimSingleImageChain >	createInputChain (const ossimFilename &image_file, ossim_uint32 entry_index=0)
	Creates the ossimSingleImageChain from image filename and populates the chain with resampler and product output projection on view-side of resampler's IVT. More...
void	createOutputProjection ()
	Creates the output or view projection. More...
ossimRefPtr< ossimMapProjection >	newIdentityProjection ()
	Sets the single image chain for identity operations view to a ossimImageViewAffineTransform. More...
ossimRefPtr< ossimMapProjection >	newUtmProjection ()
	Convenience method to get a utm projection. More...
virtual void	initializeProjectionGsd ()
	Initializes the projection gsd. More...
virtual void	initializeAOI ()
	Initializes m_aoiViewRect with the output area of interest as specified in master KWL. More...
bool	getProjectionOrigin (ossimGpt &gpt)
	Reads the KWL for origin latitude and central meridian. More...
ossimRefPtr< ossimImageFileWriter >	newWriter ()
	Creates a new writer. More...
void	propagateGeometryToChains ()
	Loops through all chains and sets the output projection. More...
ossimRefPtr< ossimImageSource >	combineLayers (std::vector< ossimRefPtr< ossimSingleImageChain > > &layers) const
	When multiple input sources are present, this method instantiates a combiner and adds inputs. More...
void	computeAdjustedViewFromGrect ()
	Initializes m_aoiViewRect given m_aoiGroundRect. More...
void	setAoiToInputs ()
	Assigns the AOI to be the bounding rect of the union of all inputs. More...
void	getBandList (ossim_uint32 image_idx, std::vector< ossim_uint32 > &bandList) const
	Gets the band list if BANDS keyword is set. More...
void	setReaderProps (ossimImageHandler *ih) const
	Passes reader properties to single image handler if any. More...
	ossimChipProcTool (const ossimChipProcTool &obj)
	Hidden from use copy constructor. More...
const ossimChipProcTool &	operator= (const ossimChipProcTool &)
	Hidden from use assignment operator. More...
ossimRefPtr< ossimGeoPolygon >	createClipPolygon () const
void	findCenterGpt (ossimGpt &gpt)
	Tries to determine the AOI center point based on KWL entries, else returns NaNs in gpt. More...
ossimRefPtr< ossimImageSource >	mosaicDemSources ()
	Some utilities need to work on DEMs as images. More...
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
ossim_uint8	m_waterValue
ossim_uint8	m_marginalValue
ossim_uint8	m_landValue
ossimString	m_sensor
double	m_threshold
double	m_tolerance
AlgorithmId	m_algorithm
ThresholdMode	m_thresholdMode
double	m_smoothing
ossimFilename	m_vectorFilename
ossimFilename	m_indexFilename
ossimFilename	m_threshFilename
ossimFilename	m_maskFilename
std::map< ossimString, ossimString >	m_geoJsonProps
bool	m_noVector
Protected Attributes inherited from ossimChipProcTool
ossimRefPtr< ossimImageGeometry >	m_geom
ossimIrect	m_aoiViewRect
ossimGrect	m_aoiGroundRect
std::vector< ossimRefPtr< ossimSingleImageChain > >	m_imgLayers
std::vector< ossimFilename >	m_demSources
ossimRefPtr< ossimImageFileWriter >	m_writer
ossimRefPtr< ossimImageChain >	m_procChain
ossimRefPtr< ossimRectangleCutFilter >	m_cutRectFilter
bool	m_projIsIdentity
ossimDpt	m_gsd
bool	m_geoScaled
ossimFilename	m_productFilename
ossimScalarType	m_productScalarType
bool	m_needCutRect
Protected Attributes inherited from ossimTool
ossimKeywordlist	m_kwl
std::ostream *	m_consoleStream
bool	m_helpRequested
std::string	m_response
Protected Attributes inherited from ossimProcessInterface
double	thePercentComplete
ossimProcessStatus	theProcessStatus
ossimString	theMessage
bool	theEventFlag
Protected Attributes inherited from ossimListenerManager
std::list< ossimListener * >	theListenerList
bool	theEnabledFlag
std::list< ossimListener * >	theDelayedAdd
std::list< ossimListener * >	theDelayedRemove
bool	theFireEventFlag

Detailed Description

Class for finding helicopter landing zones (HLZ) on a DEM given the final destination and max range from destination.

Definition at line 36 of file ossimShorelineTool.h.

Member Enumeration Documentation

AlgorithmId

enum ossimShorelineTool::AlgorithmId

Enumerator
UNKNOWN
NDWI
AWEI
PAN_THRESHOLD

Definition at line 39 of file ossimShorelineTool.h.

{ UNKNOWN, NDWI, AWEI, PAN_THRESHOLD };

ThresholdMode

enum ossimShorelineTool::ThresholdMode

Enumerator
NONE
MEAN
SIGMA
VARIANCE
VALUE

Definition at line 40 of file ossimShorelineTool.h.

{ NONE=0, MEAN=1, SIGMA=2, VARIANCE=3, VALUE=4 };

Constructor & Destructor Documentation

ossimShorelineTool() [1/2]

ossimShorelineTool::ossimShorelineTool

(

)

Definition at line 49 of file ossimShorelineTool.cpp.

:    m_waterValue (0),
     m_marginalValue (128),
     m_landValue (255),
     m_sensor ("ls8"),
     m_threshold (-1.0), // Flags auto-thresholding
     m_tolerance(0.0),
     m_algorithm(NDWI),
     m_thresholdMode(SIGMA),
     m_smoothing(0),
     m_noVector(false)
{
}

~ossimShorelineTool()

ossimShorelineTool::~ossimShorelineTool

(

)

Definition at line 63 of file ossimShorelineTool.cpp.

{
}

ossimShorelineTool() [2/2]

ossimShorelineTool::ossimShorelineTool ( const ossimShorelineTool &  obj )

protected

Hidden from use copy constructor.

Member Function Documentation

addArguments()

void ossimShorelineTool::addArguments ( ossimArgumentParser &  ap )

protected

autoComputeThreshold()

void ossimShorelineTool::autoComputeThreshold ( )

protected

Definition at line 503 of file ossimShorelineTool.cpp.

References ossimKMeansClustering::computeKmeans(), ossimHistogram::GetCounts(), ossimImageChain::getFirstSource(), ossimMultiResLevelHistogram::getHistogram(), ossimImageHandler::getImageHistogram(), ossimKMeansClustering::getMean(), ossimHistogram::GetRes(), ossimKMeansClustering::getSigma(), ossimHistogram::GetVals(), ossimChipProcTool::m_procChain, m_threshold, m_thresholdMode, MEAN, ossimKMeansClustering::setNumClusters(), ossimKMeansClustering::setPopulations(), ossimKMeansClustering::setSamples(), SIGMA, ossimRefPtr< T >::valid(), and VARIANCE.

Referenced by doThreshold().

{
   // Use the K-means classifier to determine the threshold point based on the histogram clustering
   // into two groups: land and water.

   // If an input histogram was provided, use it. Otherwise compute one:
   ossimImageHandler* handler = dynamic_cast<ossimImageHandler*>(m_procChain->getFirstSource());
   ostringstream xmsg;
   if (!handler)
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  No input handler in procession chain.";
      throw ossimException(xmsg.str());
   }
   ossimRefPtr<ossimMultiResLevelHistogram> multi_histo = handler->getImageHistogram();
   if (!multi_histo.valid())
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Could not establish an index histogram.";
      throw ossimException(xmsg.str());
   }

   ossimRefPtr<ossimHistogram> band_histo = multi_histo->getHistogram(0);
   if (!band_histo.valid())
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Null band histogram returned!";
      throw ossimException(xmsg.str());
   }

   ossimRefPtr<ossimKMeansClustering> classifier = new ossimKMeansClustering;
   //classifier->setVerbose(); // TODO: Remove verbose mode
   classifier->setNumClusters(2);
   classifier->setSamples(band_histo->GetVals(), band_histo->GetRes());
   classifier->setPopulations(band_histo->GetCounts(), band_histo->GetRes());
   if (!classifier->computeKmeans())
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  K-means clustering of histogram failed. Cannot "
            "auto-compute threshold point.";
      throw ossimException(xmsg.str());
   }

   double mean0 = classifier->getMean(0);
   double mean1 = classifier->getMean(1);
   double sigma0 = classifier->getSigma(0);
   double sigma1 = classifier->getSigma(1);
   switch (m_thresholdMode)
   {
   case MEAN:
      m_threshold = (mean0 + mean1)/2.0;
      break;
   case SIGMA:
      m_threshold = (sigma1*mean0 + sigma0*mean1)/(sigma0 + sigma1);
      break;
   case VARIANCE:
      m_threshold = (sigma1*sigma1*mean0 + sigma0*sigma0*mean1)/(sigma0*sigma0 + sigma1*sigma1);
      break;
   default:
      break;
   }

   cout.precision(8);
   cout<<"ossimShorelineUtil::autoComputeThreshold(): Using threshold = "<<m_threshold<<endl;
}

doThreshold()

void ossimShorelineTool::doThreshold ( )

protected

Definition at line 430 of file ossimShorelineTool.cpp.

References ossimKeywordlist::add(), ossimImageChain::add(), autoComputeThreshold(), ossimString::chars(), ossimChipProcTool::execute(), FLT_EPSILON, ossimRefPtr< T >::get(), ossimImageHandlerRegistry::instance(), ossimBandLutFilter::loadState(), m_algorithm, m_indexFilename, m_landValue, m_marginalValue, ossimChipProcTool::m_procChain, ossimChipProcTool::m_productFilename, m_threshFilename, m_threshold, m_thresholdMode, m_tolerance, m_waterValue, ossimImageHandlerRegistry::open(), PAN_THRESHOLD, ossimString::toString(), ossimRefPtr< T >::valid(), and VALUE.

Referenced by execute().

{
   ostringstream xmsg;

   // Open the index file (unless doing pan thresholding) to use as the input:
   if (m_algorithm != PAN_THRESHOLD)
   {
      m_procChain = new ossimImageChain();
      ossimRefPtr<ossimImageHandler> indexImage =
            ossimImageHandlerRegistry::instance()->open(m_indexFilename);
      if (!indexImage.valid())
      {
         xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Error encountered reading index image at <"
               <<m_indexFilename<<">.";
         throw ossimException(xmsg.str());
      }
      m_procChain->add(indexImage.get());
   }

   // Some form of auto-thresholding was specified:
   if (m_thresholdMode != VALUE)
      autoComputeThreshold();

   // Set up threshold filter using a simple LUT remapper:
   double del = FLT_EPSILON;
   ossimString landValue = ossimString::toString(m_landValue).chars();
   ossimString waterValue = ossimString::toString(m_waterValue).chars();
   ossimString marginalValue = ossimString::toString(m_marginalValue).chars();
   ossimString thresholdValueLo1 = ossimString::toString(m_threshold-m_tolerance, 9).chars();
   ossimString thresholdValueLo2 = ossimString::toString(m_threshold-m_tolerance+del, 9).chars();
   ossimString thresholdValueHi1 = ossimString::toString(m_threshold+m_tolerance, 9).chars();
   ossimString thresholdValueHi2 = ossimString::toString(m_threshold+m_tolerance+del, 9).chars();
   ossimKeywordlist remapper_kwl;
   remapper_kwl.add("type", "ossimBandLutFilter");
   remapper_kwl.add("enabled", "1");
   remapper_kwl.add("mode", "interpolated");
   remapper_kwl.add("scalar_type", "U8");
   remapper_kwl.add("entry0.in", "0.0");
   remapper_kwl.add("entry0.out", landValue.chars());
   remapper_kwl.add("entry1.in", thresholdValueLo1.chars());
   remapper_kwl.add("entry1.out", landValue.chars());
   if (m_tolerance == 0)
   {
      remapper_kwl.add("entry2.in", thresholdValueLo2.chars());
      remapper_kwl.add("entry2.out", waterValue.chars());
      remapper_kwl.add("entry3.in", "1.0");
      remapper_kwl.add("entry3.out", waterValue.chars());
   }
   else
   {
      remapper_kwl.add("entry2.in", thresholdValueLo2.chars());
      remapper_kwl.add("entry2.out", marginalValue.chars());
      remapper_kwl.add("entry3.in", thresholdValueHi1.chars());
      remapper_kwl.add("entry3.out", marginalValue.chars());
      remapper_kwl.add("entry4.in", thresholdValueHi2.chars());
      remapper_kwl.add("entry4.out", waterValue.chars());
      remapper_kwl.add("entry5.in", "1.0");
      remapper_kwl.add("entry5.out", waterValue.chars());
   }

   ossimRefPtr<ossimBandLutFilter> remapper = new ossimBandLutFilter;
   remapper->loadState(remapper_kwl);
   m_procChain->add(remapper.get());

   m_productFilename = m_threshFilename;
   if (!ossimChipProcTool::execute())
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Error encountered creating threshold image at <"
            <<m_threshFilename<<">.";
      throw ossimException(xmsg.str());
   }
}

execute()

bool ossimShorelineTool::execute ( )

virtual

Performs the actual product write.

Note

Throws ossimException on error.

Reimplemented from ossimChipProcTool.

Definition at line 351 of file ossimShorelineTool.cpp.

References ossimKeywordlist::add(), ossimImageChain::add(), ossimString::chars(), ossimToolRegistry::createTool(), doThreshold(), ossimTool::execute(), ossimChipProcTool::execute(), ossimFilename::ext(), ossimRefPtr< T >::get(), ossimTool::initialize(), ossimImageChain::initialize(), ossimToolRegistry::instance(), m_algorithm, ossimTool::m_consoleStream, ossimTool::m_helpRequested, ossimChipProcTool::m_imgLayers, m_indexFilename, m_maskFilename, m_noVector, ossimChipProcTool::m_procChain, ossimChipProcTool::m_productFilename, m_smoothing, m_threshFilename, m_thresholdMode, m_vectorFilename, NONE, ossimNotify(), ossimNotifyLevel_INFO, ossimNotifyLevel_WARN, ossimKeywordNames::OUTPUT_FILE_KW, PAN_THRESHOLD, ossimFilename::setExtension(), ossimImageGaussianFilter::setGaussStd(), ossimTool::setOutputStream(), ossimErosionFilter::setWindowSize(), status, and ossimRefPtr< T >::valid().

{
   if (m_helpRequested)
      return true;

   bool status = true;

   // Base class handles the thresholded image generation. May throw exception. Output written to
   // m_productFilename. Note that if PAN mode selected, there is no intermediate index file:
   m_productFilename = m_indexFilename;
   if ((m_algorithm != PAN_THRESHOLD) && !ossimChipProcTool::execute())
      return false;

   if (m_thresholdMode != NONE)
      doThreshold();
   else
      return true;

   if (m_noVector)
      return status;

   // Now for vector product, need services of a plugin utility. Check if available:
   ossimRefPtr<ossimTool> potrace =
         ossimToolRegistry::instance()->createTool(string("potrace"));
   if (!potrace.valid())
   {
      ossimNotify(ossimNotifyLevel_WARN)<<"ossimShorelineUtil:"<<__LINE__<<"  Need the "
            "ossim-potrace plugin to perform vectorization. Only the thresholded image is "
            "available at <"<<m_productFilename<<">."<<endl;
      return false;
   }

   // Need a mask image representing an eroded version of the input image:
   m_procChain = new ossimImageChain;
   m_procChain->add(m_imgLayers[0].get());
   if (m_smoothing > 0)
   {
      // Set up gaussian filter:
      ossimRefPtr<ossimImageGaussianFilter> smoother = new ossimImageGaussianFilter;
      smoother->setGaussStd(m_smoothing);
      m_procChain->add(smoother.get());
   }
   ossimRefPtr<ossimErosionFilter> eroder = new ossimErosionFilter;
   eroder->setWindowSize(10);
   m_procChain->add(eroder.get());
   m_procChain->initialize();
   m_productFilename = m_maskFilename;
   status = ossimChipProcTool::execute(); // generates mask
   if (m_productFilename.ext() != "JSON")
      m_productFilename = m_vectorFilename.setExtension("json");

   // Convey possible redirection of console out:
   potrace->setOutputStream(m_consoleStream);

   ossimKeywordlist potrace_kwl;
   potrace_kwl.add("image_file0", m_threshFilename.chars());
   potrace_kwl.add("image_file1", m_maskFilename.chars());
   potrace_kwl.add(ossimKeywordNames::OUTPUT_FILE_KW, m_productFilename.chars());
   potrace_kwl.add("mode", "linestring");
   potrace_kwl.add("alphamax", "1.0");
   potrace_kwl.add("turdsize", "4");

   potrace->initialize(potrace_kwl);

   status =  potrace->execute();

#if OSSIM_HAS_JSONCPP
   if (status)
      status =  addPropsToJSON();
#endif

   if (status)
      ossimNotify(ossimNotifyLevel_INFO)<<"Wrote vector product to <"<<m_productFilename<<">"<<endl;
   else
      ossimNotify(ossimNotifyLevel_WARN)<<"Error encountered writing vector product to <"<<m_productFilename<<">"<<endl;

   return status;
}

getChip()

ossimRefPtr< ossimImageData > ossimShorelineTool::getChip ( const ossimIrect &  img_rect )

virtual

The meat and potatos of this class.

Performs an execute on specified rect.

Reimplemented from ossimChipProcTool.

Definition at line 334 of file ossimShorelineTool.cpp.

References ossimImageChain::getTile(), ossimImageGeometry::localToWorld(), ossimChipProcTool::m_aoiGroundRect, ossimChipProcTool::m_aoiViewRect, ossimChipProcTool::m_geom, ossimChipProcTool::m_procChain, ossimImageGeometry::setImageSize(), ossimIrect::size(), and ossimRefPtr< T >::valid().

{
   // NOTE:
   // getChip only performs the index and thresholding (and possibly edge). For vector output,
   // execute must be called.

   ostringstream xmsg;
   if (!m_geom.valid())
      return 0;

   m_aoiViewRect = bounding_irect;
   m_geom->setImageSize( m_aoiViewRect.size() );
   m_geom->localToWorld(m_aoiViewRect, m_aoiGroundRect);

   return m_procChain->getTile( m_aoiViewRect, 0 );
}

getClassName()

virtual ossimString ossimShorelineTool::getClassName ( ) const

inlinevirtual

Reimplemented from ossimTool.

Definition at line 51 of file ossimShorelineTool.h.

{ return "ossimShorelineUtil"; }

initialize() [1/2]

bool ossimShorelineTool::initialize ( ossimArgumentParser &  ap )

virtual

Initial method to be ran prior to execute.

Intended for command-line app usage.

Parameters

ap	Arg parser to initialize from.

Returns

FALSE if –help option requested or no params provided, so that derived classes can

Note

Throws ossimException on error.

A throw with an error message of "usage" is used to get out when a usage is printed.

Reimplemented from ossimChipProcTool.

Definition at line 113 of file ossimShorelineTool.cpp.

References ossimKeywordlist::addPair(), ossimChipProcTool::initialize(), ossimTool::m_helpRequested, ossimTool::m_kwl, and ossimArgumentParser::read().

{
   if (!ossimChipProcTool::initialize(ap))
      return false;
   if (m_helpRequested)
      return true;

   ossimString ts1;
   ossimArgumentParser::ossimParameter sp1(ts1);
   ossimString ts2;
   ossimArgumentParser::ossimParameter sp2(ts2);
   ossimString ts3;
   ossimArgumentParser::ossimParameter sp3(ts3);

   if ( ap.read("--algorithm", sp1))
      m_kwl.addPair(ALGORITHM_KW, ts1);

   if (ap.read("--color-coding", sp1, sp2, sp3))
   {
      ostringstream value;
      value<<ts1<<" "<<ts2<<" "<<ts3;
      m_kwl.addPair( COLOR_CODING_KW, value.str() );
   }

   if ( ap.read("--no-vector"))
      m_noVector = true;

   if ( ap.read("--sensor", sp1))
      m_kwl.addPair(ossimKeywordNames::SENSOR_ID_KW, ts1);

   if ( ap.read("--smooth", sp1))
      m_kwl.addPair(SMOOTHING_KW, ts1);

   if ( ap.read("--threshold", sp1))
      m_kwl.addPair(THRESHOLD_KW, ts1);

   if ( ap.read("--tmode", sp1))
      m_kwl.addPair(TMODE_KW, ts1);

   if ( ap.read("--tolerance", sp1))
      m_kwl.addPair(TOLERANCE_KW, ts1);

   // Added for "beachfront" to allow passing properties (keyword:value pairs) through to the
   // GeoJSON vector output
   while (ap.read("--prop", sp1))
   {
      m_geoJsonProps.insert(pair<ossimString, ossimString>(ts1.before(":"), ts1.after(":")));
   }

   // Fake the base class into thinking there is a default output filename to avoid it complaining,
   // since this utility will stream vector output to console if no output file name provided:
   m_kwl.add( ossimKeywordNames::OUTPUT_FILE_KW, DUMMY_OUTPUT_FILENAME.c_str());

   processRemainingArgs(ap);
   return true;
}

initialize() [2/2]

void ossimShorelineTool::initialize ( const ossimKeywordlist &  kwl )

virtual

This method is responsible for completely setting up the full processing chain according to the specifications given in the kwl passed in.

If the utility is run from a command line, the initialize(ossimArgumentParser) will assign the member master KWL and pass it to this method. Web service calls will fill a KWL and pass it.

This base class implementation should be called by the derived class implementation (assuming the derived class needs to pull some parameters out of the KWL before the chains are set up.

This method will instantiate the output projection and define the output bounding rect and product size in pixels. The processing chain (stored in m_procChain) will be completely initialized and ready for calls to getTile(). Then either getChip() or execute() can be called depending on usage to fetch product.

Note

Throws ossimException on error.

Reimplemented from ossimChipProcTool.

Definition at line 170 of file ossimShorelineTool.cpp.

References ossimKeywordlist::addList(), ossimKeywordlist::clear(), ossimKeywordlist::findKey(), and ossimTool::m_kwl.

{
   ossimString value;
   ostringstream xmsg;

   // Don't copy KWL if member KWL passed in:
   if (&kwl != &m_kwl)
   {
      // Start with clean options keyword list.
      m_kwl.clear();
      m_kwl.addList( kwl, true );
   }

   value = m_kwl.findKey(ALGORITHM_KW);
   if (!value.empty())
   {
      if (value=="ndwi")
         m_algorithm = NDWI;
      else if (value=="awei")
         m_algorithm = AWEI;
      else if (value=="pan-threshold")
         m_algorithm = PAN_THRESHOLD;
      else
      {
         xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Bad value encountered for keyword <"
               <<ALGORITHM_KW<<">.";
         throw ossimException(xmsg.str());
      }
   }

   value = m_kwl.findKey(COLOR_CODING_KW);
   if (!value.empty())
   {
      vector<ossimString> values = value.split(" ");
      if (values.size() == 3)
      {
         m_waterValue = values[0].toUInt8();
         m_marginalValue = values[1].toUInt8();
         m_landValue = values[2].toUInt8();
      }
      else
      {
         xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Unexpected number of values encountered for keyword <"
               <<COLOR_CODING_KW<<">.";
         throw ossimException(xmsg.str());
      }
   }

   value = m_kwl.find(ossimKeywordNames::SENSOR_ID_KW);
   if (!value.empty())
      m_sensor = value;

   value = m_kwl.findKey(SMOOTHING_KW);
   if (!value.empty())
      m_smoothing = value.toDouble();

   value = m_kwl.findKey(TMODE_KW);
   if (!value.empty())
   {
      int tmode = value.toInt();
      if ((tmode >= 0) && (tmode <= 4))
         m_thresholdMode = (ThresholdMode) tmode;
   }

   value = m_kwl.findKey(THRESHOLD_KW);
   if (!value.empty())
   {
      m_threshold = value.toDouble();
      m_thresholdMode = VALUE;
   }

   value = m_kwl.findKey(TOLERANCE_KW);
   if (!value.empty())
      m_tolerance = value.toDouble();

   // Output filename specifies the vector output, while base class interprets as raster, correct:
   m_vectorFilename = m_kwl.find(ossimKeywordNames::OUTPUT_FILE_KW);
   if (m_vectorFilename == DUMMY_OUTPUT_FILENAME)
   {
      m_vectorFilename = "";
      m_indexFilename = TEMP_INDEX_FILENAME;
      m_threshFilename = TEMP_THRESHOLD_FILENAME;
      m_maskFilename = TEMP_MASK_FILENAME;
   }
   else
   {
      m_indexFilename = m_vectorFilename.fileNoExtension() + "_index.tif";
      m_threshFilename = m_vectorFilename.fileNoExtension() + "_thresh.tif";
      m_maskFilename = m_vectorFilename.fileNoExtension() + "_mask.tif";
   }
   m_kwl.add(ossimKeywordNames::OUTPUT_FILE_KW, m_indexFilename.chars());

   // Unless an output projection was specifically requested, use the input:
   m_kwl.add(ossimKeywordNames::PROJECTION_KW, "identity", false);

   ossimChipProcTool::initialize(kwl);
}

initLandsat8()

void ossimShorelineTool::initLandsat8 ( )

protected

initProcessingChain()

void ossimShorelineTool::initProcessingChain ( )

protectedvirtual

Derived classes initialize their custom chains here.

Implements ossimChipProcTool.

Definition at line 268 of file ossimShorelineTool.cpp.

References ossimImageChain::add(), AWEI, ossimRefPtr< T >::get(), ossimGrect::hasNans(), ossimIrect::hasNans(), m_algorithm, ossimChipProcTool::m_aoiGroundRect, ossimChipProcTool::m_aoiViewRect, ossimChipProcTool::m_imgLayers, ossimChipProcTool::m_procChain, m_smoothing, NDWI, OSSIM_NORMALIZED_DOUBLE, PAN_THRESHOLD, ossimEquationCombiner::setEquation(), ossimImageGaussianFilter::setGaussStd(), and ossimEquationCombiner::setOutputScalarType().

{
   // The processing chain to produce the index image is assembled here. The thresholding part is
   // done during execute().
   ostringstream xmsg;

   if (m_aoiGroundRect.hasNans() || m_aoiViewRect.hasNans())
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Encountered NaNs in AOI."<<ends;
      throw ossimException(xmsg.str());
   }

   ossim_uint32 reqdNumInputs = 0;
   ossimString equationSpec;
   switch (m_algorithm)
   {
   case NDWI:
      reqdNumInputs = 2;
      equationSpec = "in[0]/(in[0]+in[1])";
      break;
   case AWEI:
      reqdNumInputs = 4;
      equationSpec = "4*(in[0]+in[1]) - 0.25*in[2] - 2.75*in[3]";
      break;
   case PAN_THRESHOLD:
      reqdNumInputs = 1;
      break;
   default:
      break;
   }

   if (m_imgLayers.size() < reqdNumInputs)
   {
      xmsg<<"ossimShorelineUtil:"<<__LINE__<<"  Expected "<< reqdNumInputs << " input images"
            " but only found "<<m_imgLayers.size()<<"."<<ends;
      throw ossimException(xmsg.str());
   }

   if ((m_algorithm==NDWI) || (m_algorithm==AWEI))
   {
      // Set up equation combiner:
      ossimConnectableObject::ConnectableObjectList connectable_list;
      for (ossim_uint32 i=0; i<reqdNumInputs; ++i)
         connectable_list.push_back(m_imgLayers[i].get());
      ossimRefPtr<ossimEquationCombiner> eqFilter = new ossimEquationCombiner(connectable_list);
      eqFilter->setOutputScalarType(OSSIM_NORMALIZED_DOUBLE);
      eqFilter->setEquation(equationSpec);
      m_procChain->add(eqFilter.get());
   }
   else
   {
      // Just add input connection for pan thresholding:
      m_procChain->add(m_imgLayers[0].get());
   }

   if (m_smoothing > 0)
   {
      // Set up gaussian filter:
      ossimRefPtr<ossimImageGaussianFilter> smoother = new ossimImageGaussianFilter;
      smoother->setGaussStd(m_smoothing);
      m_procChain->add(smoother.get());
   }

   return;
}

operator=()

const ossimShorelineTool& ossimShorelineTool::operator= ( const ossimShorelineTool &  rhs )

protected

Hidden from use assignment operator.

setUsage()

void ossimShorelineTool::setUsage ( ossimArgumentParser &  ap )

virtual

Initializes the aurgument parser with expected parameters and options.

It does not output anything. To see the usage, the caller will need to do something like:

ap.getApplicationUsage()->write(<ostream>);

This base class has some common arguments to add. The derived class should call this implementation in addition to setting its own arguments.

Reimplemented from ossimChipProcTool.

Definition at line 67 of file ossimShorelineTool.cpp.

References ossimApplicationUsage::addCommandLineOption(), ossimArgumentParser::getApplicationName(), ossimArgumentParser::getApplicationUsage(), ossimApplicationUsage::setCommandLineUsage(), ossimApplicationUsage::setDescription(), and ossimChipProcTool::setUsage().

{
   // Add global usage options.
   ossimChipProcTool::setUsage(ap);

   // Set the general usage:
   ossimApplicationUsage* au = ap.getApplicationUsage();
   ossimString usageString = ap.getApplicationName();
   usageString += " shoreline [options] [<output-vector-filename>]";
   au->setCommandLineUsage(usageString);
   au->setDescription("Computes vector shoreline from raster imagery. The vectors are output "
         "in GeoJSON format. If an output filename is specified, the JSON is written to it. "
         "Otherwise it is written to the console. The supported algorithms are (where A, B, etc are ordered input band files): \n"
         "   NDWI = (A - B) / (A + B) \n"
         "   AWEI = 4*(A + B) - 0.25*C - 2.75*D \n"
         "   PAN-THRESHOLD = A (no equation applied). The input single-band image is thresholded directly. \n");

   // Set the command line options:
   au->addCommandLineOption("--algorithm <name>",
         "Specifies detection algorithm to apply. Supported names are: "
         "\"ndwi\", \"aewi\", \"pan-threshold\"");
   au->addCommandLineOption("--color-coding <water> <marginal> <land>",
         "Specifies the pixel values (0-255) for the output product corresponding to water, marginal, "
         "and land zones. Defaults to 0, 128, and 255, respectively.");
   au->addCommandLineOption("--no-vector",
        "Outputs the raster, thresholded indexed image instead of a vector product. For engineering purposes.");
    au->addCommandLineOption("--sensor <string>",
           "Sensor used to compute Modified Normalized Difference Water Index. Currently only "
           "\"ls8\" supported (default).");
   au->addCommandLineOption("--smooth <sigma>",
         "Applies gaussian filter to index raster file. The filter sigma must be specified (0.2 is good). Sigma=0 "
         "indicates no smoothing.");
   au->addCommandLineOption("--threshold <0.0-1.0>",
         "Normalized threshold for converting the image to bitmap. Defaults to 0.55. If none specified, an optimized threshold"
         " is computed.");
   au->addCommandLineOption("--tmode <1|2|3>",
         "Mode to use for computing threshold from k-means statistics, where:\n"
         "   0 = no auto-thresholding,\n"
         "   1 = unweighted mean of means,\n"
         "   2 = sigma-weighted mean of means (default),\n"
         "   3 = variance-weighted mean of means."
         "If \"--threshold\" option is specified, this option is ignored.\n");
   au->addCommandLineOption("--tolerance <float>",
         "tolerance +- deviation from threshold for marginal classifications. Defaults to 0.01.");
}

usage()

void ossimShorelineTool::usage ( ossimArgumentParser &  ap )

protected

Initializes arg parser and outputs usage.

Member Data Documentation

DESCRIPTION

const char * ossimShorelineTool::DESCRIPTION

static

Initial value:

=
      "Computes bitmap of water versus land areas in an input image."

Used by ossimUtilityFactory.

Definition at line 54 of file ossimShorelineTool.h.

Referenced by ossimToolFactory::getCapabilities().

m_algorithm

AlgorithmId ossimShorelineTool::m_algorithm

protected

Definition at line 83 of file ossimShorelineTool.h.

Referenced by doThreshold(), execute(), and initProcessingChain().

m_geoJsonProps

std::map<ossimString, ossimString> ossimShorelineTool::m_geoJsonProps

protected

Definition at line 90 of file ossimShorelineTool.h.

m_indexFilename

ossimFilename ossimShorelineTool::m_indexFilename

protected

Definition at line 87 of file ossimShorelineTool.h.

Referenced by doThreshold(), and execute().

m_landValue

ossim_uint8 ossimShorelineTool::m_landValue

protected

Definition at line 79 of file ossimShorelineTool.h.

Referenced by doThreshold().

m_marginalValue

ossim_uint8 ossimShorelineTool::m_marginalValue

protected

Definition at line 78 of file ossimShorelineTool.h.

Referenced by doThreshold().

m_maskFilename

ossimFilename ossimShorelineTool::m_maskFilename

protected

Definition at line 89 of file ossimShorelineTool.h.

Referenced by execute().

m_noVector

bool ossimShorelineTool::m_noVector

protected

Definition at line 91 of file ossimShorelineTool.h.

Referenced by execute().

m_sensor

ossimString ossimShorelineTool::m_sensor

protected

Definition at line 80 of file ossimShorelineTool.h.

m_smoothing

double ossimShorelineTool::m_smoothing

protected

Definition at line 85 of file ossimShorelineTool.h.

Referenced by execute(), and initProcessingChain().

m_threshFilename

ossimFilename ossimShorelineTool::m_threshFilename

protected

Definition at line 88 of file ossimShorelineTool.h.

Referenced by doThreshold(), and execute().

m_threshold

double ossimShorelineTool::m_threshold

protected

Definition at line 81 of file ossimShorelineTool.h.

Referenced by autoComputeThreshold(), and doThreshold().

m_thresholdMode

ThresholdMode ossimShorelineTool::m_thresholdMode

protected

Definition at line 84 of file ossimShorelineTool.h.

Referenced by autoComputeThreshold(), doThreshold(), and execute().

m_tolerance

double ossimShorelineTool::m_tolerance

protected

Definition at line 82 of file ossimShorelineTool.h.

Referenced by doThreshold().

m_vectorFilename

ossimFilename ossimShorelineTool::m_vectorFilename

protected

Definition at line 86 of file ossimShorelineTool.h.

Referenced by execute().

m_waterValue

ossim_uint8 ossimShorelineTool::m_waterValue

protected

Definition at line 77 of file ossimShorelineTool.h.

Referenced by doThreshold().

---

The documentation for this class was generated from the following files:

• ossimShorelineTool.h
• ossimShorelineTool.cpp