ATP::ossimAtpTool Class Reference

#include <ossimAtpTool.h>

Inheritance diagram for ATP::ossimAtpTool:

Public Types
enum	Method { METHOD_UNASSIGNED =0, GET_ALGO_LIST, GET_PARAMS, GENERATE }

Public Member Functions
	ossimAtpTool ()
virtual	~ossimAtpTool ()
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 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...
virtual void	loadJSON (const Json::Value &json)
	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...
Public Member Functions inherited from ossimTool
	ossimTool ()
virtual	~ossimTool ()
virtual void	initialize (const ossimKeywordlist &kwl)
	Reads processing params from KWL and prepares for execute. 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

Private Member Functions
void	getAlgorithms ()
void	getParameters ()
void	generate ()
void	doPairwiseMatching ()
	When the ATP generator works with image pairs (crosscorr and descriptor), This method is used to loop over all image pairs and assemble the final tiepoint list for all. More...

Private Attributes
std::ostream *	m_outputStream
bool	m_verbose
bool	m_featureBased
unsigned int	m_algorithm
Method	m_method
std::string	m_configuration
Json::Value	m_responseJSON
std::shared_ptr< ossim::PhotoBlock >	m_photoBlock

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Attributes inherited from ossimTool
ossimKeywordlist	m_kwl
std::ostream *	m_consoleStream
bool	m_helpRequested
std::string	m_response

Detailed Description

Definition at line 20 of file ossimAtpTool.h.

Member Enumeration Documentation

Method

enum ATP::ossimAtpTool::Method

Enumerator
METHOD_UNASSIGNED
GET_ALGO_LIST
GET_PARAMS
GENERATE

Definition at line 23 of file ossimAtpTool.h.

{ METHOD_UNASSIGNED=0, GET_ALGO_LIST, GET_PARAMS, GENERATE };

Constructor & Destructor Documentation

ossimAtpTool()

ATP::ossimAtpTool::ossimAtpTool

(

)

Definition at line 25 of file ossimAtpTool.cpp.

: m_outputStream (0),
  m_verbose (false),
  m_featureBased (true),
  m_algorithm (0),
  m_method (METHOD_UNASSIGNED)
{
}

~ossimAtpTool()

ATP::ossimAtpTool::~ossimAtpTool ( )

virtual

Definition at line 34 of file ossimAtpTool.cpp.

{
}

Member Function Documentation

doPairwiseMatching()

void ATP::ossimAtpTool::doPairwiseMatching ( )

private

When the ATP generator works with image pairs (crosscorr and descriptor), This method is used to loop over all image pairs and assemble the final tiepoint list for all.

Definition at line 291 of file ossimAtpTool.cpp.

References ossim::JsonParam::asBool(), CINFO, ossim::JsonConfig::getParameter(), ATP::AtpConfig::instance(), m_algorithm, m_photoBlock, and m_responseJSON.

Referenced by generate().

{
   static const char* MODULE = "ossimAtpTool::doPairwiseMatching()  ";
   ostringstream xmsg;
   xmsg<<MODULE;

   if (!m_photoBlock || (m_photoBlock->getImageList().size() < 2))
   {
      xmsg << "No photoblock has been declared or it has less than two images. Cannot perform ATP.";
      throw ossimException(xmsg.str());
   }

   shared_ptr<AtpGenerator> generator;

   // First obtain list of images from photoblock:
   std::vector<shared_ptr<Image> >& imageList = m_photoBlock->getImageList();
   int numImages = (int) imageList.size();
   for (int i=0; i<(numImages-1); i++)
   {
      shared_ptr<Image> imageA = imageList[i];
      for (int j=i+1; j<numImages; j++)
      {
         shared_ptr<Image> imageB = imageList[j];

         // Instantiate the ATP generator for this pair:
         generator.reset(new AtpGenerator((AtpGenerator::Algorithm) m_algorithm));

         // Generate tie points using A for features:
         generator->setRefImage(imageA);
         generator->setCmpImage(imageB);
         TiePointList tpList;
         generator->generateTiePointList(tpList);
         m_photoBlock->addTiePoints(tpList);

         if (AtpConfig::instance().diagnosticLevel(2))
            CINFO<<"Completed pairwise match for pair "<<i<<"-"<<j<<endl;

         // Now reverse CMP and REF to find possible additional features on B:
         bool doTwoWaySearch = AtpConfig::instance().getParameter("doTwoWaySearch").asBool();
         if (doTwoWaySearch)
         {
            generator->setRefImage(imageB);
            generator->setCmpImage(imageA);
            tpList.clear();
            generator->generateTiePointList(tpList);
            m_photoBlock->addTiePoints(tpList);

            if (AtpConfig::instance().diagnosticLevel(2))
               CINFO<<"Completed pairwise match for pair "<<j<<"-"<<i<<endl;
         }
      }
   }

   // Save list to photoblock JSON:
   Json::Value pbJson;
   m_photoBlock->saveJSON(pbJson);
   m_responseJSON["photoblock"] = pbJson;

   if (AtpConfig::instance().diagnosticLevel(1))
      CINFO<<"\n"<<MODULE<<"Total TPs found = "<<m_photoBlock->getTiePointList().size()<<endl;
}

