ossimSubImageTool Class Reference

#include <ossimSubImageTool.h>

Inheritance diagram for ossimSubImageTool:

Public Types
enum	RpcGeomFormat { OGEOM, DG, JSON, XML }
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
	ossimSubImageTool ()
	~ossimSubImageTool ()
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
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 ossimIrect &img_rect)
	The meat and potatos of this class. More...
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...
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
RpcGeomFormat	m_geomFormat
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

Tool class for extracting a subimage rectangle from a full image. The original sensor model is replaced with the subimage RPC representation. This is necessary as OSSIM does not support sub-image offset in the sensor models yet.

Definition at line 22 of file ossimSubImageTool.h.

Member Enumeration Documentation

RpcGeomFormat

enum ossimSubImageTool::RpcGeomFormat

Enumerator
OGEOM
DG
JSON
XML

Definition at line 25 of file ossimSubImageTool.h.

{ OGEOM, DG, JSON, XML };

Constructor & Destructor Documentation

ossimSubImageTool()

ossimSubImageTool::ossimSubImageTool

(

)

Definition at line 28 of file ossimSubImageTool.cpp.

:  m_geomFormat (OGEOM)
{
}

~ossimSubImageTool()

ossimSubImageTool::~ossimSubImageTool

(

)

Definition at line 33 of file ossimSubImageTool.cpp.

{
}

Member Function Documentation

execute()

bool ossimSubImageTool::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.

Reimplemented from ossimChipProcTool.

Definition at line 192 of file ossimSubImageTool.cpp.

References DG, ossimChipProcTool::execute(), ossimXmlDocument::fromKwl(), ossimRefPtr< T >::get(), ossimImageChain::getImageGeometry(), ossimImageGeometry::getProjection(), ossimRpcSolver::getRpcModel(), JSON, ossimChipProcTool::m_aoiViewRect, ossimChipProcTool::m_geom, m_geomFormat, ossimChipProcTool::m_procChain, ossimChipProcTool::m_productFilename, OGEOM, ossimNotify(), ossimNotifyLevel_FATAL, ossimNotifyLevel_INFO, ossimImageGeometry::saveState(), ossimFilename::setExtension(), ossimRpcModel::setImageOffset(), ossimImageGeometry::setImageSize(), ossimIrect::size(), ossimRpcSolver::solve(), ossimString::string(), ossimRpcModel::toJSON(), ossimRpcModel::toRPB(), ossimIrect::ul(), ossimXmlDocument::write(), ossimKeywordlist::write(), and XML.

{
   // Compute RPC representation of subimage:
   ossimRefPtr<ossimImageGeometry> inputGeom = m_procChain->getImageGeometry();
   if (!inputGeom || !inputGeom->getProjection())
   {
      ostringstream errMsg;
      errMsg << " ERROR: ossimSubImageTool ["<<__LINE__<<"] Null projection returned for input "
            "image!" << endl;
      throw ossimException( errMsg.str() );
   }

   ossimRefPtr<ossimProjection> inputProj = inputGeom->getProjection();
   ossimRefPtr<ossimRpcModel> rpc;
   ossimRefPtr<ossimRpcSolver> solver = new ossimRpcSolver(false);
   bool converged = false;

   // If the input projection itself is an RPC, just copy it. No solving required:
   ossimRpcModel* inputRpc = dynamic_cast<ossimRpcModel*>(inputGeom->getProjection());
   if (inputRpc)
      rpc = inputRpc;
   else
   {
      converged = solver->solve(m_aoiViewRect, inputGeom.get());
      rpc = solver->getRpcModel();
   }

   // The RPC needs to be shifted in image space so that it will work in the subimage coordinates:
   rpc->setImageOffset(m_aoiViewRect.ul());
   m_geom = new ossimImageGeometry(nullptr, rpc.get());
   m_geom->setImageSize(m_aoiViewRect.size());
   ossimKeywordlist kwl;
   m_geom->saveState(kwl);

   bool success = ossimChipProcTool::execute();
   if (!success)
      return false;

   // Need to save the subimage RPC data:
   bool write_ok = false;
   ossimFilename geomFile (m_productFilename);
   if (m_geomFormat == OGEOM) // Default case if none specified
   {
      geomFile.setExtension("geom");
      write_ok = kwl.write(geomFile);
   }
   else if (m_geomFormat == JSON)
   {
#if OSSIM_HAS_JSONCPP
      geomFile.setExtension("json");
      ofstream jsonStream (geomFile.string());
      if (!jsonStream.fail())
      {
         // Note that only the model/projection is saved here, not the full ossimImageGeometry that
         // contains the subimage shift transform. So need to cheat and add the shift to the RPC
         // line and sample offsets:
         write_ok = rpc->toJSON(jsonStream);
         jsonStream.close();
      }
#else
      ostringstream errMsg;
      errMsg << " ERROR: ossimSubImageTool ["<<__LINE__<<"] JSON geometry output requested but JSON is not "
            "available in this build! <" << endl;
      throw ossimException( errMsg.str() );
#endif
   }
   else if (m_geomFormat == DG)
   {
      geomFile.setExtension("RPB");
      ofstream rpbStream (geomFile.string());
      if (!rpbStream.fail())
      {
         write_ok = rpc->toRPB(rpbStream);
         rpbStream.close();
      }
   }
   else if (m_geomFormat == XML)
   {
      geomFile.setExtension("xml");
      ossimXmlDocument xmlDocument;
      xmlDocument.fromKwl(kwl);
      write_ok = xmlDocument.write(geomFile);
   }

   if (write_ok)
      ossimNotify(ossimNotifyLevel_INFO) << "Wrote geometry file to <"<<geomFile<<">.\n" << endl;
   else
   {
      ossimNotify(ossimNotifyLevel_FATAL) << "Error encountered writing output RPC geometry file."
            << std::endl;
      return false;
   }

   return true;
}

