ossimChipProcTool Class Reference

#include <ossimChipProcTool.h>

Inheritance diagram for ossimChipProcTool:

Public Member Functions
	ossimChipProcTool ()
	default constructor More...
virtual	~ossimChipProcTool ()
	virtual destructor More...
virtual void	setUsage (ossimArgumentParser &ap)
	Initializes the aurgument parser with expected parameters and options. More...
virtual void	clear ()
	Disconnects and clears the dem and image layers. More...
virtual bool	initialize (ossimArgumentParser &ap)
	Initial method to be ran prior to execute. More...
virtual void	initialize (const ossimKeywordlist &kwl)
	This method is responsible for completely setting up the full processing chain according to the specifications given in the kwl passed in. More...
virtual bool	execute ()
	Performs the actual product write. 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
virtual ossimString	getClassName () 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)

Protected Member Functions
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	initProcessingChain ()=0
	Derived classes initialize their custom chains here. 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
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

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 42 of file ossimChipProcTool.h.

Constructor & Destructor Documentation

ossimChipProcTool() [1/2]

ossimChipProcTool::ossimChipProcTool

(

)

default constructor

Definition at line 69 of file ossimChipProcTool.cpp.

References m_geom, m_gsd, ossimTool::m_kwl, m_procChain, ossimDpt::makeNan(), and ossimKeywordlist::setExpandEnvVarsFlag().

:  m_projIsIdentity(false),
   m_geoScaled(false),
   m_productScalarType(OSSIM_SCALAR_UNKNOWN),
   m_needCutRect(false)
{
   m_kwl.setExpandEnvVarsFlag(true);
   m_gsd.makeNan();
   m_geom = new ossimImageGeometry;
   m_procChain = new ossimImageChain;
}

~ossimChipProcTool()

ossimChipProcTool::~ossimChipProcTool ( )

virtual

virtual destructor

Definition at line 81 of file ossimChipProcTool.cpp.

References clear().

{
   clear();
}

ossimChipProcTool() [2/2]

ossimChipProcTool::ossimChipProcTool ( const ossimChipProcTool &  obj )

protected

Hidden from use copy constructor.

Definition at line 62 of file ossimChipProcTool.cpp.

: m_projIsIdentity(false),
  m_geoScaled (false),
  m_productScalarType(OSSIM_SCALAR_UNKNOWN),
  m_needCutRect(false)
{}

Member Function Documentation

abort()

void ossimChipProcTool::abort ( )

virtual

Reimplemented from ossimProcessInterface.

Definition at line 444 of file ossimChipProcTool.cpp.

References ossimProcessInterface::abort(), m_writer, and ossimRefPtr< T >::valid().

{
   if(m_writer.valid())
   {
      m_writer->abort();
   }
}

clear()

void ossimChipProcTool::clear ( )

virtual

Disconnects and clears the dem and image layers.

Reimplemented from ossimTool.

Reimplemented in ossimViewshedTool.

Definition at line 86 of file ossimChipProcTool.cpp.

References m_geom, m_gsd, m_imgLayers, m_needCutRect, m_procChain, m_writer, and ossimDpt::makeNan().

Referenced by ossimViewshedTool::clear(), ~ossimChipProcTool(), and ossimHillshadeTool::~ossimHillshadeTool().

{
   m_gsd.makeNan();

   m_procChain = 0;
   m_imgLayers.clear();
   m_writer = 0;
   m_geom = 0;
   m_needCutRect = false;
}

combineLayers()

ossimRefPtr< ossimImageSource > ossimChipProcTool::combineLayers ( std::vector< ossimRefPtr< ossimSingleImageChain > > &  layers ) const

protected

When multiple input sources are present, this method instantiates a combiner and adds inputs.

Returns

Reference to the combiner.

Definition at line 1429 of file ossimChipProcTool.cpp.

References ossimConnectableObject::connectMyInputTo(), and ossimRefPtr< T >::get().

Referenced by ossimHillshadeTool::initProcessingChain(), ossimSlopeTool::initProcessingChain(), ossimHdf5Tool::initProcessingChain(), ossimHlzTool::initProcessingChain(), and ossimViewshedTool::initProcessingChain().

{
   ossimRefPtr<ossimImageSource> combiner = 0;
   ossim_uint32 layerCount = (ossim_uint32) layers.size();
   if ( layerCount  == 1 )
   {
      combiner = layers[0].get();
   }
   else if (layerCount  > 1)
   {
      combiner = new ossimImageMosaic;
      std::vector< ossimRefPtr<ossimSingleImageChain> >::iterator chainIdx = layers.begin();
      while ( chainIdx !=  layers.end() )
      {
         combiner->connectMyInputTo( (*chainIdx).get() );
         ++chainIdx;
      }
   }
   return combiner;
}

computeAdjustedViewFromGrect()

void ossimChipProcTool::computeAdjustedViewFromGrect ( )

protected

Initializes m_aoiViewRect given m_aoiGroundRect.

Definition at line 1265 of file ossimChipProcTool.cpp.

References ossimImageChain::getBoundingRect(), ossimImageGeometry::getDegreesPerPixel(), ossimGrect::hasNans(), ossimIrect::hasNans(), ossimGpt::lat, ossimGpt::lon, ossimGrect::lr(), m_aoiGroundRect, m_aoiViewRect, m_geom, m_procChain, ossimIrect::makeNan(), ossimGrect::ul(), ossimImageGeometry::worldToLocal(), ossimDpt::x, and ossimDpt::y.

Referenced by getChip().

{
   // Nan rect for starters.
   m_aoiViewRect.makeNan();
   if (m_aoiGroundRect.hasNans())
      return;

   // Assume cut box is edge to edge or "Pixel Is Area". Our
   // AOI(area of interest) uses center of pixel or "Pixel Is Point"
   // so get the degrees per pixel and shift AOI to center.
   ossimDpt halfDpp;
   m_geom->getDegreesPerPixel( halfDpp );
   halfDpp = halfDpp/2.0;

   ossimGpt gpt(0.0, 0.0, 0.0);
   ossimDpt ulPt;
   ossimDpt lrPt;

   // Upper left:
   gpt.lat = m_aoiGroundRect.ul().lat - halfDpp.y;
   gpt.lon = m_aoiGroundRect.ul().lon + halfDpp.x;
   m_geom->worldToLocal(gpt, ulPt);

   // Lower right:
   gpt.lat = m_aoiGroundRect.lr().lat + halfDpp.y;
   gpt.lon = m_aoiGroundRect.lr().lon - halfDpp.x;
   m_geom->worldToLocal(gpt, lrPt);

   m_aoiViewRect = ossimIrect( ossimIpt(ulPt), ossimIpt(lrPt) );

   // If no user defined rect set to scene bounding rect.
   if ( m_aoiViewRect.hasNans() )
      m_aoiViewRect = m_procChain->getBoundingRect(0);
}

createClipPolygon()

ossimRefPtr<ossimGeoPolygon> ossimChipProcTool::createClipPolygon ( ) const

protected

createInputChain()

ossimRefPtr< ossimSingleImageChain > ossimChipProcTool::createInputChain ( const ossimFilename &  image_file, ossim_uint32  entry_index = 0  )

protected

Creates the ossimSingleImageChain from image filename and populates the chain with resampler and product output projection on view-side of resampler's IVT.

Parameters

file	File to open.
entryIndex	Entry to open.

Returns

Ref pointer to ossimSingleImageChain.

Note

Throws ossimException on error.

Definition at line 597 of file ossimChipProcTool.cpp.

References ossimImageChain::add(), ossimSingleImageChain::addCache(), ossimSingleImageChain::addResampler(), ossimKeywordlist::findKey(), ossimRefPtr< T >::get(), ossimSingleImageChain::getImageHandler(), ossimImageChain::getOutputScalarType(), ossimTool::m_kwl, m_procChain, m_productScalarType, ossimSingleImageChain::open(), OSSIM_SCALAR_UNKNOWN, ossimImageHandler::setCurrentEntry(), ossimScalarRemapper::setOutputScalarType(), and setReaderProps().

Referenced by loadImageFiles(), ossimHlzTool::MaskSource::MaskSource(), and mosaicDemSources().

{
   // Init chain with handler:
   ossimRefPtr<ossimSingleImageChain> chain = new ossimSingleImageChain;
   if (!chain->open(fname))
   {
      ostringstream errMsg;
      errMsg<<"ERROR: ossimChipProcUtil ["<<__LINE__<<"] Could not open <"<<fname<<">"<<ends;
      throw ossimException(errMsg.str());
   }

   // Set any reader props:
   ossimImageHandler* handler = chain->getImageHandler().get();
   setReaderProps( handler );
   if (!handler->setCurrentEntry( entry_index ))
   {
      std::ostringstream errMsg;
      errMsg << " ERROR: ossimChipProcUtil ["<<__LINE__<<"] Entry " << entry_index << " out of range!" << std::endl;
      throw ossimException( errMsg.str() );
   }

   // Set up the remapper:
   if ( ( m_productScalarType != OSSIM_SCALAR_UNKNOWN) &&
         ( m_procChain->getOutputScalarType() != m_productScalarType ) )
   {
      ossimRefPtr<ossimScalarRemapper> remapper = new ossimScalarRemapper();
      remapper->setOutputScalarType(m_productScalarType);
      chain->add(remapper.get());
   }

   // Set up the renderer with cache:
   chain->addResampler();
   chain->addCache();

   // Add geo polygon cutter if specifried:
   ossimString param = m_kwl.findKey(CLIP_POLY_LAT_LON_KW);
   if (!param.empty())
   {
      std::vector<ossimGpt> points;
      ossim::toVector(points, param);
      if(points.size() >= 3)
      {
         ossimGeoPolygon polygon(points);
         chain->addGeoPolyCutterPolygon(polygon);
      }
   }

   chain->initialize();
   return chain;
}

createOutputProjection()

void ossimChipProcTool::createOutputProjection ( )

protected

Creates the output or view projection.

Note

All chains must be constructed prior to calling this.

Definition at line 688 of file ossimChipProcTool.cpp.

References ossimKeywordlist::findKey(), ossimTool::m_kwl, and ossimKeywordNames::PROJECTION_KW.