execute()

bool ATP::ossimAtpTool::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 192 of file ossimAtpTool.cpp.

References CFATAL, GENERATE, generate(), GET_ALGO_LIST, GET_PARAMS, getAlgorithms(), getParameters(), m_method, m_outputStream, m_responseJSON, and ossimException::what().

{
   ostringstream xmsg;

   try
   {
      switch (m_method)
      {
      case GET_ALGO_LIST:
         getAlgorithms();
         break;
      case GET_PARAMS:
         getParameters();
         break;
      case GENERATE:
         generate();
         break;
      default:
         xmsg << "Fatal: No method selected prior to execute being called. I don't know what to do!";
         throw ossimException(xmsg.str());
      }

      // Serialize JSON object for return:
      if (m_outputStream)
         (*m_outputStream) << m_responseJSON;
   }
   catch(ossimException &e)
   {
      CFATAL<<"Exception: "<<e.what()<<endl;
      if (m_outputStream)
         *m_outputStream<<"{ \"ERROR\": \"" << e.what() << "\" }\n"<<endl;
   }

   // close any open file streams:
   ofstream* so = dynamic_cast<ofstream*>(m_outputStream);
   if (so)
   {
      so->close();
      delete so;
   }

   return true;
}

generate()

void ATP::ossimAtpTool::generate ( )

private

Definition at line 269 of file ossimAtpTool.cpp.

References ATP::AtpGenerator::ALGO_UNASSIGNED, ATP::AtpGenerator::CROSSCORR, ATP::AtpGenerator::DESCRIPTOR, doPairwiseMatching(), m_algorithm, and ATP::AtpGenerator::NASA.

Referenced by execute().

{
   ostringstream xmsg;
   xmsg<<"ossimAtpTool::generate()  ";

   switch (m_algorithm)
   {
   case (unsigned int) AtpGenerator::CROSSCORR:
   case (unsigned int) AtpGenerator::DESCRIPTOR:
      doPairwiseMatching();
      break;
   case (unsigned int) AtpGenerator::NASA:
      xmsg << "NASA Algorithm not yet implemented!";
      throw ossimException(xmsg.str());
      break;
   case (unsigned int) AtpGenerator::ALGO_UNASSIGNED:
   default:
      xmsg << "Fatal: No algorithm selected prior to execute being called. I don't know what to do!";
      throw ossimException(xmsg.str());
   }
}

getAlgorithms()

void ATP::ossimAtpTool::getAlgorithms ( )

private

Definition at line 240 of file ossimAtpTool.cpp.

References m_responseJSON.

Referenced by execute().

{
   m_responseJSON.clear();

   Json::Value algoList;
   algoList[0]["name"]        = "crosscorr";
   algoList[0]["description"] = "Matching by cross-correlation of raster patches";
   algoList[0]["label"]       = "Cross Correlation";
   algoList[1]["name"]        = "descriptor";
   algoList[1]["description"] = "Matching by feature descriptors";
   algoList[1]["label"]       = "Descriptor";
   //algoList[2]["name"]        = "nasa";
   //algoList[2]["description"] = "Tiepoint extraction using NASA tool.";
   //algoList[2]["label"]       = "NASA";

   m_responseJSON["algorithms"] = algoList;
}

getClassName()

virtual ossimString ATP::ossimAtpTool::getClassName ( ) const

inlinevirtual

Reimplemented from ossimTool.

Definition at line 37 of file ossimAtpTool.h.

{ return "ossimAtpTool"; }

getKwlTemplate()

void ATP::ossimAtpTool::getKwlTemplate ( ossimKeywordlist &  kwl )

virtual

Assigns a template keywordlist to string for initializing derived classes.

Reimplemented from ossimTool.

Definition at line 236 of file ossimAtpTool.cpp.