getClassName()

virtual ossimString ossimSubImageTool::getClassName ( ) const

inlinevirtual

Reimplemented from ossimTool.

Definition at line 57 of file ossimSubImageTool.h.

{ return "ossimSubImageTool"; }

initialize() [1/2]

bool ossimSubImageTool::initialize ( ossimArgumentParser &  ap )

virtual

Initializes from command line arguments.

Returns

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

Note

Throws ossimException on error.

Reimplemented from ossimChipProcTool.

Definition at line 65 of file ossimSubImageTool.cpp.

References ossimKeywordlist::addPair(), BBOX_KW, DG, ossimKeywordNames::ENTRY_KW, ossimTool::initialize(), JSON, m_geomFormat, ossimTool::m_helpRequested, ossimTool::m_kwl, OGEOM, ossimChipProcTool::processRemainingArgs(), ossimArgumentParser::read(), ossimString::upcase(), and XML.

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

   string tempString1;
   ossimArgumentParser::ossimParameter stringParam1(tempString1);
   string tempString2;
   ossimArgumentParser::ossimParameter stringParam2(tempString2);
   string tempString3;
   ossimArgumentParser::ossimParameter stringParam3(tempString3);
   string tempString4;
   ossimArgumentParser::ossimParameter stringParam4(tempString4);
   double tempDouble1;
   ossimArgumentParser::ossimParameter doubleParam1(tempDouble1);
   double tempDouble2;
   ossimArgumentParser::ossimParameter doubleParam2(tempDouble2);
   vector<ossimString> paramList;

   ossim_uint32 readerPropIdx = 0;
   ossim_uint32 writerPropIdx = 0;
   ostringstream keys;

   if ( ap.read("--bbox", stringParam1, stringParam2, stringParam3, stringParam4))
   {
      ostringstream ostr;
      ostr<<tempString1<<" "<<tempString2<<" "<<tempString3<<" "<<tempString4<<ends;
      m_kwl.addPair( string(BBOX_KW), ostr.str() );
   }
   if ( ap.read("-e", stringParam1) || ap.read("--entry", stringParam1) )
      m_kwl.addPair( string(ossimKeywordNames::ENTRY_KW), tempString1 );

   if ( ap.read("--geom", stringParam1))
   {
      ossimString formatStr (tempString1);
      formatStr.upcase();
      if (formatStr == "OGEOM")
         m_geomFormat = OGEOM;
      else if (formatStr == "DG")
         m_geomFormat = DG;
      else if (formatStr == "JSON")
         m_geomFormat = JSON;
      else if (formatStr == "XML")
         m_geomFormat = XML;
      else
      {
         ostringstream errMsg;
         errMsg << " ERROR: ossimSubImageTool ["<<__LINE__<<"] Unknown geometry format <"
               <<formatStr<<"> specified. Aborting." << endl;
         throw ossimException( errMsg.str() );
      }
   }
   processRemainingArgs(ap);

   return true;
}

initialize() [2/2]

void ossimSubImageTool::initialize ( const ossimKeywordlist &  kwl )

virtual

Reads processing params from KWL and prepares for execute.

Returns TRUE if successful.

Note

Throws ossimException on error.

Reimplemented from ossimChipProcTool.

Definition at line 124 of file ossimSubImageTool.cpp.

References ossimImageChain::add(), BBOX_KW, ossimKeywordNames::ENTRY_KW, ossimChipProcTool::finalizeChain(), ossimKeywordlist::find(), ossimKeywordlist::findKey(), ossimRefPtr< T >::get(), ossimKeywordNames::IMAGE_FILE_KW, ossimImageHandlerRegistry::instance(), ossimChipProcTool::m_aoiViewRect, ossimTool::m_kwl, ossimChipProcTool::m_needCutRect, ossimChipProcTool::m_procChain, ossimChipProcTool::m_productFilename, ossimImageHandlerRegistry::open(), ossimKeywordNames::OUTPUT_FILE_KW, ossimIrect::set_lr(), ossimIrect::set_ul(), ossimImageHandler::setCurrentEntry(), ossimString::split(), ossimString::toUInt32(), and ossimString::trim().