{
   static const char* MODULE = "ossimChipProcUtil::createOutputProjection()";

   ossimString op  = m_kwl.findKey( std::string(ossimKeywordNames::PROJECTION_KW) );
   ossimString srs = m_kwl.findKey( SRS_KW );
   if ( op.size() && srs.size() )
   {
      ossimNotify(ossimNotifyLevel_WARN)
                           << MODULE << " WARNING:"
                           << "\nBoth " << SRS_KW << " and " << ossimKeywordNames::PROJECTION_KW
                           << " keywords are set!"
                           << "\nsrs:               " << srs
                           << "\noutput_projection: " << op
                           << "\nTaking " << srs << " over " << op << "\n";
   }

   ossimRefPtr<ossimMapProjection> proj = 0;
   m_geoScaled = false;
   op.downcase();

   if (op.contains("epsg"))
      srs = op;

   if ( (op == "geo") || (srs.contains("4326")))
      proj = new ossimEquDistCylProjection();

   else if (srs.size())
   {
      proj = PTR_CAST(ossimMapProjection,
                      ossimProjectionFactoryRegistry::instance()->createProjection(srs));
      if (!proj.valid())
         throw ossimException("ossimChipProcUtil::createOutputProjection() -- Bad EPSG code passed.");
   }
   else if (op == "geo-scaled")
   {
      m_geoScaled = true; // used later when reference latitude is known
      proj = new ossimEquDistCylProjection();
   }
   else if ( ( op == "input" ) || (op == "identity") || (op == "none") )
      proj = newIdentityProjection();

   else if ( (op == "utm") || (op == "ossimutmprojection") )
      proj = newUtmProjection();

   else
   {
      m_geoScaled = true; // used later when reference latitude is known
      proj = new ossimEquDistCylProjection();
   }

   // Create our ossimImageGeometry with projection (no transform).
   proj->setElevationLookupFlag(true);
   m_geom->setProjection(proj.get());

   // Set the scale and AOI.
   initializeProjectionGsd();
   initializeAOI(); // also sets the tie point to AOI UL and geoscaling to origin.

   // Setup the view in all the chains.
   propagateGeometryToChains();
}

execute()

bool ossimChipProcTool::execute ( )

virtual

Performs the actual product write.

Note

Throws ossimException on error.

Implements ossimProcessInterface.

Reimplemented in ossimSubImageTool, ossimViewshedTool, ossimHdf5Tool, ossimShorelineTool, ossimHlzTool, ossimPotraceTool, ossimBandMergeTool, and ossimRegTool.

Definition at line 394 of file ossimChipProcTool.cpp.

References ossimImageFileWriter::addListener(), ossimConnectableObject::connectMyInputTo(), ossimImageFileWriter::execute(), ossimRefPtr< T >::get(), ossimErrorStatusInterface::getErrorStatus(), ossimImageGeometry::getImageSize(), ossimIpt::hasNans(), ossimProcessInterface::isAborted(), m_aoiViewRect, m_geom, ossimTool::m_helpRequested, m_procChain, m_productFilename, m_writer, newWriter(), ossimErrorCodes::OSSIM_OK, ossimNotify(), ossimNotifyLevel_INFO, ossimImageFileWriter::removeListener(), ossimImageFileWriter::setAreaOfInterest(), and ossimRefPtr< T >::valid().

Referenced by ossimShorelineTool::doThreshold(), ossimBandMergeTool::execute(), ossimHlzTool::execute(), ossimShorelineTool::execute(), ossimHdf5Tool::execute(), ossimViewshedTool::execute(), and ossimSubImageTool::execute().

{
   if (m_helpRequested)
      return true;

   ostringstream xmsg;

   if ( !m_procChain.valid() )
   {
      xmsg << "ossimChipProcUtil:"<<__LINE__<<"Null pointer encountered for m_procChain!";
      throw ossimException(xmsg.str());
   }

   if (m_geom->getImageSize().hasNans())
   {
      xmsg << "ossimChipProcUtil:"<<__LINE__<<"Image size is NaN!";
      throw ossimException(xmsg.str());
   }

   // Set up the writer.
   m_writer = newWriter();

   // Connect the writer to the processing chain.
   m_writer->connectMyInputTo(0, m_procChain.get());

   // Set the area of interest. NOTE: This must be called after the writer->connectMyInputTo as
   // ossimImageFileWriter::initialize incorrectly resets AOI back to the bounding rect.
   m_writer->setAreaOfInterest(m_aoiViewRect);

   if (m_writer->getErrorStatus() != ossimErrorCodes::OSSIM_OK)
      throw ossimException( "Unable to initialize writer for execution" );

   // Add a listener to get percent complete.
   ossimStdOutProgress prog(0, true);
   m_writer->addListener(&prog);

   // Write the file:
   m_writer->execute();
   m_writer->removeListener(&prog);
   if(m_writer->isAborted())
   {
      xmsg << "ossimChipProcUtil:"<<__LINE__<<"Writer Process aborted!";
      throw ossimException(xmsg.str());
   }

   ossimNotify(ossimNotifyLevel_INFO)<<"Wrote product image to <"<<m_productFilename<<">"<<endl;

   return true;
}

finalizeChain()

void ossimChipProcTool::finalizeChain ( )

protectedvirtual

Called after initProcessingChain() to append common items to the processing chain.

Sets up the AOI box cutter filter and related stuff and initializes area of interest(aoi). The filter is appended to the current m_procChain. Derived class should override if not applicable to its processing chain.

Reimplemented in ossimPotraceTool, and ossimRegTool.

Definition at line 354 of file ossimChipProcTool.cpp.

References ossimKeywordlist::findKey(), and ossimTool::m_kwl.

Referenced by ossimSubImageTool::initialize().

{
   ostringstream errMsg;

   // See if an LUT is requested:
   ossimFilename lutFile = m_kwl.findKey( LUT_FILE_KW );
   if (!lutFile.empty())
   {
      if ( !lutFile.exists() )
      {
         errMsg<<"ERROR ossimChipProcUtil ["<<__LINE__<<"] Color table <"<<lutFile
               <<"> does not exists: "<<ends;
         throw ossimException(errMsg.str());
      }
      ossimRefPtr<ossimIndexToRgbLutFilter> lut = new ossimIndexToRgbLutFilter();
      lut->setLut(lutFile);
      m_procChain->add(lut.get());
   }

   if (m_needCutRect)
   {
      // Add a cut filter. This will:
      // 1) Null out/clip any data pulled in.
      // 2) Speed up by not propagating get tile request outside the cut or "aoi"
      //    to the left hand side(input).
      m_cutRectFilter = new ossimRectangleCutFilter();
      m_cutRectFilter->setRectangle( m_aoiViewRect );
      m_cutRectFilter->setCutType( ossimRectangleCutFilter::OSSIM_RECTANGLE_NULL_OUTSIDE );
      m_procChain->add(m_cutRectFilter.get());
   }

   // Set the image size here.  Note must be set after combineLayers.  This is needed for
   // the ossimImageGeometry::worldToLocal call for a geographic projection to handle wrapping
   // accross the date line.
   m_geom->setImageSize( m_aoiViewRect.size() );

   // Reset the source bounding rect if it changed.
   m_procChain->initialize();
}

findCenterGpt()

void ossimChipProcTool::findCenterGpt ( ossimGpt &  gpt )

protected

Tries to determine the AOI center point based on KWL entries, else returns NaNs in gpt.

Needed for bootstrapping the GSD computation when information in KWL is sparse

Definition at line 1166 of file ossimChipProcTool.cpp.

References ossimKeywordlist::findKey(), ossimGpt::hgt, and ossimTool::m_kwl.

{
   gpt.hgt = 0.0;
   ossimString lookup = m_kwl.findKey( AOI_GEO_CENTER_KW );
   if (lookup.size())
   {
      lookup.trim();
      vector<ossimString> substrings = lookup.split(", ");
      if (substrings.size() != 2)
      {
         ostringstream errMsg;
         errMsg << "ossimChipProcUtil ["<<__LINE__<<"] Incorrect number of values specified for "
               "aoi_geo_center!";
         throw( ossimException(errMsg.str()) );
      }
      gpt.lat = substrings[0].toDouble();
      gpt.lon = substrings[1].toDouble();
      return;
   }

   lookup = m_kwl.findKey(AOI_GEO_RECT_KW);
   if (lookup.size())
   {
      lookup.trim();
      vector<ossimString> substrings = lookup.split(", ");
      if (substrings.size() != 4)
      {
         ostringstream errMsg;
         errMsg << "ossimChipProcUtil ["<<__LINE__<<"] Incorrect number of values specified for "
               "aoi_geo_rect!";
         throw( ossimException(errMsg.str()) );
      }
      ossim_float64 minLatF = substrings[0].toDouble();
      ossim_float64 minLonF = substrings[1].toDouble();
      ossim_float64 maxLatF = substrings[2].toDouble();
      ossim_float64 maxLonF = substrings[3].toDouble();
      gpt.lat = 0.5*(minLatF + maxLatF);
      gpt.lon = 0.5*(minLonF + maxLonF);
      return;
   }
   gpt.makeNan();
}

getBandList()

void ossimChipProcTool::getBandList ( ossim_uint32  image_idx, std::vector< ossim_uint32 > &  bandList  ) const

protected

Gets the band list if BANDS keyword is set.

NOTE: BANDS keyword values are ONE based. bandList values are ZERO based.

Parameters

input	image index for which the band selection applies
bandList	List initialized by this.

Definition at line 1351 of file ossimChipProcTool.cpp.

References ossimKeywordNames::BANDS_KW, ossimString::empty(), ossimKeywordlist::find(), ossimKeywordlist::findKey(), ossimKeywordNames::IMAGE_FILE_KW, ossimTool::m_kwl, ossimString::size(), and ossimString::split().

Referenced by loadImageFiles().

{
   bandList.clear();
   ostringstream key;
   key <<  ossimKeywordNames::IMAGE_FILE_KW << image_idx << "." << ossimKeywordNames::BANDS_KW;
   ossimString os = m_kwl.findKey(key.str());
   if (os.empty())
   {
      // Look for possible global bands selection:
      os = m_kwl.find(ossimKeywordNames::BANDS_KW);
   }

   if ( os.size() )
   {
      std::vector<ossimString> band_list(0);
      os.split( band_list, ossimString(", "), false );
      if ( band_list.size() )
      {
         std::vector<ossimString>::const_iterator i = band_list.begin();
         while ( i != band_list.end() )
         {
            ossim_uint32 band = (*i).toUInt32();
            if ( band ) // One based so we need to subtract.
            {
               bandList.push_back( band - 1 );
            }
            ++i;
         }
      }
   }
} // End: ossimChipProcUtil::getBandList

getChip() [1/4]

ossimRefPtr< ossimImageData > ossimChipProcTool::getChip ( const ossimIrect &  img_rect )

virtual

The meat and potatos of this class.

Performs an execute on specified rect.

Reimplemented in ossimViewshedTool, ossimShorelineTool, and ossimHlzTool.

Definition at line 493 of file ossimChipProcTool.cpp.