{
}

getParameters()

void ATP::ossimAtpTool::getParameters ( )

private

Definition at line 258 of file ossimAtpTool.cpp.

References ATP::AtpConfig::instance(), m_responseJSON, and ossim::JsonConfig::saveJSON().

Referenced by execute().

{
   m_responseJSON.clear();

   Json::Value params;
   AtpConfig::instance().saveJSON(params);

   m_responseJSON["parameters"] = params;

}

initialize()

bool ATP::ossimAtpTool::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 65 of file ossimAtpTool.cpp.

References CFATAL, GENERATE, GET_ALGO_LIST, GET_PARAMS, ossimTool::initialize(), loadJSON(), ossimTool::m_helpRequested, m_method, m_outputStream, m_verbose, and ossimArgumentParser::read().

{
   string ts1;
   ossimArgumentParser::ossimParameter sp1(ts1);
   m_method = GENERATE;

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

   if ( ap.read("-v"))
      m_verbose = true;

   if ( ap.read("--algorithms"))
      m_method = GET_ALGO_LIST;

   if ( ap.read("--parameters"))
      m_method = GET_PARAMS;

   if ( ap.read("-i", sp1))
   {
      ifstream s (ts1);
      if (s.fail())
      {
         CFATAL<<__FILE__<<" Could not open input file <"<<ts1<<">";
         return false;
      }
      try
      {
         Json::Value queryJson;
         s >> queryJson;
         loadJSON(queryJson);
      }
      catch (exception& e)
      {
         CFATAL<<__FILE__<<" Could not parse input JSON <"<<ts1<<">";
         return false;
      }
   }

   if ( ap.read("-o", sp1))
   {
      ofstream* s = new ofstream (ts1);
      if (s->fail())
      {
         CFATAL<<__FILE__<<" Could not open output file <"<<ts1<<">";
         return false;
      }
      m_outputStream = s;
   }
   else
      m_outputStream = &clog;

   return true;
}

loadJSON()

void ATP::ossimAtpTool::loadJSON ( const Json::Value &  json_request )

virtual

Reads processing params from JSON object provided.

If all good, the object is ready for subsequent call to execute().

Note

Throws ossimException on error.

Reimplemented from ossimTool.

Definition at line 122 of file ossimAtpTool.cpp.

References ATP::AtpGenerator::ALGO_UNASSIGNED, ossim::JsonParam::asString(), CINFO, ATP::AtpGenerator::CROSSCORR, ATP::AtpGenerator::DESCRIPTOR, ossim::JsonConfig::diagnosticLevel(), GENERATE, GET_ALGO_LIST, GET_PARAMS, ossim::JsonConfig::getParameter(), ATP::AtpConfig::instance(), ossim::JsonConfig::loadJSON(), m_algorithm, m_configuration, m_method, m_photoBlock, ATP::AtpGenerator::NASA, and ATP::AtpConfig::readConfig().

Referenced by initialize().

{
   ostringstream xmsg;
   xmsg<<"ossimAtpTool::loadJSON()  ";

   // Fetch the desired method from the JSON if provided, otherwise rely on command line options:
   m_method = GENERATE;
   string method = queryRoot["method"].asString();
   if (method == "getAlgorithms")
      m_method = GET_ALGO_LIST;
   else if (method == "getParameters")
      m_method = GET_PARAMS;

   // Fetch the desired algorithm or configuration:
   AtpConfig& config = AtpConfig::instance();
   string algorithm = queryRoot["algorithm"].asString();
   if (algorithm.empty())
   {
      // An optional field specifies a configuration that contains the base-name of a custom
      // parameters JSON file including algorithm type. Read that if specified:
      m_configuration = queryRoot["configuration"].asString();
      if (!m_configuration.empty())
      {
         if (!config.readConfig(m_configuration))
         {
            xmsg << "Fatal error trying to read default ATP configuration for selected "
                  "configuration <"<<m_configuration<<">";
            throw ossimException(xmsg.str());
         }
         algorithm = config.getParameter("algorithm").asString();
      }
   }
   // Otherwise read the algorithm's default config params from the system:
   else if (!config.readConfig(algorithm))
   {
      xmsg << "Fatal error trying to read default ATP configuration for selected algorithm <"
            <<algorithm<<">";
      throw ossimException(xmsg.str());
   }

   // Assign enum data member used throughout the service:
   if (algorithm == "crosscorr")
      m_algorithm = (unsigned int) AtpGenerator::CROSSCORR;
   else if (algorithm == "descriptor")
      m_algorithm = (unsigned int) AtpGenerator::DESCRIPTOR;
   else if (algorithm == "nasa")
      m_algorithm = (unsigned int) AtpGenerator::NASA;
   else
      m_algorithm = (unsigned int) AtpGenerator::ALGO_UNASSIGNED;

   // If parameters were provided in the JSON payload, have the config override the defaults:
   const Json::Value& parameters = queryRoot["parameters"];
   if (!parameters.isNull())
      config.loadJSON(parameters);

   if (config.diagnosticLevel(2))
      CINFO<<"\nATP configuration after loading:\n"<<config<<endl;

   if (m_method == GENERATE)
   {
      // Load the active photoblock from JSON.
      // The root JSON object can optionally contain a photoblock with image list contained. If so,
      // use that object to load images, otherwise use the root.
      if (queryRoot.isMember("photoblock"))
         m_photoBlock.reset(new PhotoBlock(queryRoot["photoblock"]));
      else
         m_photoBlock.reset(new PhotoBlock(queryRoot));
   }
}

