ossimHillshadeTool Class Reference

#include <ossimHillshadeTool.h>

Inheritance diagram for ossimHillshadeTool:

Public Member Functions
	ossimHillshadeTool ()
	default constructor More...
virtual	~ossimHillshadeTool ()
	virtual destructor More...
virtual void	setUsage (ossimArgumentParser &ap)
	Initializes the aurgument parser with expected parameters and options. More...
virtual bool	initialize (ossimArgumentParser &ap)
	Initial method to be ran prior to execute. 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	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
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...
	ossimHillshadeTool (const ossimHillshadeTool &obj)
	Hidden from use copy constructor. More...
const ossimHillshadeTool &	operator= (const ossimHillshadeTool &rhs)
	Hidden from use assignment operator. 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)

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 }
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

Definition at line 33 of file ossimHillshadeTool.h.

Constructor & Destructor Documentation

ossimHillshadeTool() [1/2]

ossimHillshadeTool::ossimHillshadeTool

(

)

default constructor

Definition at line 71 of file ossimHillshadeTool.cpp.

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

{
   m_kwl.setExpandEnvVarsFlag(true);
}

~ossimHillshadeTool()

ossimHillshadeTool::~ossimHillshadeTool ( )

virtual

virtual destructor

Definition at line 87 of file ossimHillshadeTool.cpp.

References ossimChipProcTool::clear().

{
   clear();
}

ossimHillshadeTool() [2/2]

ossimHillshadeTool::ossimHillshadeTool ( const ossimHillshadeTool &  obj )

protected

Hidden from use copy constructor.

Definition at line 77 of file ossimHillshadeTool.cpp.

{
}

Member Function Documentation

getClassName()

virtual ossimString ossimHillshadeTool::getClassName ( ) const

inlinevirtual

Reimplemented from ossimTool.

Definition at line 46 of file ossimHillshadeTool.h.

{ return "ossimHillshadeUtil"; }

initialize()

bool ossimHillshadeTool::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 ossimChipProcTool.

Definition at line 92 of file ossimHillshadeTool.cpp.

References ossimKeywordlist::addPair(), ossimKeywordNames::AZIMUTH_ANGLE_KW, ossimChipProcTool::initialize(), ossimTool::m_helpRequested, ossimTool::m_kwl, and ossimArgumentParser::read().

{
   // Permit base class to pull out common options first.
   if (!ossimChipProcTool::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);
   std::string tempString5;
   ossimArgumentParser::ossimParameter stringParam5(tempString5);
   std::string tempString6;
   ossimArgumentParser::ossimParameter stringParam6(tempString6);
   double tempDouble1;
   ossimArgumentParser::ossimParameter doubleParam1(tempDouble1);
   double tempDouble2;
   ossimArgumentParser::ossimParameter doubleParam2(tempDouble2);
   
   // Extract optional arguments and stuff them in a keyword list.
   if( ap.read("--azimuth", stringParam1) )
   {
      m_kwl.addPair( std::string(ossimKeywordNames::AZIMUTH_ANGLE_KW), tempString1 );
   }

   if( ap.read("--color", stringParam1, stringParam2, stringParam3) )
   {
      m_kwl.addPair( COLOR_RED_KW,   tempString1 );
      m_kwl.addPair( COLOR_GREEN_KW, tempString2 );
      m_kwl.addPair( COLOR_BLUE_KW,  tempString3 );
   }

   int color_source_idx = 0;
   while( ap.read("--color-source", stringParam1) )
   {
      ossimString key = COLOR_SOURCE_KW;
      key += ossimString::toString(color_source_idx++);
      key += ".";
      key += ossimKeywordNames::FILE_KW;
      m_kwl.addPair(key.string(), tempString1 );
   }

   if ( ap.read("--elevation", stringParam1) )
   {
      m_kwl.addPair( std::string(ossimKeywordNames::ELEVATION_ANGLE_KW), tempString1 );
   }

   processRemainingArgs(ap);
   return true;
}

initProcessingChain()

void ossimHillshadeTool::initProcessingChain ( )

protectedvirtual

Derived classes initialize their custom chains here.

Implements ossimChipProcTool.

Definition at line 150 of file ossimHillshadeTool.cpp.

References ossimImageChain::add(), ossimKeywordNames::AZIMUTH_ANGLE_KW, ossimChipProcTool::combineLayers(), ossimConnectableObject::connectMyInputTo(), ossimKeywordNames::ELEVATION_ANGLE_KW, ossimKeywordlist::findKey(), ossimRefPtr< T >::get(), ossimChipProcTool::m_imgLayers, ossimTool::m_kwl, ossimChipProcTool::m_procChain, ossimChipProcTool::mosaicDemSources(), ossimBumpShadeTileSource::setAzimuthAngle(), ossimBumpShadeTileSource::setElevationAngle(), ossimImageToPlaneNormalFilter::setSmoothnessFactor(), ossimImageToPlaneNormalFilter::setTrackScaleFlag(), ossimString::size(), and ossimString::toFloat64().