References ossimImageChain::add(), ossimRefPtr< T >::get(), ossimImageChain::getTile(), m_aoiViewRect, m_cutRectFilter, m_geom, m_procChain, ossimRectangleCutFilter::OSSIM_RECTANGLE_NULL_OUTSIDE, ossimRectangleCutFilter::setCutType(), ossimImageGeometry::setImageSize(), ossimRectangleCutFilter::setRectangle(), ossimIrect::size(), and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimImageData> chip = 0;
   if(!m_procChain.valid())
      return chip;

   m_aoiViewRect = bounding_irect;
   m_geom->setImageSize( m_aoiViewRect.size() );

   // There should not be a chipper filter in the chain for getImage() calls since the chipping
   // is implied by the requested rect to getTile(), but if present, make sure it covers
   // the requested AOI to avoid masking out the tile.
   if (!m_cutRectFilter.valid())
   {
      m_cutRectFilter = new ossimRectangleCutFilter;
      m_cutRectFilter->setCutType( ossimRectangleCutFilter::OSSIM_RECTANGLE_NULL_OUTSIDE );
      m_procChain->add(m_cutRectFilter.get());
   }
   m_cutRectFilter->setRectangle( m_aoiViewRect );
   return m_procChain->getTile( m_aoiViewRect, 0 );
}

getChip() [2/4]

ossimRefPtr< ossimImageData > ossimChipProcTool::getChip ( const ossimGrect &  gnd_rect )

virtual

Definition at line 475 of file ossimChipProcTool.cpp.

References computeAdjustedViewFromGrect(), getChip(), ossimGrect::hasNans(), m_aoiGroundRect, m_aoiViewRect, m_geom, ossimNotify(), ossimNotifyLevel_INFO, and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimImageData> chip = 0;
   if (!m_geom.valid())
      return chip;

   // Set the new cut rectangle. Note that a NaN rect passed in implies the full AOI:
   if (!geo_bounding_grect.hasNans())
   {
      ossimNotify(ossimNotifyLevel_INFO) <<"\nossimChipProcUtil::getChip(grect) -- NaN rect "
            "provided. Using full AOI."<<endl;
      m_aoiGroundRect = geo_bounding_grect;
      computeAdjustedViewFromGrect();
   }

   return getChip(m_aoiViewRect);
}

getChip() [3/4]

ossimRefPtr< ossimImageData > ossimChipProcTool::getChip	(	const ossimDrect &	map_bounding_rect,
		const ossimDpt &	gsd
	)

Definition at line 452 of file ossimChipProcTool.cpp.

References ossimImageGeometry::getAsMapProjection(), getChip(), ossimMapProjection::inverse(), ossimDrect::lr(), m_aoiGroundRect, m_aoiViewRect, m_geom, ossimImageGeometry::setImageSize(), ossimMapProjection::setMetersPerPixel(), ossimIrect::size(), ossimDrect::ul(), ossimRefPtr< T >::valid(), and ossimImageGeometry::worldToLocal().

{
   ostringstream xmsg;
   if (!m_geom.valid())
      return 0;

   ossimMapProjection* proj = m_geom->getAsMapProjection();
   if (proj == 0)
      return 0;

   proj->setMetersPerPixel(gsd);
   ossimGpt ulGpt = proj->inverse(map_bounding_rect.ul());
   ossimGpt lrGpt = proj->inverse(map_bounding_rect.lr());
   m_aoiGroundRect = ossimGrect(ulGpt, lrGpt);
   ossimDrect view_rect;
   m_geom->worldToLocal(m_aoiGroundRect, view_rect);
   m_aoiViewRect = view_rect;
   m_geom->setImageSize( m_aoiViewRect.size() );

   return getChip(m_aoiViewRect);
}

getChip() [4/4]

ossimRefPtr< ossimImageData > ossimChipProcTool::getChip

(

)

Get chip method that assumes pre-initialized state.

Returns

ossimImageData object. This can be null/not-valid if not initialized.

Definition at line 515 of file ossimChipProcTool.cpp.

References ossimImageChain::getTile(), m_aoiViewRect, m_procChain, and ossimRefPtr< T >::valid().

Referenced by ossimHlzTool::execute(), and getChip().

{
   ossimRefPtr<ossimImageData> chip = 0;
   if(m_procChain.valid())
   {
      chip = m_procChain->getTile( m_aoiViewRect, 0 );
   }
   return chip;
}

getManager()

ossimListenerManager * ossimChipProcTool::getManager ( )

virtual

Reimplemented from ossimProcessInterface.

Definition at line 525 of file ossimChipProcTool.cpp.

{
   return this;
};

getObject() [1/2]

ossimObject * ossimChipProcTool::getObject ( )

virtual

Implements ossimProcessInterface.

Definition at line 530 of file ossimChipProcTool.cpp.

{
   return this;
}

getObject() [2/2]

const ossimObject * ossimChipProcTool::getObject ( ) const

virtual

Implements ossimProcessInterface.

Definition at line 535 of file ossimChipProcTool.cpp.

{
   return this;
}

getProductFilename()

const ossimFilename& ossimChipProcTool::getProductFilename ( ) const

inline

Definition at line 108 of file ossimChipProcTool.h.

Referenced by ossimToolServer::runCommand().

{ return m_productFilename; }

getProjectionOrigin()

bool ossimChipProcTool::getProjectionOrigin ( ossimGpt &  gpt )

protected

Reads the KWL for origin latitude and central meridian.

Parameters

gpt	Point to initialize. Set to 0 unless lat or lon specified in KWL

Returns

false if no items found in KWL.

Note

Throws ossimException on error.

Definition at line 1135 of file ossimChipProcTool.cpp.

References ossimKeywordNames::CENTRAL_MERIDIAN_KW, ossimKeywordlist::find(), ossimGpt::lat, ossimGpt::lon, m_geoScaled, ossimTool::m_kwl, ossimKeywordNames::ORIGIN_LATITUDE_KW, ossimString::size(), and ossimString::toFloat64().

Referenced by newUtmProjection().

{
   gpt = ossimGpt(0,0,0);
   bool found_spec = false;
   ossimString lookup = m_kwl.find(ossimKeywordNames::ORIGIN_LATITUDE_KW);
   if ( lookup.size() )
   {
      gpt.lat = lookup.toFloat64();
      if ( (gpt.lat < -90) || (gpt.lat > 90.0) )
      {
         std::string errMsg = "origin latitude range error! Valid range: -90 to 90";
         throw ossimException(errMsg);
      }
      m_geoScaled = true;
      found_spec = true;
   }

   lookup = m_kwl.find(ossimKeywordNames::CENTRAL_MERIDIAN_KW);
   if ( lookup.size() )
   {
      gpt.lon = lookup.toFloat64();
      if ( (gpt.lon < -180.0) || (gpt.lon > 180.0) )
      {
         std::string errMsg = "central meridian range error! Valid range: -180 to 180";
         throw ossimException(errMsg);
      }
      found_spec = true;
   }
   return found_spec;
}

initialize() [1/2]

bool ossimChipProcTool::initialize ( ossimArgumentParser &  ap )

virtual

Initial method to be ran prior to execute.

Intended for command-line app usage.

Parameters

ap	Arg parser to initialize from.

Returns

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

Note

Throws ossimException on error.

A throw with an error message of "usage" is used to get out when a usage is printed.

Reimplemented from ossimTool.

Reimplemented in ossimShorelineTool, ossimHdf5Tool, ossimHillshadeTool, ossimSubImageTool, ossimHlzTool, ossimViewshedTool, ossimOrthoTool, ossimSlopeTool, ossimPotraceTool, ossimBandMergeTool, and ossimRegTool.

Definition at line 97 of file ossimChipProcTool.cpp.

References ossimKeywordlist::addFile(), ossimKeywordlist::addPair(), ossimTool::initialize(), ossimTool::m_helpRequested, ossimTool::m_kwl, ossimNotify(), ossimNotifyLevel_NOTICE, ossimArgumentParser::read(), and ossimArgumentParser::writeErrorMessages().

Referenced by ossimBandMergeTool::initialize(), ossimRegTool::initialize(), ossimSlopeTool::initialize(), ossimOrthoTool::initialize(), ossimHlzTool::initialize(), ossimViewshedTool::initialize(), ossimHillshadeTool::initialize(), ossimHdf5Tool::initialize(), ossimShorelineTool::initialize(), and processRemainingArgs().

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

   std::string tempString1;
   ossimArgumentParser::ossimParameter stringParam1(tempString1);
   std::string tempString2;
   ossimArgumentParser::ossimParameter stringParam2(tempString2);
   std::string tempString3;
   ossimArgumentParser::ossimParameter stringParam3(tempString3);
   std::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("--load-options", stringParam1))
   {
      if (!m_kwl.addFile(tempString1.c_str()))
      {
         ap.writeErrorMessages(ossimNotify(ossimNotifyLevel_NOTICE));
         throw ossimException("Must supply an output file.");
      }
   }

   if ( ap.read("--aoi-geo-bbox", stringParam1, stringParam2, stringParam3, stringParam4))
   {
      ostringstream ostr;
      ostr<<tempString1<<" "<<tempString2<<" "<<tempString3<<" "<<tempString4<<ends;
      m_kwl.addPair( AOI_GEO_RECT_KW, ostr.str() );
   }

   if ( ap.read("--aoi-geo-center", stringParam1, stringParam2))
   {
      ostringstream ostr;
      ostr<<tempString1<<" "<<tempString2<<ends;
      m_kwl.addPair( AOI_GEO_CENTER_KW, ostr.str() );
   }

   if ( ap.read("--aoi-map-bbox", stringParam1, stringParam2, stringParam3, stringParam4))
   {
      ostringstream ostr;
      ostr<<tempString1<<" "<<tempString2<<" "<<tempString3<<" "<<tempString4<<ends;
      m_kwl.addPair( AOI_MAP_RECT_KW, ostr.str() );
   }

   if ( ap.read("--aoi-size-meters", stringParam1, stringParam2))
   {
      ostringstream ostr;
      ostr<<tempString1<<" "<<tempString2<<ends;
      m_kwl.addPair( AOI_SIZE_METERS_KW, ostr.str() );
   }

   if ( ap.read("--aoi-size-pixels", stringParam1, stringParam2))
   {
      ostringstream ostr;
      ostr<<tempString1<<" "<<tempString2<<ends;
      m_kwl.addPair( AOI_SIZE_PIXELS_KW, ostr.str() );
   }

   if (ap.read("-b", stringParam1) || ap.read("--bands", stringParam1))
      m_kwl.addPair( std::string(ossimKeywordNames::BANDS_KW), tempString1 );

   if( ap.read("--central-meridian", stringParam1) )
      m_kwl.addPair( std::string(ossimKeywordNames::CENTRAL_MERIDIAN_KW), tempString1 );

   if( ap.read("--color-table", stringParam1) || ap.read("--lut", stringParam1) )
      m_kwl.addPair( LUT_FILE_KW, tempString1 );

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

   if (ap.read("--dem", paramList))
   {
      ostringstream value;
      for(ossim_uint32 idx=0; idx<paramList.size(); ++idx)
      {
         ostringstream key;
         key<<ossimKeywordNames::ELEVATION_SOURCE_KW<<idx;
         m_kwl.addPair(key.str(), paramList[idx] );
      }
   }

   if( ap.read("--gsd", stringParam1) )
      m_kwl.addPair( GSD_KW, tempString1 );

   if ( ap.read("--hemisphere", stringParam1) )
      m_kwl.addPair( std::string(ossimKeywordNames::HEMISPHERE_KW), tempString1 );

   vector<ossimString> imageFnames;
   if (ap.read("--image", imageFnames) || ap.read("-i", imageFnames))
   {
      if (imageFnames.size() == 1)
         m_kwl.add(ossimKeywordNames::IMAGE_FILE_KW, imageFnames[0].chars() );
      else for(ossim_uint32 idx=0; idx<imageFnames.size(); ++idx)
      {
         ostringstream key;
         key<<ossimKeywordNames::IMAGE_FILE_KW<<idx;
         m_kwl.addPair(key.str(), imageFnames[idx] );
      }
   }

   if( ap.read("--origin-latitude", stringParam1) )
      m_kwl.addPair( std::string(ossimKeywordNames::ORIGIN_LATITUDE_KW), tempString1 );

   if(ap.read("--output-file", stringParam1) || ap.read("-o", stringParam1))
      m_kwl.addPair( ossimKeywordNames::OUTPUT_FILE_KW, tempString1 );

   if(ap.read("--output-radiometry", stringParam1))
      m_kwl.addPair( OUTPUT_RADIOMETRY_KW, tempString1 );

   if( ap.read("--projection", stringParam1) )
      m_kwl.addPair( std::string(ossimKeywordNames::PROJECTION_KW), tempString1 );

   while (ap.read("--reader-prop", stringParam1))
   {
      ostringstream key;
      key << READER_PROPERTY_KW << readerPropIdx;
      m_kwl.addPair(key.str(), tempString1 );
      ++readerPropIdx;
   }

   if ( ap.read("--snap-tie-to-origin") )
      m_kwl.addPair( SNAP_TIE_TO_ORIGIN_KW, TRUE_KW);

   if( ap.read("--srs", stringParam1) )
   {
      ossimString os = tempString1;
      if ( os.contains("EPSG:") )
         os.gsub( ossimString("EPSG:"), ossimString("") );
      m_kwl.addPair( SRS_KW, os.string() );
   }

   if( ap.read("--tile-size", stringParam1) )
      m_kwl.addPair( TILE_SIZE_KW, tempString1 );

   if( ap.read("-w", stringParam1) || ap.read("--writer", stringParam1) )
      m_kwl.addPair( WRITER_KW, tempString1);

   while (ap.read("--writer-prop", stringParam1))
   {
      ostringstream key;
      key << WRITER_PROPERTY_KW << writerPropIdx;
      m_kwl.addPair(key.str(), tempString1 );
      ++writerPropIdx;
   }

   if( ap.read("--zone", stringParam1) )
      m_kwl.addPair( std::string(ossimKeywordNames::ZONE_KW), tempString1);

   return true;
}