saveJSON()

virtual void ATP::ossimAtpTool::saveJSON ( Json::Value &  json ) const

inlinevirtual

Fetch product as JSON object when applicable Always returns true since using exception on error.

Parameters

json	Returns non-empty object if valid response available.

Reimplemented from ossimTool.

Definition at line 43 of file ossimAtpTool.h.

{ json = m_responseJSON; }

setUsage()

void ATP::ossimAtpTool::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 38 of file ossimAtpTool.cpp.

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

{
   // Add global usage options. Don't include ossimChipProcUtil options as not appropriate.
   ossimTool::setUsage(ap);

   // Set the general usage:
   ossimApplicationUsage* au = ap.getApplicationUsage();
   ossimString usageString = ap.getApplicationName();
   usageString += " atp [options] \n\n";
   usageString +=
         "Accesses automatic tiepoint generation functionality given JSON request on stdin (or input file if\n"
         "-i specified). The response JSON is output to stdout unless -o option is specified.\n";
   au->setCommandLineUsage(usageString);

   // Set the command line options:
   au->addCommandLineOption("--algorithms",
         "List available auto-tie-point algorithms");
   au->addCommandLineOption("-i <filename>",
         "Reads request JSON from the input file specified instead of stdin.");
   au->addCommandLineOption("-o <filename>",
         "Outputs response JSON to the output file instead of stdout.");
   au->addCommandLineOption("--parameters",
         "List all ATP parameters with default values.");
   au->addCommandLineOption("-v",
         "Verbose. All non-response (debug) output to stdout is enabled.");
}

Member Data Documentation

DESCRIPTION

const char * ATP::ossimAtpTool::DESCRIPTION

static

Initial value:

=
      "Provides automatic tiepoint generation functionality. This tool uses JSON format to "
      "communicate requests and results."

Definition at line 25 of file ossimAtpTool.h.

m_algorithm

unsigned int ATP::ossimAtpTool::m_algorithm

private

Definition at line 58 of file ossimAtpTool.h.

Referenced by doPairwiseMatching(), generate(), and loadJSON().

m_configuration

std::string ATP::ossimAtpTool::m_configuration

private

Definition at line 60 of file ossimAtpTool.h.

Referenced by loadJSON().

m_featureBased

bool ATP::ossimAtpTool::m_featureBased

private

Definition at line 57 of file ossimAtpTool.h.

m_method

Method ATP::ossimAtpTool::m_method

private

Definition at line 59 of file ossimAtpTool.h.

Referenced by execute(), initialize(), and loadJSON().

m_outputStream

std::ostream* ATP::ossimAtpTool::m_outputStream

private

Definition at line 55 of file ossimAtpTool.h.

Referenced by execute(), and initialize().

m_photoBlock

std::shared_ptr<ossim::PhotoBlock> ATP::ossimAtpTool::m_photoBlock

private

Definition at line 62 of file ossimAtpTool.h.

Referenced by doPairwiseMatching(), and loadJSON().

m_responseJSON

Json::Value ATP::ossimAtpTool::m_responseJSON

private

Definition at line 61 of file ossimAtpTool.h.

Referenced by doPairwiseMatching(), execute(), getAlgorithms(), and getParameters().

m_verbose

bool ATP::ossimAtpTool::m_verbose

private

Definition at line 56 of file ossimAtpTool.h.

Referenced by initialize().

---

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

• ossimAtpTool.h
• ossimAtpTool.cpp