ATP::AtpConfig Class Reference

Singleton class maintaining parameters affecting the automatic tie point generation. More...

#include <AtpConfig.h>

Inheritance diagram for ATP::AtpConfig:

Public Member Functions
virtual	~AtpConfig ()
	Destructor. More...
bool	readConfig (const std::string &configName="")
Public Member Functions inherited from ossim::JsonConfig
	JsonConfig ()
	Default Ctor loads all default .json files in the share/ossim system dir. More...
	JsonConfig (const ossimFilename &configFile)
virtual	~JsonConfig ()
	Destructor. More...
bool	open (const ossimFilename &configFile)
	Opens and parses JSON file. The "parameters" keyword is expected in the root node. More...
virtual void	loadJSON (const Json::Value &params_json_node)
	Reads the params controlling the process from the JSON node named "parameters". More...
virtual void	saveJSON (Json::Value &params_json_node) const
	Reads the params controlling the process from the JSON node named "parameters". More...
JsonParam &	getParameter (const char *paramName)
	Returns a parameter (might be a null parameter if paramName not found in the configuration. More...
void	setParameter (const JsonParam &p)
	Adds parameter to the configuration. More...
bool	diagnosticLevel (unsigned int level) const
	Convenience method returns TRUE if the currently set diagnostic level is <= level. More...
bool	paramExists (const char *paramName) const
Public Member Functions inherited from ossim::JsonInterface
	JsonInterface ()
virtual	~JsonInterface ()

Static Public Member Functions
static AtpConfig &	instance ()
	Singleton implementation. More...

Private Member Functions
	AtpConfig ()
	AtpConfig (const AtpConfig &)

Additional Inherited Members
Protected Member Functions inherited from ossim::JsonConfig
	JsonConfig (const JsonConfig &)
bool	getBoolValue (bool &rtn_val, const std::string &json_value) const
Protected Attributes inherited from ossim::JsonConfig
std::map< std::string, JsonParam >	m_paramsMap
Static Protected Attributes inherited from ossim::JsonConfig
static JsonParam	s_nullParam

Detailed Description

Singleton class maintaining parameters affecting the automatic tie point generation.

The state is imported and exported via JSON. There are default configuration files that must be part of the install, that are accessed by this class. Custom settings can also be st

Definition at line 24 of file AtpConfig.h.

Constructor & Destructor Documentation

~AtpConfig()

ATP::AtpConfig::~AtpConfig ( )

virtual

Destructor.

Definition at line 33 of file AtpConfig.cpp.

{
   m_paramsMap.clear();
}

AtpConfig() [1/2]

ATP::AtpConfig::AtpConfig ( )

private

Definition at line 26 of file AtpConfig.cpp.

{

   // Register the ISA-common parameters in the params map:
   readConfig();
}

AtpConfig() [2/2]

ATP::AtpConfig::AtpConfig ( const AtpConfig &  )

inlineprivate

Definition at line 37 of file AtpConfig.h.

{}

Member Function Documentation

instance()

AtpConfig & ATP::AtpConfig::instance ( )

static

Singleton implementation.

Definition at line 20 of file AtpConfig.cpp.

Referenced by ATP::AtpAnnotatedImage::annotateCorrelations(), ATP::AtpAnnotatedImage::annotateFeatures(), ATP::AtpAnnotatedImage::annotateResiduals(), ATP::AtpAnnotatedImage::AtpAnnotatedImage(), ATP::AtpGenerator::constructChain(), ATP::ossimCorrelationSource::correlate(), ATP::ossimAtpTool::doPairwiseMatching(), ATP::AtpTileSource::filterPoints(), ATP::AtpTileSource::filterWithoutParallax(), ATP::AtpTileSource::filterWithParallax(), ATP::ossimCorrelationSource::findFeatures(), ATP::AtpGenerator::generateTiePointList(), ATP::ossimAtpTool::getParameters(), ATP::ossimDescriptorSource::getTile(), ATP::ossimCorrelationSource::getTile(), ATP::ossimCorrelationSource::initialize(), ATP::AtpGenerator::initialize(), ATP::AtpTileSource::initializeStaticMembers(), ATP::AtpGenerator::layoutSearchTileRects(), ATP::ossimAtpTool::loadJSON(), ATP::ossimCorrelationSource::OpenCVCorrelation(), and ATP::AtpTileSource::pruneList().

{
   static AtpConfig singleton;
   return singleton;
}

readConfig()

bool ATP::AtpConfig::readConfig

(

const std::string &

configName = ""

)

Definition at line 38 of file AtpConfig.cpp.

References ossimString::clear(), CWARN, ossimString::empty(), ossimPreferences::instance(), ossimFilename::isDir(), ossimFilename::setPath(), and ossimException::what().

Referenced by ATP::ossimAtpTool::loadJSON(), and main().

{
   // This method could eventually curl a spring config server for the param JSON. For now it
   // is reading the installed share/ossim-isa system directory for config JSON files.

   // The previous parameters list is cleared first for a fresh start:
   m_paramsMap.clear();

   ossimFilename configFilename;
   Json::Value jsonRoot;
   try
   {
      // First establish the directory location of the default config files:
      ossimFilename shareDir = ossimPreferences::instance()->
         preferencesKWL().findKey( std::string( "ossim_share_directory" ) );
      shareDir += "/atp";
      if (!shareDir.isDir())
         throw ossimException("Nonexistent share drive provided for config files.");

      // Read the default common parameters first:
      configFilename = "atpConfig.json";
      configFilename.setPath(shareDir);
      if (!open(configFilename))
         throw ossimException("Bad file open or parse.");

      // Read the algorithm-specific default parameters if generic algo name specified as config:
      ossimString configName (cn);
      configFilename.clear();
      if (configName == "crosscorr")
         configFilename = "crossCorrConfig.json";
      else if (configName == "descriptor")
         configFilename = "descriptorConfig.json";
      else if (configName == "nasa")
         configFilename = "nasaConfig.json";
      else if (!configName.empty())
      {
         // Custom configuration. TODO: the path here is still the install's share directory.
         // Eventually want to provide a database access to the config JSON.
         configFilename = configName + ".json";
      }

      // Load the specified configuration. This will override the common defaults:
      if (!configFilename.empty())
      {
         configFilename.setPath(shareDir);
         if (!open(configFilename))
            throw ossimException("Bad file open or parse.");
      }
   }
   catch (ossimException& e)
   {
      CWARN<<"AtpConfig::readConfig():  Could not open/parse "
            "config file at <"<< configFilename << ">. Error: "<<e.what()<<endl;
      return false;
   }
   return true;
}

---

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

• AtpConfig.h
• AtpConfig.cpp