initialize() [2/2]

void ossimChipProcTool::initialize ( const ossimKeywordlist &  kwl )

virtual

This method is responsible for completely setting up the full processing chain according to the specifications given in the kwl passed in.

If the utility is run from a command line, the initialize(ossimArgumentParser) will assign the member master KWL and pass it to this method. Web service calls will fill a KWL and pass it.

This base class implementation should be called by the derived class implementation (assuming the derived class needs to pull some parameters out of the KWL before the chains are set up.

This method will instantiate the output projection and define the output bounding rect and product size in pixels. The processing chain (stored in m_procChain) will be completely initialized and ready for calls to getTile(). Then either getChip() or execute() can be called depending on usage to fetch product.

Note

Throws ossimException on error.

Reimplemented from ossimTool.

Reimplemented in ossimHdf5Tool, ossimSubImageTool, ossimShorelineTool, ossimOrthoTool, ossimSlopeTool, ossimViewshedTool, ossimHlzTool, ossimPotraceTool, ossimBandMergeTool, and ossimRegTool.

Definition at line 321 of file ossimChipProcTool.cpp.

References ossimKeywordlist::addList(), ossimKeywordlist::clear(), ossimKeywordlist::findKey(), ossimScalarTypeLut::instance(), ossimTool::m_helpRequested, ossimTool::m_kwl, and m_productScalarType.

{
   m_helpRequested = false;

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

   // Assign some members from KWL:
   m_productScalarType = ossimScalarTypeLut::instance()->
         getScalarTypeFromString( m_kwl.findKey( OUTPUT_RADIOMETRY_KW ) );

   m_productFilename = m_kwl.findKey( std::string(ossimKeywordNames::OUTPUT_FILE_KW) );

   // Create chains for input sources.
   loadImageFiles();

   // Load any specified DEMs:
   loadDemFiles();

   // Initialize projection and propagate to chains.
   createOutputProjection();

   // Pass control to derived class so it can add its specific processing to the chain(s). This
   // should return an initialized m_procChain.
   initProcessingChain();
   finalizeChain();
}

initializeAOI()

void ossimChipProcTool::initializeAOI ( )

protectedvirtual

Initializes m_aoiViewRect with the output area of interest as specified in master KWL.

Initialization will either come from user defined cut options or the source bounding rect with user options taking precidence.

Note

Throws ossimException on error.

Reimplemented in ossimViewshedTool.

Definition at line 931 of file ossimChipProcTool.cpp.

References ossimKeywordlist::hasKey(), m_aoiGroundRect, m_aoiViewRect, ossimTool::m_kwl, ossimGrect::makeNan(), and ossimIrect::makeNan().

Referenced by ossimViewshedTool::initializeAOI().

{
   // Nan rect for starters.
   m_aoiViewRect.makeNan();
   m_aoiGroundRect.makeNan();
   ossimString lookup;

   // Image size:
   ossimIpt imageSize(0,0);
   if (m_kwl.hasKey(AOI_SIZE_PIXELS_KW))
   {
      lookup = m_kwl.findKey( AOI_SIZE_PIXELS_KW );
      lookup.trim();
      imageSize.x = lookup.before(" ").toUInt32();
      imageSize.y = lookup.after(" ").toUInt32();
   }

   // The AOI rect can be specified in different ways:
   if ( m_kwl.hasKey( AOI_GEO_CENTER_KW.c_str() ) )
   {
      // A center point was given:
      ossimGpt centerGpt;
      findCenterGpt(centerGpt);

      // A center point spec can be accompanied by a width/height (in meters or pixels):
      ossimDpt sizeMeters;
      sizeMeters.makeNan();
      if (m_kwl.hasKey(AOI_SIZE_METERS_KW))
      {
         lookup = m_kwl.findKey( AOI_SIZE_METERS_KW );
         lookup.trim();
         sizeMeters.x = lookup.before(" ").toDouble();
         sizeMeters.y = lookup.after(" ").toDouble();
      }
      else if (m_kwl.hasKey(AOI_SIZE_PIXELS_KW))
      {
         if ( (imageSize.x > 0)&& (imageSize.y > 0 ) )
         {
            sizeMeters.x = imageSize.x*m_gsd.x;
            sizeMeters.y = imageSize.y*m_gsd.y;
         }
      }
      if (!sizeMeters.hasNans())
      {
         ossimDpt metersPerDegree (centerGpt.metersPerDegree());
         double dlat = sizeMeters.y/metersPerDegree.y/2.0;
         double dlon = sizeMeters.x/metersPerDegree.x/2.0;
         ossimGpt ulgpt (centerGpt.lat + dlat, centerGpt.lon - dlon);
         ossimGpt lrgpt (centerGpt.lat - dlat, centerGpt.lon + dlon);
         m_aoiGroundRect = ossimGrect(ulgpt, lrgpt);
         sizeMeters.x = imageSize.x*m_gsd.x;
         sizeMeters.y = imageSize.y*m_gsd.y;
      }
      if (!sizeMeters.hasNans())
      {
         ossimDpt metersPerDegree (centerGpt.metersPerDegree());
         double dlat = sizeMeters.y/metersPerDegree.y/2.0;
         double dlon = sizeMeters.x/metersPerDegree.x/2.0;
         ossimGpt ulgpt (centerGpt.lat + dlat, centerGpt.lon - dlon);
         ossimGpt lrgpt (centerGpt.lat - dlat, centerGpt.lon + dlon);
         m_aoiGroundRect = ossimGrect(ulgpt, lrgpt);
         m_needCutRect = true;
      }
   }

   else if ( m_kwl.hasKey( AOI_GEO_RECT_KW ) )
   {
      ossimString lookup = m_kwl.findKey(AOI_GEO_RECT_KW);
      lookup.trim();
      vector<ossimString> substrings = lookup.split(" ");
      if (substrings.size() != 4)
      {
         ostringstream errMsg;
         errMsg << "ossimChipProcUtil ["<<__LINE__<<"] Incorrect number of values specified for "
               "aoi_geo_rect!";
         throw( ossimException(errMsg.str()) );
      }
      ossim_float64 minLatF = substrings[0].toFloat64();
      ossim_float64 minLonF = substrings[1].toFloat64();
      ossim_float64 maxLatF = substrings[2].toFloat64();
      ossim_float64 maxLonF = substrings[3].toFloat64();

      // Check for swap so we don't get a negative height.
      // Note no swap check for longitude as box could cross date line.
      if ( minLatF > maxLatF )
      {
         ossim_float64 tmpF = minLatF;
         minLatF = maxLatF;
         maxLatF = tmpF;
      }

      // Assume cut box is edge to edge or "Pixel Is Area". Our
      // AOI(area of interest) uses center of pixel or "Pixel Is Point"
      // so get the degrees per pixel and shift AOI to center.
      ossimGpt ulgpt (maxLatF, minLonF);
      ossimGpt lrgpt (minLatF , maxLonF);
      m_aoiGroundRect = ossimGrect(ulgpt, lrgpt);
      m_needCutRect = true;

      if ( (imageSize.x > 0) && (imageSize.y > 0) )
      {
         ossimRefPtr<ossimMapProjection> mapProj =
            dynamic_cast<ossimMapProjection*>(m_geom->getProjection());
         if (mapProj.valid())
         {
            ossimDpt gsd;
            gsd.x = std::fabs( maxLonF - minLonF ) / imageSize.x;
            gsd.y = std::fabs( maxLatF - minLatF ) / imageSize.y;
            mapProj->setDecimalDegreesPerPixel(gsd);
         }
      }
   }

   else if ( m_kwl.hasKey( AOI_MAP_RECT_KW ) )
   {
      ossimRefPtr<ossimMapProjection> mapProj =
            dynamic_cast<ossimMapProjection*>(m_geom->getProjection());
      if (mapProj.valid())
      {
         ossimString lookup = m_kwl.findKey(AOI_MAP_RECT_KW);
         lookup.trim();
         vector<ossimString> substrings = lookup.split(", ", true);
         if (substrings.size() != 4)
         {
            ostringstream errMsg;
            errMsg << "ossimChipProcUtil ["<<__LINE__<<"] Incorrect number of values specified for "
                  "aoi_geo_rect!";
            throw( ossimException(errMsg.str()) );
         }
         ossim_float64 minX = substrings[0].toFloat64();
         ossim_float64 minY = substrings[1].toFloat64();
         ossim_float64 maxX = substrings[2].toFloat64();
         ossim_float64 maxY = substrings[3].toFloat64();

         // Check for swap so we don't get a negative height.
         // Note no swap check for longitude as box could cross date line.
         if ( minX > maxX )
         {
            ossim_float64 tmpF = minX;
            minX = maxX;
            maxX = tmpF;
         }
         if ( minY > maxY )
         {
            ossim_float64 tmpF = minY;
            minY = maxY;
            maxY = tmpF;
         }

         ossimDpt ulMap (minX, maxY);
         ossimDpt lrMap (maxX , minY);
         ossimGpt ulGeo = mapProj->inverse(ulMap);
         ossimGpt lrGeo = mapProj->inverse(lrMap);
         m_aoiGroundRect = ossimGrect(ulGeo, lrGeo);
         m_needCutRect = true;

         if ( (imageSize.x > 0) && (imageSize.y > 0) )
         {
            ossimRefPtr<ossimMapProjection> mapProj =
               dynamic_cast<ossimMapProjection*>(m_geom->getProjection());
            if (mapProj.valid())
            {
               ossimDpt gsd;
               gsd.x = std::fabs( maxX - minX ) / imageSize.x;
               gsd.y = std::fabs( maxY - minY ) / imageSize.y;
               mapProj->setMetersPerPixel(gsd);
            }
         }
      }
   }

   // If no user defined rect set to scene bounding rect.
   if ( m_aoiGroundRect.hasNans() )
      setAoiToInputs();

   // If AOI established, we can set projection TP and origin if applicable:
   ossimRefPtr<ossimMapProjection> mapProj =
         dynamic_cast<ossimMapProjection*>(m_geom->getProjection());
   if (!m_aoiGroundRect.hasNans() && mapProj.valid())
   {
      // Geo-scaled projection needs to know the reference latitude:
      if (m_geoScaled)
      {
         // The origin may have ben explicitely specified,or just use midpoint of AOI:
         ossimGpt origin;
         if (!getProjectionOrigin(origin))
            origin = m_aoiGroundRect.midPoint();
         mapProj->setOrigin(origin);
         m_geom->getMetersPerPixel(m_gsd);
      }

      // Set the tie-point of the projection to the AOI's UL.
      // Adjust it to be on an even pixel distance from projection origin if desired:
      mapProj->setUlTiePoints(m_aoiGroundRect.ul());
      bool snapToTP = false;
      m_kwl.getBoolKeywordValue(snapToTP, SNAP_TIE_TO_ORIGIN_KW.c_str());
      if ( snapToTP )
         mapProj->snapTiePointToOrigin();

      // Re-establish the AOI view rect based on updated projection:
      computeAdjustedViewFromGrect();
   }
}

initializeProjectionGsd()

void ossimChipProcTool::initializeProjectionGsd ( )

protectedvirtual

Initializes the projection gsd.

This loops through all chains to find the minimum gsd.

Note

Throws ossimException on error.

Reimplemented in ossimViewshedTool.

Definition at line 856 of file ossimChipProcTool.cpp.

References ossimKeywordlist::findKey(), ossimImageGeometry::getProjection(), m_geom, and ossimTool::m_kwl.

Referenced by ossimViewshedTool::initializeProjectionGsd().

{
   // The GSD computation may be a chicken-and-egg problem. Need to try different methods depending
   // on information available in KWL including specified input images and DEMs.

   ossimRefPtr<ossimMapProjection> mapProj =
         dynamic_cast<ossimMapProjection*>(m_geom->getProjection());

   ossimString lookup = m_kwl.findKey( GSD_KW );
   if ( lookup.size() )
      m_gsd.y = m_gsd.x = lookup.toFloat64();

   if (m_gsd.hasNans() && m_projIsIdentity && m_geom.valid())
         m_geom->getMetersPerPixel(m_gsd);

   if (m_gsd.hasNans())
   {
      // No GSD specified, use minimum among all input images:
      ossimGpt chainTiePoint;
      std::vector< ossimRefPtr<ossimSingleImageChain> >::iterator chainIdx = m_imgLayers.begin();
      while ( chainIdx != m_imgLayers.end() )
      {
         ossimRefPtr<ossimImageGeometry> geom =  (*chainIdx)->getImageGeometry();
         if (geom.valid())
         {
            ossimDpt gsd;
            geom->getMetersPerPixel(gsd);
            gsd.y = gsd.x = gsd.mean();
            if (m_gsd.hasNans() ||  ( m_gsd.x > gsd.x))
               m_gsd = gsd;
         }
         ++chainIdx;
      }
   }

   if (m_gsd.hasNans())
   {
      // Still no GSD established, try using minimum among all input DEMs (the operation possibly
      // involves DEMs as inputs):
      std::vector<ossimFilename>::iterator demFile = m_demSources.begin();
      while ( demFile != m_demSources.end() )
      {
         ossimImageGeometry geom;
         if (geom.open(*demFile))
         {
            ossimDpt gsd;
            geom.getMetersPerPixel(gsd);
            gsd.y = gsd.x = gsd.mean();
            if (m_gsd.hasNans() ||  ( m_gsd.x > gsd.x))
               m_gsd = gsd;
         }
         ++demFile;
      }
   }

   if (m_gsd.hasNans())
   {
      // Still no GSD specified. As a last resort, use the elevation database nominal GSD at center
      // as output GSD. This is valid since most operations without input images depend on DEM data.
      // Requires that the center point be given in input spec:
      ossimGpt centerGpt;
      findCenterGpt(centerGpt);
      if (!centerGpt.hasNans())
      {
         ossimElevManager::instance()->getHeightAboveEllipsoid(centerGpt);
         m_gsd.y = m_gsd.x = ossimElevManager::instance()->getMeanSpacingMeters();
         if (m_gsd.x == 0) // getMeanSpacing unfortunately return 0 for unknown GSD
            m_gsd.makeNan();
      }
   }

   if (!m_gsd.hasNans())
      mapProj->setMetersPerPixel(m_gsd);
}

initProcessingChain()

virtual void ossimChipProcTool::initProcessingChain ( )

protectedpure virtual

Derived classes initialize their custom chains here.

Implemented in ossimViewshedTool, ossimSubImageTool, ossimHlzTool, ossimHdf5Tool, ossimShorelineTool, ossimOrthoTool, ossimSlopeTool, ossimHillshadeTool, ossimPotraceTool, ossimBandMergeTool, and ossimRegTool.

isChipProcessor()

virtual bool ossimChipProcTool::isChipProcessor ( ) const

inlinevirtual

Overrides base class implementation to indicate this class supports getChip() calls.

Can be done with dunamic cast and pointer test, but not sure how that is supported in SWIG (OLK 11/2015).

Reimplemented from ossimTool.

Definition at line 90 of file ossimChipProcTool.h.

{ return true; }

loadDemFiles()

void ossimChipProcTool::loadDemFiles ( )

protectedvirtual

Loads all DEM files specified in master KWL into the elev manager's database.

Definition at line 648 of file ossimChipProcTool.cpp.

References ossimKeywordNames::ELEVATION_SOURCE_KW, ossimString::empty(), ossimKeywordlist::findKey(), ossimElevManager::instance(), ossimFilename::isReadable(), ossimElevManager::loadElevationPath(), m_demSources, ossimTool::m_kwl, and ossimKeywordlist::numberOf().

{
   ossim_uint32 numDems = m_kwl.numberOf( ossimKeywordNames::ELEVATION_SOURCE_KW );
   if (numDems == 0)
      return;

   cout<<m_kwl<<endl;//TODO:REMOVE
   ossim_uint32 count = numDems;
   for (ossim_uint32 i=0; count > 0; ++i)
   {
      ossimFilename f;
      if (numDems == 1)
      {
         ostringstream key;
         key <<  ossimKeywordNames::ELEVATION_SOURCE_KW; // Try non-indexed first
         f = m_kwl.findKey( key.str() );
      }
      if (f.empty())
      {
         ostringstream key;
         key <<  ossimKeywordNames::ELEVATION_SOURCE_KW << i ;
         cout<<key.str()<<endl;//TODO:REMOVE
         f = m_kwl.findKey( key.str() );
      }
      if ( f.empty() )
         continue;

      if (!f.isReadable())
      {
         ostringstream errMsg;
         errMsg << "ossimChipProcUtil ["<<__LINE__<<"] Could not open DEM file: <" << f << ">";
         throw ossimException(errMsg.str());
      }

      m_demSources.push_back(f);
      ossimElevManager::instance()->loadElevationPath(f, true);
      --count;
   }
}

loadImageFiles()

void ossimChipProcTool::loadImageFiles ( )

protectedvirtual

Creates chains for image entries associated with specified keyword.

This is usually the input image sources but could also be used for reading list of color sources.

Note

Throws ossimException on error.

Reimplemented in ossimHdf5Tool.

Definition at line 540 of file ossimChipProcTool.cpp.

References createInputChain(), ossimString::empty(), ossimKeywordNames::ENTRY_KW, ossimKeywordlist::find(), ossimKeywordlist::findKey(), getBandList(), ossimKeywordNames::IMAGE_FILE_KW, m_imgLayers, ossimTool::m_kwl, ossimKeywordlist::numberOf(), ossimSingleImageChain::setBandSelection(), ossimString::toUInt32(), and ossimRefPtr< T >::valid().

{
   ossim_uint32 numImages = m_kwl.numberOf( ossimKeywordNames::IMAGE_FILE_KW );
   ossim_uint32 count = numImages;
   ossim_uint32 entryIndex = 0;

   // Returns 0 if no entry found. This is default anyway.
   ossim_uint32 globalEntryValue = ossimString(m_kwl.find(ossimKeywordNames::ENTRY_KW)).toUInt32();

   for (ossim_uint32 i=0; count > 0; ++i)
   {
      ossimFilename f;
      if (numImages == 1)
      {
         ostringstream key;
         key <<  ossimKeywordNames::IMAGE_FILE_KW; // Try non-indexed first
         f = m_kwl.findKey( key.str() );
      }
      if (f.empty())
      {
         ostringstream key;
         key <<  ossimKeywordNames::IMAGE_FILE_KW << i ;
         f = m_kwl.findKey( key.str() );
      }
      if ( f.empty() )
         continue;

      // Look for the entry key, e.g. image_source0.entry: 10
      ostringstream entryKey;
      entryKey <<  ossimKeywordNames::IMAGE_FILE_KW << i << "." << ossimKeywordNames::ENTRY_KW;
      ossimString os = m_kwl.findKey(entryKey.str());
      if (!os.empty())
         entryIndex = os.toUInt32();
      else
         entryIndex = globalEntryValue;

      // Add it:
      ossimRefPtr<ossimSingleImageChain> ic = createInputChain(f, entryIndex);
      if (!ic.valid())
      {
         ostringstream errMsg;
         errMsg<<"ERROR: ossimChipProcUtil ["<<__LINE__<<"] Could not open <"<<f<<">"<<ends;
         throw ossimException(errMsg.str());
      }

      // Need a band selector?
      std::vector<ossim_uint32> bandList(0);
      getBandList(i, bandList );
      if ( bandList.size() )
         ic->setBandSelection( bandList );

      m_imgLayers.push_back(ic);
      --count;
   }
}

mosaicDemSources()

ossimRefPtr< ossimImageSource > ossimChipProcTool::mosaicDemSources ( )

protected

Some utilities need to work on DEMs as images.

This method determines which DEMs cover the AOI and creates an image mosaic with the DEMS serving as pixel sources. Throws exceptions.

Definition at line 1384 of file ossimChipProcTool.cpp.

References createInputChain(), ossimRefPtr< T >::get(), ossimElevManager::getCellsForBounds(), ossimSingleImageChain::getImageHandler(), ossimSingleImageChain::getImageRenderer(), ossimElevManager::instance(), m_aoiGroundRect, m_demSources, m_geom, and ossimRefPtr< T >::valid().

Referenced by ossimHillshadeTool::initProcessingChain(), and ossimHlzTool::initProcessingChain().

{
   ostringstream xmsg;
   ossimRefPtr<ossimImageSource> demMosaic = 0;

   if (m_demSources.empty())
   {
      // Establish connection to DEM posts directly as raster "images" versus using the OSSIM elev
      // manager that performs interpolation of DEM posts for arbitrary locations. These elev images
      // feed into a combiner in order to have a common tap for elev pixels:
      ossimElevManager* elevMgr = ossimElevManager::instance();
      elevMgr->getCellsForBounds(m_aoiGroundRect, m_demSources);
   }

   // Open a raster image for each elevation source being considered:
   ossimConnectableObject::ConnectableObjectList elevChains;
   vector<ossimFilename>::iterator fname_iter = m_demSources.begin();
   while (fname_iter != m_demSources.end())
   {
      ossimRefPtr<ossimSingleImageChain> chain = createInputChain(*fname_iter).get();
      if (!chain.valid() || !chain->getImageRenderer().valid() )
      {
         xmsg<<"ossimChipProcUtil:"<<__LINE__<<"  Cannot open DEM file at <"<<*fname_iter<<">";
         throw(xmsg.str());
      }

      // Set up the input chain with proper renderer IVT:
      ossimRefPtr<ossimImageViewProjectionTransform> ivt = new ossimImageViewProjectionTransform
            (chain->getImageHandler()->getImageGeometry().get(), m_geom.get());
      chain->getImageRenderer()->setImageViewTransform(ivt.get());
      ossimRefPtr<ossimConnectableObject> connectable = chain.get();
      elevChains.push_back(connectable);
      ++fname_iter;
   }

   if (elevChains.size() == 1)
      demMosaic = (ossimImageSource*) elevChains[0].get();
   else
      demMosaic = new ossimImageMosaic(elevChains);

   return demMosaic;
}

newIdentityProjection()

ossimRefPtr< ossimMapProjection > ossimChipProcTool::newIdentityProjection ( )

protected

Sets the single image chain for identity operations view to a ossimImageViewAffineTransform.

This will have a rotation if up is up is selected. Also set m_outputProjection to the input's for area of interest.

Definition at line 751 of file ossimChipProcTool.cpp.

References ossimProjection::dup(), ossimRefPtr< T >::get(), ossimUtmProjection::getHemisphere(), ossimImageHandler::getImageGeometry(), ossimSingleImageChain::getImageHandler(), ossimImageGeometry::getProjection(), ossimUtmProjection::getZone(), m_demSources, m_imgLayers, m_projIsIdentity, ossimImageGeometry::open(), ossimUtmProjection::setHemisphere(), ossimUtmProjection::setZone(), and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimSingleImageChain> sic = 0;
   ossimProjection* input_proj = 0;
   ossimRefPtr<ossimMapProjection> output_proj = 0;
   ossimRefPtr<ossimImageRenderer> resampler = 0;

   if ( m_imgLayers.size() )
   {
      sic = m_imgLayers[0];
      if (sic.valid())
      {
         ossimRefPtr<ossimImageHandler>  ih = sic->getImageHandler();
         if (ih.valid())
         {
            ossimRefPtr<ossimImageGeometry> geom = ih->getImageGeometry();
            if (geom.valid())
            {
               input_proj = geom->getProjection();

               // Check if input is UTM, need to copy zone and hemisphere if so:
               ossimUtmProjection* input_utm = dynamic_cast<ossimUtmProjection*>(input_proj);
               if ( input_utm )
               {
                  ossimRefPtr<ossimUtmProjection> output_utm = new ossimUtmProjection;
                  output_utm->setZone(input_utm->getZone());
                  output_utm->setHemisphere(input_utm->getHemisphere());
                  output_proj = output_utm.get();
               }
               else
               {
                  input_proj = dynamic_cast<ossimMapProjection*>( geom->getProjection() );
                  if (input_proj)
                  {
                     output_proj = (ossimMapProjection*) input_proj->dup();
                     m_projIsIdentity = true;
                  }
               }
            }
         }
      }
   }

   // try input dem "image" if specified:
   if (!output_proj.valid() && (m_demSources.size()))
   {
      ossimImageGeometry geom;
      if (geom.open(m_demSources[0]))
      {
         input_proj = dynamic_cast<ossimMapProjection*>(geom.getProjection());
         if (input_proj)
         {
            output_proj = (ossimMapProjection*) input_proj->dup();
            m_projIsIdentity = true;
         }
      }
   }

   return output_proj;
}

