ossimVerticesFinderTool Class Reference

#include <ossimVerticesFinderTool.h>

Inheritance diagram for ossimVerticesFinderTool:

Public Member Functions
	ossimVerticesFinderTool ()
	~ossimVerticesFinderTool ()
virtual void	setUsage (ossimArgumentParser &ap)
	Initializes the aurgument parser with expected parameters and options. More...
virtual bool	initialize (ossimArgumentParser &ap)
	Initializes from command line arguments. More...
virtual void	initialize (const ossimKeywordlist &kwl)
	Reads processing params from KWL and prepares for execute. More...
virtual bool	execute ()
	Writes product to output file if applicable. More...
virtual ossimString	getClassName () const
virtual void	getKwlTemplate (ossimKeywordlist &kwl)
	Assigns a template keywordlist to string for initializing derived classes. More...
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	clear ()
	Disconnects and clears the DEM and image layers. More...
virtual void	abort ()
	Kills current (asynchronous) process. 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...
virtual bool	isChipProcessor () const
	Overrides base class implementation to indicate this class supports getChip() calls. 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 ()

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

Protected Attributes
ossimFilename	m_inputFile
ossimFilename	m_outputFile
ossim_uint32	m_entryIndex
Protected Attributes inherited from ossimTool
ossimKeywordlist	m_kwl
std::ostream *	m_consoleStream
bool	m_helpRequested
std::string	m_response

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Class for determining the active image corner vertices inside larger null-filled image rectangle.

Definition at line 18 of file ossimVerticesFinderTool.h.

Constructor & Destructor Documentation

ossimVerticesFinderTool()

ossimVerticesFinderTool::ossimVerticesFinderTool

(

)

Definition at line 27 of file ossimVerticesFinderTool.cpp.

:  m_entryIndex (0)
{
}

~ossimVerticesFinderTool()

ossimVerticesFinderTool::~ossimVerticesFinderTool

(

)

Definition at line 32 of file ossimVerticesFinderTool.cpp.

{
}

Member Function Documentation

execute()

bool ossimVerticesFinderTool::execute ( )

virtual

Writes product to output file if applicable.

The product may also beAlways returns true since using exception on error.

Note

Throws ossimException on error.

Implements ossimTool.

Definition at line 126 of file ossimVerticesFinderTool.cpp.

References ossimListenerManager::addListener(), ossimVertexExtractor::execute(), ossimRefPtr< T >::get(), ossimImageHandler::getBoundingRect(), ossimImageHandlerRegistry::instance(), m_entryIndex, ossimTool::m_helpRequested, m_inputFile, m_outputFile, ossimImageHandlerRegistry::open(), ossimVertexExtractor::setAreaOfInterest(), ossimImageHandler::setCurrentEntry(), ossimVertexExtractor::setOutputName(), and ossimRefPtr< T >::valid().

{
   if (m_helpRequested)
      return true;

   ostringstream errMsg;

   // Get an image handler for the input file.
   ossimRefPtr<ossimImageHandler> ih = ossimImageHandlerRegistry::instance()->open(m_inputFile);
   if (ih.valid())
   {
      ih->setCurrentEntry(m_entryIndex);
   }
   else
   {
      errMsg<<"ERROR ossimVerticesFinderUtil:"<<__LINE__<<"  Unsupported image file format for <"
            << m_inputFile<<">. Cannot open file.";
      throw ossimException(errMsg.str());
   }

   // Give the image handler to the vertex extractor as an input source.
   ossimRefPtr<ossimVertexExtractor> ve = new ossimVertexExtractor(ih.get());

   // Set the file name.
   ve->setOutputName(m_outputFile);

   // Set the area of interest to the full bounding rect of the source.
   ve->setAreaOfInterest(ih->getBoundingRect(0));

   // Add a listener for the percent complete to standard output.
   ossimStdOutProgress prog(0, true);
   ve->addListener(&prog);

   // Start the extraction...
   bool success = ve->execute();
   return success;
}

getClassName()

virtual ossimString ossimVerticesFinderTool::getClassName ( ) const

inlinevirtual

Reimplemented from ossimTool.

Definition at line 32 of file ossimVerticesFinderTool.h.

{ return "ossimVerticesFinderUtil"; }

getKwlTemplate()

void ossimVerticesFinderTool::getKwlTemplate ( ossimKeywordlist &  kwl )

virtual

Assigns a template keywordlist to string for initializing derived classes.

Reimplemented from ossimTool.

Definition at line 165 of file ossimVerticesFinderTool.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::ENTRY_KW, ossimKeywordNames::IMAGE_FILE_KW, and ossimKeywordNames::OUTPUT_FILE_KW.

{
   kwl.add(ossimKeywordNames::ENTRY_KW, "<sub-image entry index>");
   kwl.add(ossimKeywordNames::IMAGE_FILE_KW, "<input-raster-file>");
   kwl.add(ossimKeywordNames::OUTPUT_FILE_KW, "<output-vertices-file>");
}

initialize() [1/2]

bool ossimVerticesFinderTool::initialize ( ossimArgumentParser &  ap )

virtual

Initializes from command line arguments.

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

Parameters

ap	Represents command line.

Returns

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

Note

Throws ossimException on error.

Reimplemented from ossimTool.

