ossimEquationUtil Class Reference

#include <ossimEquationUtil.h>

Inheritance diagram for ossimEquationUtil:

Public Member Functions
	ossimEquationUtil (ossimArgumentParser &ap)
	~ossimEquationUtil ()
virtual bool	execute ()
	Returns true if successful. More...
virtual ossimObject *	getObject ()
virtual const ossimObject *	getObject () const
virtual ossimListenerManager *	getManager ()
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 ossimString	getClassName () 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 ossimProcessInterface
	ossimProcessInterface ()
virtual	~ossimProcessInterface ()
virtual void	abort ()
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)

Protected Member Functions
	ossimEquationUtil ()
void	addArguments (ossimArgumentParser &ap)
void	outputTemplateKeywordlist (const ossimFilename &templateFilename)
bool	parseKwl (const ossimFilename &kwl_file, std::vector< ossimFilename > &inputs, ossimString &equationSpec, ossimFilename &output, ossimString &writerType)
bool	initInputSources (std::vector< ossimFilename > &fileList)
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()
Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
ossimArgumentParser *	m_argumentParser
ossimApplicationUsage	m_usage
ossimConnectableObject::ConnectableObjectList	m_inputSources
ossimRefPtr< ossimImageGeometry >	m_prodGeometry
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

Additional Inherited Members
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 }

Detailed Description

Definition at line 23 of file ossimEquationUtil.h.

Constructor & Destructor Documentation

ossimEquationUtil() [1/2]

ossimEquationUtil::ossimEquationUtil

(

ossimArgumentParser &

ap

)

Definition at line 156 of file ossimEquationUtil.cpp.

References ossimApplicationUsage::addCommandLineOption(), ossimArgumentParser::getApplicationName(), m_usage, ossimApplicationUsage::setApplicationName(), ossimApplicationUsage::setCommandLineUsage(), and ossimApplicationUsage::setDescription().

:  m_argumentParser(new ossimArgumentParser(ap))
{
   m_usage.setApplicationName(ap.getApplicationName());
   m_usage.setDescription(ap.getApplicationName() +
                        " Takes a list of images and performs the specified equation. The inputs"
                        "must be in the same projection as the operations are done at the pixel"
                        "level with no renderer in th chain. The output file will contain the same"
                        "geospatial header info as the first image in the input list.");
   m_usage.setCommandLineUsage(ap.getApplicationName()+
                              " \"<equation spec>\" <input_file1> <input_file2> <input_file...> <output_file>");
   m_usage.addCommandLineOption("-h or --help","Display this information");
   m_usage.addCommandLineOption("-k <filename>", "keyword list to load from");
   m_usage.addCommandLineOption("-w <type>", "Writer type (tiff_strip, jpeg, etc... see ossim-info --writers) (default=tiff_strip)");
   m_usage.addCommandLineOption("--writer-prop <string>", "Adds a property to send to the writer. format is name=value");
   m_usage.addCommandLineOption("-t <filename>", "output a keyword list template");
}

~ossimEquationUtil()

ossimEquationUtil::~ossimEquationUtil ( )

inline

Definition at line 29 of file ossimEquationUtil.h.

{}

ossimEquationUtil() [2/2]

ossimEquationUtil::ossimEquationUtil ( )

inlineprotected

Definition at line 41 of file ossimEquationUtil.h.

: m_argumentParser(0) {}

Member Function Documentation

addArguments()

void ossimEquationUtil::addArguments ( ossimArgumentParser &  ap )

protected

execute()

bool ossimEquationUtil::execute ( )

virtual

Returns true if successful.

Implements ossimProcessInterface.

Definition at line 174 of file ossimEquationUtil.cpp.

References ossimArgumentParser::argc(), m_argumentParser, m_usage, ossimNotify(), ossimNotifyLevel_INFO, ossimArgumentParser::read(), and ossimApplicationUsage::write().