newUtmProjection()

ossimRefPtr< ossimMapProjection > ossimChipProcTool::newUtmProjection ( )

protected

Convenience method to get a utm projection.

Returns

new ossimUtmProjection.

Definition at line 812 of file ossimChipProcTool.cpp.

References ossimKeywordlist::findKey(), ossimRefPtr< T >::get(), getProjectionOrigin(), ossimKeywordNames::HEMISPHERE_KW, ossimTool::m_kwl, ossimUtmProjection::setHemisphere(), ossimUtmProjection::setZone(), ossimString::size(), ossimString::string(), ossimString::toUInt32(), ossimString::upcase(), and ossimKeywordNames::ZONE_KW.

{
   // Make projection:
   ossimRefPtr<ossimUtmProjection> utm = new ossimUtmProjection;

   // Set the zone from keyword option:
   bool setZone = false;
   ossim_int32 zone = 0;
   std::string value = m_kwl.findKey( std::string( ossimKeywordNames::ZONE_KW ) );
   if ( value.size() )
      zone = ossimString(value).toUInt32();
   if ( (zone > 0 ) && ( zone < 61 ) )
   {
      utm->setZone( zone );
      setZone = true;
   }

   // Set the hemisphere from keyword option:
   bool setHemisphere = false;
   ossimString h = m_kwl.findKey( std::string( ossimKeywordNames::HEMISPHERE_KW ) );
   if ( h.size() )
   {
      h.upcase();
      if ( ( h == "N" ) || ( h == "NORTH" ) || ( h == "S" ) || ( h == "SOUTH" ) )
      {
         utm->setHemisphere( h.string()[0] );
         setHemisphere = true;
      }
   }

   if ( !setZone || !setHemisphere )
   {
      // Check for user set "central_meridian" and "origin_latitude":
      ossimGpt origin;
      getProjectionOrigin(origin);
      if ( !setZone )
         utm->setZone(origin);
      if ( !setHemisphere )
         utm->setHemisphere(origin);
   }

   return ossimRefPtr<ossimMapProjection>(utm.get());
}