{
   // Need a mosaic of DEM over the AOI as an image mosaic:
   ossimRefPtr<ossimImageSource> demMosaic = mosaicDemSources();
   m_procChain->add(demMosaic.get());

   // Set up the normal source.
   ossimRefPtr<ossimImageToPlaneNormalFilter> normSource = new ossimImageToPlaneNormalFilter;
   normSource->setTrackScaleFlag(true);
   m_procChain->add( normSource.get() );

   // Set the smoothness factor.
   ossim_float64 gain = 1.0;
   normSource->setSmoothnessFactor(gain);

   // Create the bump shade.
   ossimRefPtr<ossimBumpShadeTileSource> bumpShade = new ossimBumpShadeTileSource;
   m_procChain->add(bumpShade.get());

   // Set the azimuth angle.
   ossim_float64 azimuthAngle = 180;
   ossimString lookup = m_kwl.findKey( ossimKeywordNames::AZIMUTH_ANGLE_KW );
   if ( lookup.size() )
   {
      ossim_float64 f = lookup.toFloat64();
      if ( (f >= 0) && (f <= 360) )
      {
         azimuthAngle = f;
      }
   }
   bumpShade->setAzimuthAngle(azimuthAngle);

   // Set the elevation angle.
   ossim_float64 elevationAngle = 45.0;
   lookup = m_kwl.findKey( ossimKeywordNames::ELEVATION_ANGLE_KW );
   if ( lookup.size() )
   {
      ossim_float64 f = lookup.toFloat64();
      if ( (f >= 0.0) && (f <= 90) )
      {
         elevationAngle = f;
      }
   }
   bumpShade->setElevationAngle(elevationAngle);


   // Color can be added via color image source:
   if (!m_imgLayers.empty())
   {
      // A color source image (or list) is provided. Add them as input to bump shade:
      ossimRefPtr<ossimImageSource> colorSource = combineLayers( m_imgLayers );
      bumpShade->connectMyInputTo(1, colorSource.get());
   }
   else
   {
      // Default colors are grey:
      ossim_uint8 r = 0xff;
      ossim_uint8 g = 0xff;
      ossim_uint8 b = 0xff;
      lookup = m_kwl.findKey( COLOR_RED_KW );
      if ( lookup.size() )
         r = lookup.toUInt8();
      lookup = m_kwl.findKey( COLOR_GREEN_KW );
      if ( lookup.size() )
         g = lookup.toUInt8();
      lookup = m_kwl.findKey( COLOR_BLUE_KW );
      if ( lookup.size() )
         b = lookup.toUInt8();
      bumpShade->setRgbColorSource(r, g, b);
   }
}

operator=()

const ossimHillshadeTool & ossimHillshadeTool::operator= ( const ossimHillshadeTool &  rhs )

protected

Hidden from use assignment operator.

Definition at line 82 of file ossimHillshadeTool.cpp.

{
   return *this;
}

setUsage()

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

Definition at line 222 of file ossimHillshadeTool.cpp.

References ossimApplicationUsage::addCommandLineOption(), ossimInit::addOptions(), DESCRIPTION, ossimArgumentParser::getApplicationName(), ossimArgumentParser::getApplicationUsage(), ossimInit::instance(), ossimApplicationUsage::setCommandLineUsage(), ossimApplicationUsage::setDescription(), and ossimChipProcTool::setUsage().

{
   // Add global usage options.
   ossimInit::instance()->addOptions(ap);
   
   // Set app name.
   ossimString appName = ap.getApplicationName();
   ossimApplicationUsage* au = ap.getApplicationUsage();
   ossimString usageString = appName;
   usageString += " hillshade [option]... [input-option]... <input-file(s)> <output-file>\nNote at least one input is required either from one of the input options, e.g. --input-dem <my-dem.hgt> or adding to command line in front of the output file in which case the code will try to ascertain what type of input it is.\n\nAvailable traces:\n-T \"ossimChipperUtil:debug\"   - General debug trace to standard out.\n-T \"ossimChipperUtil:log\"     - Writes a log file to output-file.log.\n-T \"ossimChipperUtil:options\" - Writes the options to output-file-options.kwl.";
   au->setCommandLineUsage(usageString);

   // Add arguments.
   au->addCommandLineOption("--azimuth", "<azimuth>\nLight source azimuth angle for bump shade.\nRange: 0 to 360, Default = 180.0");
   au->addCommandLineOption("--color","<r> <g> <b>\nSet the red, green and blue color values to be used with hillshade.\nRange 0 to 255, Defualt r=255, g=255, b=255");
   au->addCommandLineOption("--color-source","<file>\nSpecifies the image file to use as a color source instead of a fixed RGB value.");
   au->addCommandLineOption("--elevation", "<elevation>\nhillshade option - Light source elevation angle for bumb shade.\nRange: 0 to 90, Default = 45.0");

   // Base class has its own:
   ossimChipProcTool::setUsage(ap);

   ostringstream description;
   description << DESCRIPTION << "\n\nNOTES:\n"
      << "1) Never use same base name in the same directory! Example is you have a Chicago.tif\n"
      << "   and you want a Chicago.jp2, output Chicago.jp2 to its own directory.\n"
      << "\nExample command to Hill shade: Hill shade two DEMs, output to a geotiff.\n"
      << appName << " --color 255 255 255 --azimuth 270 --elevation 45 --exaggeration 2.0 N37W123.hgt N38W123.hgt outputs/hillshade.tif\n"
      << "\n// Above command where all options are in a keyword list:\n"
      << appName << " --options r39-options.kwl\n"
      << std::endl;

   au->setDescription(description.str());

}

Member Data Documentation

DESCRIPTION

const char * ossimHillshadeTool::DESCRIPTION

static

Initial value:

=
   "Computes shaded representation of input elevation surface with specified lighting parameters."

Used by ossimUtilityFactory.

Definition at line 49 of file ossimHillshadeTool.h.

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

---

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

• ossimHillshadeTool.h
• ossimHillshadeTool.cpp