{
   // Allocate some stuff up front for use later
   ossimString writerType = "tiff_strip";
   ossimString equationSpec;
   std::string tempString;
   ossimArgumentParser::ossimParameter stringParam(tempString);
   std::map<ossimString, ossimString, ossimStringLtstr> writerPropertyMap;
   vector<ossimFilename> infiles;
   ossimFilename outfile;

   // Display Help
   if (m_argumentParser->read("-h") || m_argumentParser->read("--help") || (m_argumentParser->argc() < 4))
   {
      m_usage.write(ossimNotify(ossimNotifyLevel_INFO));
      ossimNotify(ossimNotifyLevel_INFO)<<EQ_SPEC<<endl;
      return false;
   }

   // Output KWL template
   if (m_argumentParser->read("-t", stringParam))
   {
      ossimFilename templateFilename = tempString.c_str();
      outputTemplateKeywordlist(templateFilename);
      return false;
   }

   // Keyword list to load from
   if (m_argumentParser->read("-k", stringParam))
   {
      if (!parseKwl(tempString.c_str(), infiles, equationSpec, outfile, writerType))
         return false;
   }
   else
   {
      // Everything on command line:
      // user input writer props, should use those
      while(m_argumentParser->read("--writer-prop", stringParam))
      {
         std::vector<ossimString> nameValue;
         ossimString(tempString).split(nameValue, "=");
         if(nameValue.size() == 2)
            writerPropertyMap.insert(std::make_pair(nameValue[0], nameValue[1]));
      }

      // User input a writer type
      if (m_argumentParser->read("-w", stringParam))
         writerType = tempString;

      int argCount = m_argumentParser->argc();
      if (argCount < 4)
      {
         m_usage.write(ossimNotify(ossimNotifyLevel_INFO));
         ossimNotify(ossimNotifyLevel_INFO)<<EQ_SPEC<<endl;
         return false;
      }

      // First the equation spec:
      equationSpec = m_argumentParser->argv()[1];

      // Get the input files.
      for (int i=2; i< (argCount-1); ++i)
         infiles.push_back(ossimFilename(m_argumentParser->argv()[i]));

      // Get the output file.
      outfile = m_argumentParser->argv()[argCount-1];
   }

   if (!initInputSources(infiles))
      return false;

   // Create combiner object
   ossimRefPtr<ossimEquationCombiner> combiner = new ossimEquationCombiner(m_inputSources);
   combiner->setEquation(equationSpec);

   // Create writer:
   ossimRefPtr<ossimImageFileWriter> writer;
   writer = ossimImageWriterFactoryRegistry::instance()->createWriter(writerType);
   if(!writer.valid())
   {
      ossimNotify(ossimNotifyLevel_FATAL)<<"Could not create writer of type <"<<writerType<<">"<<endl;
      return false;
   }
   writer->connectMyInputTo(combiner.get());
   writer->setFilename(outfile);
   ossimIrect bounding_irect;
   m_prodGeometry->getBoundingRect(bounding_irect);
   writer->setAreaOfInterest(bounding_irect);
   writer->initialize();

   if ( writerPropertyMap.size() )
   {
      ossimPropertyInterface* propInterface = (ossimPropertyInterface*) writer.get();
      std::map<ossimString, ossimString, ossimStringLtstr>::iterator iter = writerPropertyMap.begin();
      while(iter!=writerPropertyMap.end())
      {
         propInterface->setProperty(iter->first, iter->second);
         ++iter;
      }
   }

   // Execute:
   ossimStdOutProgress listener;
   writer->addListener(&listener);
   if (!writer->execute())
   {
      ossimNotify(ossimNotifyLevel_WARN)<< "Error encountered writing file..."<<endl;
      return false;
   }

   writer->close();
   return true;
}

getManager()

virtual ossimListenerManager* ossimEquationUtil::getManager ( )

inlinevirtual

Reimplemented from ossimProcessInterface.

Definition at line 38 of file ossimEquationUtil.h.

{ return this; };

getObject() [1/2]

virtual ossimObject* ossimEquationUtil::getObject ( )

inlinevirtual

Implements ossimProcessInterface.

Definition at line 36 of file ossimEquationUtil.h.

{ return this; }

getObject() [2/2]

virtual const ossimObject* ossimEquationUtil::getObject ( ) const

inlinevirtual

Implements ossimProcessInterface.

Definition at line 37 of file ossimEquationUtil.h.

{ return this; }

initInputSources()

bool ossimEquationUtil::initInputSources ( std::vector< ossimFilename > &  fileList )

protected

Definition at line 357 of file ossimEquationUtil.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimImageGeometry::dup(), ossimRefPtr< T >::get(), ossimImageHandler::getImageGeometry(), ossimImageGeometry::getMetersPerPixel(), ossimImageGeometry::getTiePoint(), ossimImageRenderer::initialize(), ossimImageHandlerRegistry::instance(), ossimImageGeometry::isAffectedByElevation(), m_inputSources, m_prodGeometry, ossimImageHandlerRegistry::open(), ossimImageViewProjectionTransform::setImageGeometry(), ossimImageRenderer::setImageViewTransform(), ossimMapProjection::setMetersPerPixel(), ossimMapProjection::setOrigin(), ossimImageGeometry::setProjection(), ossimImageViewProjectionTransform::setViewGeometry(), and ossimRefPtr< T >::valid().