newWriter()

ossimRefPtr< ossimImageFileWriter > ossimChipProcTool::newWriter ( )

protected

Creates a new writer.

This will use the writer option (-w or –writer), if present; else, it will be derived from the output file extention. This will also set any writer properties passed in.

Returns

new ossimImageFileWriter.

Note

Throws ossimException on error.

Definition at line 1450 of file ossimChipProcTool.cpp.

References ossimKeywordlist::findKey(), and ossimTool::m_kwl.

Referenced by execute().

{
   ossimRefPtr<ossimImageFileWriter> writer = 0;

   ossimString lookup = m_kwl.findKey( WRITER_KW );
   if ( lookup.size() )
   {
      writer = ossimImageWriterFactoryRegistry::instance()->createWriter( lookup );
      if ( !writer.valid() )
      {
         ostringstream errMsg;
         errMsg << "ossimChipProcUtil ["<<__LINE__<<"] ERROR creating writer for <"<<lookup<<">"
               <<ends;
         throw ossimException(errMsg.str());
      }
   }
   else // Create from output file extension.
   {
      writer = ossimImageWriterFactoryRegistry::instance()->
            createWriterFromExtension( m_productFilename.ext() );

      if ( !writer.valid() )
      {
         ostringstream errMsg;
         errMsg << "ossimChipProcUtil ["<<__LINE__<<"] ERROR creating writer from extension <"
               <<m_productFilename.ext()<<">"<<ends;
         throw ossimException(errMsg.str());
      }
   }

   // Set the output name.
   writer->setFilename( m_productFilename );

   // Add any writer props.
   ossim_uint32 count = m_kwl.numberOf( WRITER_PROPERTY_KW.c_str() );
   for (ossim_uint32 i = 0; i < count; ++i)
   {
      ossimString key = WRITER_PROPERTY_KW;
      key += ossimString::toString(i);
      lookup = m_kwl.findKey( key.string() );
      if ( lookup.size() )
      {
         std::vector<ossimString> splitArray;
         lookup.split(splitArray, "=");
         if(splitArray.size() == 2)
         {
            ossimRefPtr<ossimProperty> prop =
                  new ossimStringProperty(splitArray[0], splitArray[1]);

            writer->setProperty( prop );
         }
      }
   }

   // Output tile size:
   lookup = m_kwl.findKey( TILE_SIZE_KW );
   if ( lookup.size() )
   {
      ossimIpt tileSize;
      tileSize.x = lookup.toInt32();
      if ( (tileSize.x % 16) == 0 )
      {
         tileSize.y = tileSize.x;
         writer->setTileSize( tileSize );
      }
   }

   return writer;
}

operator=()