{
   m_productFilename = m_kwl.find(ossimKeywordNames::OUTPUT_FILE_KW);

   // Init chain with handler:
   ostringstream key;
   key<<ossimKeywordNames::IMAGE_FILE_KW<<"0";
   ossimFilename fname = m_kwl.findKey(key.str());
   ossimRefPtr<ossimImageHandler> handler =
         ossimImageHandlerRegistry::instance()->open(fname, true, false);
   if (!handler)
   {
      ostringstream errMsg;
      errMsg<<"ERROR: ossimSubImageTool ["<<__LINE__<<"] Could not open <"<<fname<<">"<<ends;
      throw ossimException(errMsg.str());
   }

   // Look for the entry keyand set it:
   ossim_uint32 entryIndex = 0;
   ossimString os = m_kwl.find(ossimKeywordNames::ENTRY_KW);
   if (os)
      entryIndex = os.toUInt32();
   if (!handler->setCurrentEntry( entryIndex ))
   {
      ostringstream errMsg;
      errMsg << " ERROR: ossimSubImageTool ["<<__LINE__<<"] Entry " << entryIndex << " out of range!" << endl;
      throw ossimException( errMsg.str() );
   }
   m_procChain->add(handler.get());

   // And finally the bounding rect:
   ossimString lookup = m_kwl.find(BBOX_KW);
   lookup.trim();
   vector<ossimString> substrings = lookup.split(", ", true);
   if (substrings.size() != 4)
   {
      ostringstream errMsg;
      errMsg << "ossimSubImageTool ["<<__LINE__<<"] Incorrect number of values specified for bbox!";
      throw( ossimException(errMsg.str()) );
   }

   int ulx = substrings[0].toInt32();
   int uly = substrings[1].toInt32();
   int lrx = substrings[2].toInt32();
   int lry = substrings[3].toInt32();

   // Check for swap:
   if ( ulx > lrx )
   {
      int tmpF = ulx;
      ulx = lrx;
      lrx = tmpF;
   }
   if ( uly > lry )
   {
      int tmpF = uly;
      uly = lry;
      lry = tmpF;
   }

   // Use of view rect here is same as image space since there is no renderer:
   m_aoiViewRect.set_ul(ossimIpt(ulx, uly));
   m_aoiViewRect.set_lr(ossimIpt(lrx, lry));
   m_needCutRect = true;

   finalizeChain();
}

initProcessingChain()

virtual void ossimSubImageTool::initProcessingChain ( )

inlineprotectedvirtual

Derived classes initialize their custom chains here.

Implements ossimChipProcTool.

Definition at line 63 of file ossimSubImageTool.h.

{}

setUsage()

void ossimSubImageTool::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>);

Reimplemented from ossimChipProcTool.

Definition at line 37 of file ossimSubImageTool.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 += " subimage [options] <input-image> <output-image>";
   au->setCommandLineUsage(usageString);

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

   // Base class has its own. Skip the ossimChipProcTool usage as that adds a lot of view-space
   // specific stuff not used in this tool:
   ossimTool::setUsage(ap);

   au->addCommandLineOption(
         "--bbox <ulx> <uly> <lrx> <lry>",
         "Specify upper-left and lower-right bounds the image rect (in pixels).");
   au->addCommandLineOption(
         "-e | --entry <N> ",
         "For multi image entries which entry do you wish to extract. For list "
         "of entries use: \"ossim-info -i <your_image>\" ");
   au->addCommandLineOption(
         "--geom <format>", "Specifies format of the subimage RPC geometry file."
         " Possible values are: \"OGEOM\" (OSSIM geometry, default), \"DG\" (DigitalGlobe WV/QB "
         ".RPB format), \"JSON\" (MSP-style JSON), or \"XML\". Case insensitive.");
}

Member Data Documentation

DESCRIPTION

const char * ossimSubImageTool::DESCRIPTION

static

Initial value:

= "Tool for extracting a sub-image from a full image."
      " No reprojection is done. Presently, the subimage geometry is represented by an RPC "
      "replacement model until generic models can support subimage chipping."

Used by ossimUtilityFactory.

Definition at line 60 of file ossimSubImageTool.h.

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

m_geomFormat

RpcGeomFormat ossimSubImageTool::m_geomFormat

protected

Definition at line 65 of file ossimSubImageTool.h.

Referenced by execute(), and initialize().

---

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

• ossimSubImageTool.h
• ossimSubImageTool.cpp