{
   bool result = true;
   m_inputSources.clear();
   ossimRefPtr<ossimImageGeometry> input_geom;

   for(ossim_int32 index = 0; index < (ossim_int32)fileList.size();++index)
   {
      ossimRefPtr<ossimImageHandler> handler =
            ossimImageHandlerRegistry::instance()->open(fileList[index]);
      if(!handler.valid())
      {
         cerr << "Error: Unable to load image " << fileList[index] << endl;
         result = false;
         break;
      }

      input_geom = handler->getImageGeometry();

      if (index == 0)
      {
         m_prodGeometry = (ossimImageGeometry*) input_geom->dup();
         ossimGpt origin;
         m_prodGeometry->getTiePoint(origin, false);
         ossimDpt gsd (m_prodGeometry->getMetersPerPixel());

         if (m_prodGeometry->isAffectedByElevation())
         {
            // Need to ortho to UTM, so define output geometry shared by all input chains:
            ossimMapProjection* prod_proj = new ossimUtmProjection;
            prod_proj->setOrigin(origin);
            prod_proj->setMetersPerPixel(m_prodGeometry->getMetersPerPixel());
            m_prodGeometry->setProjection(prod_proj);
         }
      }

      // Set up the IVT for this input's renderer:
      ossimRefPtr<ossimImageViewProjectionTransform> transform = new ossimImageViewProjectionTransform;
      transform->setImageGeometry(input_geom.get());
      transform->setViewGeometry(m_prodGeometry.get());

      ossimRefPtr<ossimImageRenderer> renderer = new ossimImageRenderer;
      renderer->connectMyInputTo(0, handler.get());
      renderer->setImageViewTransform(transform.get());
      renderer->initialize();

      m_inputSources.push_back(renderer.get());
   }

   return result;
}

outputTemplateKeywordlist()

void ossimEquationUtil::outputTemplateKeywordlist ( const ossimFilename &  templateFilename )

protected

Definition at line 288 of file ossimEquationUtil.cpp.

References ossimString::c_str(), ossimNotify(), and ossimNotifyLevel_NOTICE.

{
   ofstream out(templateFilename.c_str());

   out << "file1.filename: <full path and file name>" << endl
       << "file2.filename: <full path and file name>" << endl
       << "// :\n"
       << "// :\n"
       << "// fileN.filename:: <full path and file name>" << endl
       << "\n// currently this option has been tested\n"
       << "// with ossimTiffWriter and ossimJpegWriter\n"
       << "writer.type: tiff_strip"            << endl
       << "writer.filename: <full path to output file>"  << endl
       << "\n// Equation specification:\n"
       << "equation: <equation spec string>"<<endl;

   ossimNotify(ossimNotifyLevel_NOTICE) << "Wrote file: " << templateFilename << std::endl;
}

parseKwl()

bool ossimEquationUtil::parseKwl ( const ossimFilename &  kwl_file, std::vector< ossimFilename > &  inputs, ossimString &  equationSpec, ossimFilename &  output, ossimString &  writerType  )

protected

Definition at line 307 of file ossimEquationUtil.cpp.

References ossimKeywordlist::addFile(), ossimString::c_str(), ossimString::empty(), ossimKeywordlist::find(), ossimKeywordlist::getNumberOfSubstringKeys(), ossimNotify(), ossimNotifyLevel_FATAL, and ossimString::toString().

{
   ossimKeywordlist kwl;
   if (!kwl.addFile(kwl_file))
      return false;

   ossim_int32 index = 0;
   ossim_int32 result = kwl.getNumberOfSubstringKeys("file[0-9]+\\.filename");
   const char* lookup = NULL;
   ossim_int32 numberOfMatches = 0;

   while(numberOfMatches < result)
   {
      ossimString searchValue = "file" + ossimString::toString(index);

      ossimString filename = searchValue + ".filename";
      lookup = kwl.find(filename.c_str());
      if(lookup)
      {
         inputs.push_back(ossimFilename(lookup));
         ++numberOfMatches;
      }
      ++index;
   }

   equationSpec = kwl.find("equation");
   if (equationSpec.empty())
   {
      ossimNotify(ossimNotifyLevel_FATAL)<<"No equation specified in KWL"<<endl;
      return false;
   }

   output = kwl.find("writer.filename");
   if (output.empty())
   {
      ossimNotify(ossimNotifyLevel_FATAL)<<"No output filename specified in KWL"<<endl;
      return false;
   }

   writerType = kwl.find("writer.type");
   if (writerType.empty())
      writerType = "tiff_strip";

   return true;
}

Member Data Documentation

m_argumentParser

ossimArgumentParser* ossimEquationUtil::m_argumentParser

protected

Definition at line 52 of file ossimEquationUtil.h.

Referenced by execute().

m_inputSources

ossimConnectableObject::ConnectableObjectList ossimEquationUtil::m_inputSources

protected

Definition at line 54 of file ossimEquationUtil.h.

Referenced by initInputSources().

m_prodGeometry

ossimRefPtr<ossimImageGeometry> ossimEquationUtil::m_prodGeometry

protected

Definition at line 55 of file ossimEquationUtil.h.

Referenced by initInputSources().

m_usage

ossimApplicationUsage ossimEquationUtil::m_usage

protected

Definition at line 53 of file ossimEquationUtil.h.

Referenced by execute(), and ossimEquationUtil().

---

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

• ossimEquationUtil.h
• ossimEquationUtil.cpp