Definition at line 55 of file ossimVerticesFinderTool.cpp.

References ossimKeywordlist::add(), ossimKeywordlist::addPair(), ossimArgumentParser::argc(), ossimKeywordNames::ENTRY_KW, ossimKeywordNames::IMAGE_FILE_KW, ossimTool::initialize(), ossimTool::m_helpRequested, ossimTool::m_kwl, ossimNotify(), ossimNotifyLevel_NOTICE, ossimKeywordNames::OUTPUT_FILE_KW, ossimArgumentParser::read(), and ossimArgumentParser::remove().

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

   std::string tempString1;
   ossimArgumentParser::ossimParameter stringParam1(tempString1);

   if ( ap.read("-e", stringParam1) || ap.read("--entry", stringParam1) )
      m_kwl.addPair( std::string(ossimKeywordNames::ENTRY_KW), tempString1 );

   cout<<ap.argc()<<endl;//TODO:REMOVE

   if ( ap.argc() > 1 )
   {
      m_kwl.add( ossimKeywordNames::IMAGE_FILE_KW, ap[1]);
      ap.remove(1);
   }
   if ( ap.argc() > 1 )
   {
      m_kwl.add( ossimKeywordNames::OUTPUT_FILE_KW, ap[1]);
      ap.remove(1);
   }
   if ( ap.argc() > 1 )
   {
      ossimNotify(ossimNotifyLevel_NOTICE)<<"ossimVerticesFinderUtil:"<<__LINE__<<" Too many "
            "arguments provided on command line. Ignoring superfluous entries.";
   }

   initialize(m_kwl);
   return true;
}

initialize() [2/2]

void ossimVerticesFinderTool::initialize ( const ossimKeywordlist &  kwl )

virtual

Reads processing params from KWL and prepares for execute.

Returns TRUE if successful.

Parameters

kwl	Full keyword-list representing state

Note

Throws ossimException on error.

Reimplemented from ossimTool.

Definition at line 90 of file ossimVerticesFinderTool.cpp.

References ossimKeywordlist::addList(), ossimKeywordlist::clear(), ossimFilename::dirCat(), ossimString::empty(), ossimKeywordNames::ENTRY_KW, ossimFilename::fileNoExtension(), ossimKeywordlist::find(), ossimKeywordNames::IMAGE_FILE_KW, ossimFilename::isReadable(), m_entryIndex, m_inputFile, ossimTool::m_kwl, m_outputFile, ossimKeywordNames::OUTPUT_FILE_KW, ossimFilename::path(), and ossimString::toUInt32().

{
   ostringstream errMsg;

   // 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 );
   }

   m_inputFile  = m_kwl.find( ossimKeywordNames::IMAGE_FILE_KW);

   m_outputFile = m_kwl.find( ossimKeywordNames::OUTPUT_FILE_KW);

   ossimString value = m_kwl.find( ossimKeywordNames::ENTRY_KW);
   if (!value.empty())
      m_entryIndex = value.toUInt32();

   // See if an LUT is requested:
   if (m_inputFile.empty() || !m_inputFile.isReadable())
   {
      errMsg<<"ERROR ossimVerticesFinderUtil:"<<__LINE__<<"  Input filename was not provided or "
            " file <"<<m_inputFile <<"> is not readable. "<<ends;
      throw ossimException(errMsg.str());
   }

   if (m_outputFile.empty())
   {
      m_outputFile = m_inputFile.path();
      m_outputFile = m_outputFile.dirCat(m_inputFile.fileNoExtension());
      m_outputFile += "_vertices.kwl";
   }
}

setUsage()

void ossimVerticesFinderTool::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 ossimTool.

Definition at line 36 of file ossimVerticesFinderTool.cpp.

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

{
   // Add options.
   ossimApplicationUsage* au = ap.getApplicationUsage();
   ossimString usageString = ap.getApplicationName();
   usageString += " vertices [options] <input-image> [<output-vertices.kwl>]";
   au->setCommandLineUsage(usageString);

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

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

   au->addCommandLineOption("-e or --entry",
                            "<entry> For multi image handlers which entry do you wish to extract. "
                            "For list of entries use: \"ossim-info -i <your_image>\" ");
}

Member Data Documentation

DESCRIPTION

const char * ossimVerticesFinderTool::DESCRIPTION

static

Initial value:

=
      "Utility for determining the active image corner vertices inside larger null-filled image "
      "rectangle."

Used by ossimUtilityFactory.

Definition at line 37 of file ossimVerticesFinderTool.h.

Referenced by ossimToolFactory::getCapabilities(), and setUsage().

m_entryIndex

ossim_uint32 ossimVerticesFinderTool::m_entryIndex

protected

Definition at line 42 of file ossimVerticesFinderTool.h.

Referenced by execute(), and initialize().

m_inputFile

ossimFilename ossimVerticesFinderTool::m_inputFile

protected

Definition at line 40 of file ossimVerticesFinderTool.h.

Referenced by execute(), and initialize().

m_outputFile

ossimFilename ossimVerticesFinderTool::m_outputFile

protected

Definition at line 41 of file ossimVerticesFinderTool.h.

Referenced by execute(), and initialize().

---

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

• ossimVerticesFinderTool.h
• ossimVerticesFinderTool.cpp