const ossimChipProcTool& ossimChipProcTool::operator= ( const ossimChipProcTool &  )

inlineprotected

Hidden from use assignment operator.

Definition at line 207 of file ossimChipProcTool.h.

{ return *this; }

processRemainingArgs()

void ossimChipProcTool::processRemainingArgs ( ossimArgumentParser &  ap )

protected

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).

Note

Throws ossimException on error.

Definition at line 259 of file ossimChipProcTool.cpp.

References ossimKeywordlist::add(), ossimArgumentParser::argc(), ossimString::chars(), ossimArgumentParser::errors(), ossimKeywordlist::find(), ossimTool::getClassName(), ossimKeywordNames::IMAGE_FILE_KW, initialize(), ossimTool::m_kwl, ossimNotify(), ossimNotifyLevel_NOTICE, ossimKeywordNames::OUTPUT_FILE_KW, ossimArgumentParser::read(), ossimArgumentParser::reportRemainingOptionsAsUnrecognized(), ossimFilename::setExtension(), ossimKeywordlist::write(), and ossimArgumentParser::writeErrorMessages().

Referenced by ossimSlopeTool::initialize(), and ossimSubImageTool::initialize().

{
   // ossim_uint32 inputIdx = 0;

   bool dumpKwl = false;
   if ( ap.read("--dump-options") )
      dumpKwl = true;

   if ( ap.argc() >= 2 )
   {
      // Output file is last arg:
      m_kwl.add( ossimKeywordNames::OUTPUT_FILE_KW, ap[ap.argc()-1]);
   }
   else
   {
      if ( !m_kwl.find(ossimKeywordNames::OUTPUT_FILE_KW) )
      {
         ap.writeErrorMessages(ossimNotify(ossimNotifyLevel_NOTICE));
         throw ossimException("Must supply an output file.");
      }
   }

   if ( ap.argc() > 2 ) // User passed inputs in front of output file.
   {
      int pos = 1; // ap.argv[0] is application name. 
      int idx = 0;
      while ( pos < (ap.argc()-1) )
      {
         ostringstream key;
         key<<ossimKeywordNames::IMAGE_FILE_KW<<idx;
         m_kwl.add( key.str().c_str(), ap[pos] );

         ++pos; // Go to next arg...

      } // End: while ( pos < (ap.argc()-1) )

   } // End: if ( ap.argc() > 2 )

   // End of arg parsing.
   ap.reportRemainingOptionsAsUnrecognized();
   if ( ap.errors() )
   {
      ap.writeErrorMessages(ossimNotify(ossimNotifyLevel_NOTICE));
      throw ossimException("Unknown option...");
   }

   if (dumpKwl)
   {
      ossimFilename f = getClassName();
      f.setExtension("kwl");
      if (!m_kwl.write(f.chars()))
      {
         ostringstream xmsg;
         xmsg<<"ossimChipProcUtil:"<<__LINE__<<" Error encountered writing options file to <"<<f<<">";
         throw ossimException(xmsg.str());
      }
      ossimNotify(ossimNotifyLevel_NOTICE)<<"\nWrote options file to <"<<f<<">"<<endl;
   }

   initialize(m_kwl);
}

propagateGeometryToChains()

void ossimChipProcTool::propagateGeometryToChains ( )

protected

Loops through all chains and sets the output projection.

Note

Throws ossimException on error.

Definition at line 1300 of file ossimChipProcTool.cpp.

References ossimRefPtr< T >::get(), m_geom, m_imgLayers, ossimConnectableObject::propagateEventToOutputs(), ossimImageRenderer::setView(), and ossimRefPtr< T >::valid().

{
   // we need to make sure the outputs are refreshed so they can reset themselves
   // Needed when we are doing interactive update to the GSD and clip window
   ossimRefPtr<ossimRefreshEvent> refreshEvent = new ossimRefreshEvent();
   ossimEventVisitor eventVisitor(refreshEvent.get());
   ossimViewInterfaceVisitor viewVisitor(m_geom.get());

   std::vector< ossimRefPtr<ossimSingleImageChain> >::iterator chainIdx = m_imgLayers.begin();
   while ( chainIdx != m_imgLayers.end() )
   {
      viewVisitor.reset();
      eventVisitor.reset();
      (*chainIdx)->accept(viewVisitor);
      (*chainIdx)->accept(eventVisitor);
      ossimRefPtr<ossimImageRenderer> resampler = (*chainIdx)->getImageRenderer();
      if (resampler.valid())
      {
         resampler->setView( m_geom.get() );
         resampler->propagateEventToOutputs(*refreshEvent);
      }
      ++chainIdx;
   }
}

setAoiToInputs()

void ossimChipProcTool::setAoiToInputs ( )

protected

Assigns the AOI to be the bounding rect of the union of all inputs.

Definition at line 1209 of file ossimChipProcTool.cpp.

References ossimGrect::clipToRect(), ossimGrect::expandToInclude(), ossimImageGeometry::getBoundingGroundRect(), ossimGrect::hasNans(), m_aoiGroundRect, m_demSources, m_imgLayers, ossimGrect::makeNan(), ossimImageGeometry::open(), ossimNotify(), ossimNotifyLevel_WARN, and ossimRefPtr< T >::valid().

{
   ossimRefPtr<ossimImageGeometry> geom;
   ossimGrect bbox_i;
   m_aoiGroundRect.makeNan();

   //  Assign the AOI to be the bounding rect of the union of all inputs. Start with image inputs:
   std::vector< ossimRefPtr<ossimSingleImageChain> >::iterator chain = m_imgLayers.begin();
   while (chain != m_imgLayers.end())
   {
      geom = (*chain)->getImageGeometry();
      if (geom.valid())
      {
          geom->getBoundingGroundRect(bbox_i);
          if (!bbox_i.hasNans())
          {
             if (m_aoiGroundRect.hasNans())
                m_aoiGroundRect = bbox_i;
             else
                m_aoiGroundRect.expandToInclude(bbox_i);
          }
      }
      ++chain;
   }

   // Now determine DEM inputs coverage:
   ossimGrect bbox_dems;
   bbox_dems.makeNan();
   std::vector<ossimFilename>::iterator dem_file = m_demSources.begin();
   while (dem_file != m_demSources.end())
   {
      ossimRefPtr<ossimImageGeometry> geom = new ossimImageGeometry;
      if (!geom->open(*dem_file))
      {
         ossimNotify(ossimNotifyLevel_WARN)
                  << "ossimHLZUtil::initialize ERR: Cannot open DEM file <" << *dem_file << "> "
                  "as image handler. Ignoring entry for bounding box computation.\n" << std::endl;
      }
      geom->getBoundingGroundRect(bbox_i);
      if (!bbox_i.hasNans())
      {
         if (bbox_dems.hasNans())
            bbox_dems = bbox_i;
         else
            bbox_dems.expandToInclude(bbox_i);
      }
      ++dem_file;
   }

   // Finally compute the AOI as the intersection of the image and DEM inputs:
   if (m_aoiGroundRect.hasNans())
      m_aoiGroundRect = bbox_dems;
   else if (!bbox_dems.hasNans())
      m_aoiGroundRect = m_aoiGroundRect.clipToRect(bbox_dems);
}

setReaderProps()

void ossimChipProcTool::setReaderProps ( ossimImageHandler *  ih ) const

protected

Passes reader properties to single image handler if any.

Parameters

ih	Image handler to set properties on.

Definition at line 1325 of file ossimChipProcTool.cpp.

References ossimTool::m_kwl, and ossimKeywordlist::numberOf().

Referenced by createInputChain().

{
   if ( ih )
   {
      ossim_uint32 count = m_kwl.numberOf( READER_PROPERTY_KW.c_str() );
      for (ossim_uint32 i = 0; i < count; ++i)
      {
         ossimString key = READER_PROPERTY_KW;
         key += ossimString::toString(i);
         ossimString value = m_kwl.findKey( key.string() );
         if ( value.size() )
         {
            std::vector<ossimString> splitArray;
            value.split(splitArray, "=");
            if(splitArray.size() == 2)
            {
               ossimRefPtr<ossimProperty> prop =
                     new ossimStringProperty(splitArray[0], splitArray[1]);

               ih->setProperty( prop );
            }
         }
      }
   }
}

setUsage()

void ossimChipProcTool::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.

Reimplemented in ossimShorelineTool, ossimHillshadeTool, ossimHlzTool, ossimHdf5Tool, ossimViewshedTool, ossimSubImageTool, ossimOrthoTool, ossimSlopeTool, ossimPotraceTool, ossimBandMergeTool, and ossimRegTool.

Definition at line 1520 of file ossimChipProcTool.cpp.

References ossimApplicationUsage::addCommandLineOption(), ossimInit::addOptions(), ossimArgumentParser::getApplicationName(), ossimArgumentParser::getApplicationUsage(), ossimInit::instance(), and ossimTool::setUsage().

Referenced by ossimBandMergeTool::setUsage(), ossimOrthoTool::setUsage(), ossimSlopeTool::setUsage(), ossimViewshedTool::setUsage(), ossimHdf5Tool::setUsage(), ossimHlzTool::setUsage(), ossimHillshadeTool::setUsage(), and ossimShorelineTool::setUsage().

{
   // Add global usage options.
   ossimInit::instance()->addOptions(ap);

   // Set app name.
   std::string appName = ap.getApplicationName();
   ossimApplicationUsage* au = ap.getApplicationUsage();

   // Base class has some:
   ossimTool::setUsage(ap);

   // Add options.
   au->addCommandLineOption("--aoi-geo-bbox", "<min-lat> <min-lon> <max-lat> <max-lon>\nSpecify a comma-separated list for the lower-left and upper-right corners of the scene rect in decimal degrees.");
   au->addCommandLineOption("--aoi-geo-center", "<lat> <lon>\nCenter of AOI in decimal degrees.");
   au->addCommandLineOption("--aoi-map-bbox", "<min-x> <min-y> <max-x> <max-y>\nSpecify a space-separated list for the upper-left and lower-right corners of the scene rect in decimal degrees.");
   au->addCommandLineOption("--aoi-map-center", "<x> <y>\nCenter of AOI in map coordinates.");
   au->addCommandLineOption("--aoi-size-pixels", "<dx> <dy>,\nSize of AOI in output product pixels.");
   au->addCommandLineOption("--aoi-size-meters", "<dx> <dy>,\nSize of AOI in meters.");
   au->addCommandLineOption( "-b or --bands <n,n...>", "Use the specified bands in given order: e.g. \"3,2,1\" will select bands 3, 2 and 1 of the input image.\nNote: it is 1 based" );
   au->addCommandLineOption("--central-meridian","<lon>\nNote if set this will be used for the central meridian of the projection.  This can be used to lock the utm zone.");
   au->addCommandLineOption("--color-table | --lut","<color-table.kwl>\nKeyword list containing color table for color-relief option.");
   au->addCommandLineOption("--deg-per-pixel","<dpp_xy> | <dpp_x> <dpp_y>\nSpecifies an override for degrees per pixel. Takes either a single value applied equally to x and y directions, or two values applied correspondingly to x then y. This option takes precedence over the \"--meters\" option.");
   au->addCommandLineOption("--dem", "<file1>[,<file2>...]\n Input DEM file(s) (comma-separated) to process.");
   au->addCommandLineOption("--dump-options","The current state of the utility (after the entire command line is parsed) is written to the file $PWD/<utility>.kwl, where <utility> is the name of the operation being performed. See \"--load-options\".");
   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>\" ");
   au->addCommandLineOption("--gsd", "<meters>\nSpecifies an override for the meters per pixel");
   au->addCommandLineOption("-h or --help", "Display this help and exit.");
   au->addCommandLineOption("--hemisphere", "<hemisphere>\nSpecify a projection hemisphere if supported. E.g. UTM projection. This will lock the hemisphere even if input scene center is the other hemisphere. Valid values for UTM are \"N\" and \"S\"");
   au->addCommandLineOption("--image | -i", "<file1>[, <file2>...] Input image file(s) (comma-separated) to process.");
   au->addCommandLineOption("--load-options","[<filename>]\nThe contents of <filename> (keyword-value pairs) are loaded as command options. The command-line options take precedence.  See \"--load-options\" and \"--write-template\" options.");
   au->addCommandLineOption("--output-file | -o","<filename>\nThe product output file name. The format is dictated by the extension.");
   au->addCommandLineOption("--origin-latitude","<latidude_in_decimal_degrees>\nNote if set this will be used for the origin latitude of the projection.  Setting this to something other than 0.0 with a geographic projection creates a scaled geographic projection.");
   au->addCommandLineOption("--output-radiometry", "<R>\nSpecifies the desired product's pixel radiometry type. Possible values for <R> are: U8, U11, U16, S16, F32. Note this overrides the deprecated option \"scale-to-8-bit\".");
   au->addCommandLineOption("--projection", "<output_projection> Valid projections: geo, geo-scaled, input or utm\ngeo = Equidistant Cylindrical, origin latitude = 0.0\ngeo-scaled = Equidistant Cylindrical, origin latitude = image center\ninput Use first images projection. Must be a map projecion.\nutm = Universal Tranverse Mercator\nIf input and multiple sources the projection of the first image will be used.\nIf utm the zone will be set from the scene center of first image.\nNOTE: --srs takes precedence over this option.");
   au->addCommandLineOption("--reader-prop", "<string>Adds a property to send to the reader. format is name=value");
   au->addCommandLineOption("--scale-to-8-bit", "Scales the output to unsigned eight bits per band. This option has been deprecated by the newer \"--output-radiometry\" option.");
   au->addCommandLineOption("--snap-tie-to-origin", "Snaps tie point to projection origin so that (tie-origin)/gsd come out on an even integer boundary.");
   au->addCommandLineOption("--srs","<src_code>\nSpecify a spatial reference system(srs) code for the output projection. Example: --srs EPSG:4326");
   au->addCommandLineOption("-t or --thumbnail", "<max_dimension>\nSpecify a thumbnail resolution.\nScale will be adjusted so the maximum dimension = argument given.");
   au->addCommandLineOption("--tile-size", "<size_in_pixels>\nSets the output tile size if supported by writer.  Notes: This sets both dimensions. Must be a multiple of 16, e.g. 1024.");
   au->addCommandLineOption("-w or --writer","<writer>\nSpecifies the output writer.  Default uses output file extension to determine writer. For valid output writer types use: \"ossim-info --writers\"\n");
   au->addCommandLineOption("--writer-prop", "<writer-property>\nPasses a name=value pair to the writer for setting it's property. Any number of these can appear on the line.");
   au->addCommandLineOption("--write-template", "<filename>\nWrites a keywrd list template to the filename specified.");
   au->addCommandLineOption("--zone", "<zone>\nSpecify a projection zone if supported.  E.g. UTM projection. This will lock the zone even if input scene center is in another zone. Valid values for UTM are \"1\" to \"60\"");
}

Member Data Documentation

m_aoiGroundRect

ossimGrect ossimChipProcTool::m_aoiGroundRect

protected

Definition at line 223 of file ossimChipProcTool.h.

Referenced by computeAdjustedViewFromGrect(), ossimViewshedTool::computeRadius(), ossimHlzTool::getChip(), ossimShorelineTool::getChip(), ossimViewshedTool::getChip(), getChip(), ossimViewshedTool::initializeAOI(), initializeAOI(), ossimSlopeTool::initProcessingChain(), ossimShorelineTool::initProcessingChain(), ossimHlzTool::initProcessingChain(), ossimViewshedTool::initProcessingChain(), mosaicDemSources(), ossimViewshedTool::optimizeFOV(), setAoiToInputs(), and ossimViewshedTool::test().

m_aoiViewRect

ossimIrect ossimChipProcTool::m_aoiViewRect

protected

Definition at line 222 of file ossimChipProcTool.h.

Referenced by computeAdjustedViewFromGrect(), ossimHlzTool::computeHLZ(), ossimViewshedTool::computeRadius(), ossimViewshedTool::computeViewshed(), RadialProcessor::doRadial(), ossimHlzTool::execute(), ossimSubImageTool::execute(), execute(), ossimHlzTool::getChip(), ossimShorelineTool::getChip(), ossimViewshedTool::getChip(), getChip(), ossimSubImageTool::initialize(), initializeAOI(), ossimShorelineTool::initProcessingChain(), ossimHlzTool::initProcessingChain(), ossimViewshedTool::initProcessingChain(), ossimViewshedTool::paintReticle(), and ossimHlzTool::writeSlopeImage().

m_cutRectFilter

ossimRefPtr<ossimRectangleCutFilter> ossimChipProcTool::m_cutRectFilter

protected

Definition at line 228 of file ossimChipProcTool.h.

Referenced by getChip().

m_demSources

std::vector< ossimFilename > ossimChipProcTool::m_demSources

protected

Definition at line 225 of file ossimChipProcTool.h.

Referenced by ossimSlopeTool::initProcessingChain(), loadDemFiles(), mosaicDemSources(), newIdentityProjection(), and setAoiToInputs().

m_geom

ossimRefPtr<ossimImageGeometry> ossimChipProcTool::m_geom

protected

Definition at line 221 of file ossimChipProcTool.h.

Referenced by clear(), computeAdjustedViewFromGrect(), RadialProcessor::doRadial(), ossimPotraceTool::execute(), ossimSubImageTool::execute(), execute(), ossimHlzTool::getChip(), ossimShorelineTool::getChip(), ossimViewshedTool::getChip(), getChip(), ossimViewshedTool::initializeProjectionGsd(), initializeProjectionGsd(), ossimHlzTool::initProcessingChain(), ossimViewshedTool::initProcessingChain(), mosaicDemSources(), ossimChipProcTool(), ossimViewshedTool::paintReticle(), propagateGeometryToChains(), ossimPotraceTool::transformLineStrings(), and ossimPotraceTool::transformPolygons().

m_geoScaled

bool ossimChipProcTool::m_geoScaled

protected

Definition at line 231 of file ossimChipProcTool.h.

Referenced by getProjectionOrigin(), and ossimViewshedTool::initializeProjectionGsd().

m_gsd

ossimDpt ossimChipProcTool::m_gsd

protected

Definition at line 230 of file ossimChipProcTool.h.

Referenced by clear(), ossimHlzTool::computeHLZ(), ossimViewshedTool::initializeProjectionGsd(), ossimViewshedTool::initProcessingChain(), and ossimChipProcTool().

m_imgLayers

std::vector< ossimRefPtr<ossimSingleImageChain> > ossimChipProcTool::m_imgLayers

protected

Definition at line 224 of file ossimChipProcTool.h.

Referenced by clear(), ossimPotraceTool::execute(), ossimShorelineTool::execute(), ossimHdf5Tool::execute(), ossimBandMergeTool::initProcessingChain(), ossimHillshadeTool::initProcessingChain(), ossimSlopeTool::initProcessingChain(), ossimShorelineTool::initProcessingChain(), ossimHdf5Tool::initProcessingChain(), ossimHlzTool::initProcessingChain(), ossimViewshedTool::initProcessingChain(), ossimHdf5Tool::loadImageFiles(), loadImageFiles(), newIdentityProjection(), propagateGeometryToChains(), and setAoiToInputs().

m_needCutRect

bool ossimChipProcTool::m_needCutRect

protected

Definition at line 234 of file ossimChipProcTool.h.

Referenced by clear(), and ossimSubImageTool::initialize().

m_procChain

ossimRefPtr<ossimImageChain> ossimChipProcTool::m_procChain

protected

Definition at line 227 of file ossimChipProcTool.h.

Referenced by ossimShorelineTool::autoComputeThreshold(), clear(), computeAdjustedViewFromGrect(), ossimViewshedTool::computeViewshed(), createInputChain(), ossimShorelineTool::doThreshold(), ossimShorelineTool::execute(), ossimSubImageTool::execute(), execute(), ossimHlzTool::getChip(), ossimShorelineTool::getChip(), ossimViewshedTool::getChip(), getChip(), ossimSubImageTool::initialize(), ossimBandMergeTool::initProcessingChain(), ossimHillshadeTool::initProcessingChain(), ossimSlopeTool::initProcessingChain(), ossimShorelineTool::initProcessingChain(), ossimHdf5Tool::initProcessingChain(), ossimHlzTool::initProcessingChain(), ossimViewshedTool::initProcessingChain(), ossimHdf5Tool::loadImageFiles(), and ossimChipProcTool().

m_productFilename

ossimFilename ossimChipProcTool::m_productFilename

protected

Definition at line 232 of file ossimChipProcTool.h.

Referenced by ossimShorelineTool::doThreshold(), ossimShorelineTool::execute(), ossimHdf5Tool::execute(), ossimSubImageTool::execute(), execute(), ossimSubImageTool::initialize(), and ossimPotraceTool::writeGeoJSON().

m_productScalarType

ossimScalarType ossimChipProcTool::m_productScalarType

protected

Definition at line 233 of file ossimChipProcTool.h.

Referenced by createInputChain(), initialize(), and ossimHdf5Tool::loadImageFiles().

m_projIsIdentity

bool ossimChipProcTool::m_projIsIdentity

protected

Definition at line 229 of file ossimChipProcTool.h.

Referenced by newIdentityProjection().

m_writer

ossimRefPtr<ossimImageFileWriter> ossimChipProcTool::m_writer

mutableprotected

Definition at line 226 of file ossimChipProcTool.h.

Referenced by abort(), clear(), and execute().

---

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

• ossimChipProcTool.h
• ossimChipProcTool.cpp