Utility class for generating point-cloud-derived image products. More...

#include <ossimPointCloudTool.h>

Inheritance diagram for ossimPointCloudTool:

Public Member Functions
	ossimPointCloudTool ()

	~ossimPointCloudTool ()

bool	initialize (ossimArgumentParser &ap) override
	Initializes from command line arguments. More...

void	loadJSON (const Json::Value &json_request) override
	Reads processing params from JSON object provided. More...

void	saveJSON (Json::Value &json) const override
	Fetch product as JSON object when applicable Always returns true since using exception on error. More...

virtual bool	execute () override
	Writes product to output file if applicable. More...

Public Member Functions inherited from ossimTool
	ossimTool ()

virtual	~ossimTool ()

virtual void	initialize (const ossimKeywordlist &kwl)
	Reads processing params from KWL and prepares for execute. More...

virtual const std::string &	getResponse () const
	Fetch product as string (typically JSON) when applicable, otherwise passes back empty string. More...

virtual void	clear ()
	Disconnects and clears the DEM and image layers. More...

virtual void	abort ()
	Kills current (asynchronous) process. 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...

virtual bool	isChipProcessor () const
	Overrides base class implementation to indicate this class supports getChip() calls. 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 ()

Protected Types
enum	Operation { HIGHEST_DEM, LOWEST_DEM, HIGHEST_LOWEST }

Protected Member Functions
bool	initialize ()

void	setGSD (const double &meters_per_pixel)

void	usage (ossimArgumentParser &ap)

void	addArguments (ossimArgumentParser &ap)

bool	loadPC ()

bool	loadDem ()

Protected Member Functions inherited from ossimTool
virtual void	setUsage (ossimArgumentParser &ap)
	Initializes the aurgument parser with expected parameters and options. More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
enum ossimPointCloudTool::Operation	m_operation

ossimRefPtr< ossimImageGeometry >	m_prodGeom

ossimRefPtr< ossimPointCloudHandler >	m_pcHandler

ossimRefPtr< ossimPointCloudImageHandler >	m_pciHandler

ossimRefPtr< ossimPointCloudUtilityFilter >	m_pcuFilter

double	m_gsd

ossimFilename	m_lutFile

ossimFilename	m_prodFile

ossimFilename	m_demFile

ossimFilename	m_pcFile

Protected Attributes inherited from ossimTool
ossimKeywordlist	m_kwl

std::ostream *	m_consoleStream

bool	m_helpRequested

std::string	m_response

Friends
class	ossimPointCloudUtilityFilter

Detailed Description

Utility class for generating point-cloud-derived image products.

Definition at line 26 of file ossimPointCloudTool.h.

Member Enumeration Documentation

◆ Operation

enum ossimPointCloudTool::Operation

protected

Enumerator
HIGHEST_DEM
LOWEST_DEM
HIGHEST_LOWEST

Definition at line 47 of file ossimPointCloudTool.h.

47 { HIGHEST_DEM, LOWEST_DEM, HIGHEST_LOWEST } m_operation;

ossimPointCloudTool::HIGHEST_DEM

Definition: ossimPointCloudTool.h:47

ossimPointCloudTool::m_operation

enum ossimPointCloudTool::Operation m_operation

ossimPointCloudTool::LOWEST_DEM

Definition: ossimPointCloudTool.h:47

ossimPointCloudTool::HIGHEST_LOWEST

Definition: ossimPointCloudTool.h:47

Constructor & Destructor Documentation

◆ ossimPointCloudTool()

ossimPointCloudTool::ossimPointCloudTool ( )

Definition at line 27 of file ossimPointCloudTool.cpp.

 :  m_operation (LOWEST_DEM),
    m_gsd (0)
 {
 }

◆ ~ossimPointCloudTool()

ossimPointCloudTool::~ossimPointCloudTool ( )

Definition at line 33 of file ossimPointCloudTool.cpp.

References m_pcHandler, m_pcuFilter, and m_prodGeom.

 {
    m_pcHandler = 0;
    m_prodGeom = 0;
    m_pcuFilter = 0;
 }

Member Function Documentation

◆ addArguments()

void ossimPointCloudTool::addArguments ( ossimArgumentParser & ap )

protected

Definition at line 40 of file ossimPointCloudTool.cpp.

References ossimApplicationUsage::addCommandLineOption(), ossimArgumentParser::getApplicationName(), ossimArgumentParser::getApplicationUsage(), and ossimApplicationUsage::setCommandLineUsage().

Referenced by usage().

 {
    // Set the general usage:
    ossimApplicationUsage* au = ap.getApplicationUsage();
    ossimString usageString = ap.getApplicationName();
    usageString += " [options] <point-cloud-file> <output-image>";
    au->setCommandLineUsage(usageString);
 
    // Set the command line options:
    au->addCommandLineOption(
          "--gsd <meters>",
          "Specifies output GSD in meters. Defaults to the same "
          "resolution as input DEM.");
    au->addCommandLineOption(
          "--dem <filename>",
          "Specifies the input DEM filename. If none provided, the elevation database is "
          "referenced as specified in prefs file");
    au->addCommandLineOption(
          "--lut <filename>",
          "Specifies the optional lookup table filename for "
          "mapping the single-band output image to an RGB. The LUT provided must be "
          "in the ossimIndexToRgbLutFilter format and must handle the three output "
          "viewshed values (see --values option).");
    au->addCommandLineOption(
          "--method",
          "Specify the desired operation. Possible values are:\n"
          "  \"highest-dem\", \"lowest-dem\" (default), or \"highest-lowest\". \n"
          "Alternatively can be specified in shorthand as \"h-d\", \"l-d\", or \"h-l\", "
          "respectively.");
    au->addCommandLineOption(
          "--request-api",
          "Causes applications API to be output as JSON to stdout."
          " Accepts optional filename to store JSON output.");
    au->addCommandLineOption(
          "--threads <n>",
          "Number of threads. Defaults to use all available cores. "
          "For engineering/debug purposes ");
 }

◆ execute()

bool ossimPointCloudTool::execute ( )

overridevirtual

Writes product to output file if applicable.

The product may also beAlways returns true since using exception on error.

Note: Throws ossimException on error.

Implements ossimTool.

Definition at line 234 of file ossimPointCloudTool.cpp.

References ossimKeywordlist::addFile(), ossimConnectableObject::connectMyInputTo(), ossimImageWriterFactoryRegistry::createWriter(), ossimString::empty(), ossimImageFileWriter::execute(), ossimRefPtr< T >::get(), ossimIndexToRgbLutFilter::initialize(), ossimImageWriterFactoryRegistry::instance(), ossimIndexToRgbLutFilter::loadState(), m_lutFile, m_pcuFilter, m_prodFile, ossimNotify(), ossimNotifyLevel_WARN, and ossimRefPtr< T >::valid().

 {
    // See if an LUT is requested:
    ossimImageSource* last_source = m_pcuFilter.get();
    ossimRefPtr<ossimIndexToRgbLutFilter> lutSource = 0;
    if (!m_lutFile.empty())
    {
       ossimKeywordlist lut_kwl;
       lut_kwl.addFile(m_lutFile);
       lutSource = new ossimIndexToRgbLutFilter;
       if (!lutSource->loadState(lut_kwl))
       {
          ossimNotify(ossimNotifyLevel_WARN) << "ossimPointCloudTool::writeFile() ERROR: The LUT "
                "file <"<<m_lutFile<<"> could not be read. Ignoring remap request.\n"<< std::endl;
          lutSource = 0;
       }
       else
       {
          lutSource->connectMyInputTo(last_source);
          lutSource->initialize();
          last_source = lutSource.get();
       }
    }
 
    // Set up the writer:
    ossimRefPtr<ossimImageFileWriter> writer =
          ossimImageWriterFactoryRegistry::instance()->createWriter(m_prodFile);
    bool success = false;
    if (writer.valid())
    {
       writer->connectMyInputTo(0, last_source);
       success = writer->execute();
    }
 
    return success;
 }

◆ initialize() [1/2]

bool ossimPointCloudTool::initialize ( ossimArgumentParser & ap )

overridevirtual

Initializes from command line arguments.

This base class has some common arguments to read. The derived class should call this implementation in addition to setting its own arguments.

Parameters

ap	Represents command line.

Returns: FALSE if –help option requested or no params provided, so that derived classes can exit without error.

Note: Throws ossimException on error.

Reimplemented from ossimTool.

Definition at line 95 of file ossimPointCloudTool.cpp.

References ossimArgumentParser::argc(), ossimString::contains(), HIGHEST_DEM, HIGHEST_LOWEST, initialize(), m_demFile, m_gsd, m_lutFile, m_operation, m_pcFile, m_prodFile, ossimArgumentParser::read(), ossimString::toDouble(), and usage().

 {
    if ( (ap.argc() == 1) || ap.read("-h") || ap.read("--help") )
    {
       usage(ap);
       return false;
    }
 
    ossimString ts1;
    ossimArgumentParser::ossimParameter sp1(ts1);
 
    if ( ap.read("--dem", sp1) )
       m_demFile = ts1;
 
    if ( ap.read("--gsd", sp1) )
       m_gsd = ossimString(ts1).toDouble();
 
    if ( ap.read("--lut", sp1) )
       m_lutFile = ts1;
 
    if ( ap.read("--method", sp1) )
    {
       if (ts1.contains("highest-dem") || ts1.contains("h-d"))
          m_operation = HIGHEST_DEM;
       else if (ts1.contains("highest-lowest") || ts1.contains("h-l"))
          m_operation = HIGHEST_LOWEST;
    }
 
    if ( ap.read("--pc", sp1) )
       m_demFile = ts1;
 
 /*
    if ( ap.read("--request-api", sp1))
    {
       ofstream ofs ( ts1.c_str() );
       printApiJson(ofs);
       ofs.close();
       return false;
    }
    if ( ap.read("--request-api"))
    {
       printApiJson(cout);
       return false;
    }
 */
    // There should only be the required command line args left:
    if (ap.argc() < 3)
    {
       usage(ap);
       return false;
    }
 
    // Parse the required command line params:
    m_pcFile = ap[1];
    m_prodFile = ap[2];
 
    return initialize();
 }

◆ initialize() [2/2]

bool ossimPointCloudTool::initialize ( )

protected

Definition at line 159 of file ossimPointCloudTool.cpp.

References ossimString::empty(), loadDem(), loadPC(), m_demFile, m_pcFile, m_pcuFilter, ossimNotify(), ossimNotifyLevel_WARN, and ossimPointCloudUtilityFilter.

Referenced by initialize().

 {
    if (loadPC())
    {
       ossimNotify(ossimNotifyLevel_WARN)
               << "ossimPointCloudTool::initialize ERR: Cannot open PC file at <"<<m_pcFile
               <<">\n"<< endl;
       return false;
    }
 
    if (!m_demFile.empty() && !loadDem())
       return false;
 
    m_pcuFilter = new ossimPointCloudUtilityFilter(this);
    return true;
 }

◆ loadDem()

bool ossimPointCloudTool::loadDem ( )

protected

Definition at line 201 of file ossimPointCloudTool.cpp.

References ossimElevManager::addDatabase(), ossimElevManager::clear(), ossimRefPtr< T >::get(), ossimElevManager::instance(), m_demFile, ossim::nan(), ossimImageElevationDatabase::open(), ossimNotify(), ossimNotifyLevel_WARN, ossimElevManager::setDefaultHeightAboveEllipsoid(), and ossimElevManager::setUseGeoidIfNullFlag().

Referenced by initialize().

 {
    // DEM provided as file on command line, reset the elev manager to use only this:
    ossimElevManager* elevMgr = ossimElevManager::instance();
    elevMgr->clear();
    ossimRefPtr<ossimImageElevationDatabase> ied = new ossimImageElevationDatabase;
    if(!ied->open(m_demFile))
    {
       ossimNotify(ossimNotifyLevel_WARN)
                            << "ossimViewshedUtil::initialize ERR: Cannot open DEM file at <"<<m_demFile<<">\n"
                            << std::endl;
       return false;
    }
 
    elevMgr->addDatabase(ied.get());
 
    // When DEM file specified, need to turn off all defaulting to ellipsoid/geoid to make sure
    // only the DEM file data is processed:
    elevMgr->setDefaultHeightAboveEllipsoid(ossim::nan());
    elevMgr->setUseGeoidIfNullFlag(false);
 
    return true;
 }

◆ loadJSON()

void ossimPointCloudTool::loadJSON ( const Json::Value & json_request )

overridevirtual

Reads processing params from JSON object provided.

If all good, the object is ready for subsequent call to execute().

Note: Throws ossimException on error.

Reimplemented from ossimTool.

Definition at line 154 of file ossimPointCloudTool.cpp.

 {
 
 }

◆ loadPC()

bool ossimPointCloudTool::loadPC ( )

protected

Definition at line 176 of file ossimPointCloudTool.cpp.

References ossimRefPtr< T >::get(), ossimImageGeometry::getAsMapProjection(), ossimPointCloudImageHandler::getImageGeometry(), ossimPointCloudHandlerRegistry::instance(), m_gsd, m_pcFile, m_pcHandler, m_pciHandler, m_prodGeom, ossimPointCloudHandlerRegistry::open(), ossimNotify(), ossimNotifyLevel_WARN, ossimMapProjection::setMetersPerPixel(), ossimPointCloudImageHandler::setPointCloudHandler(), and ossimRefPtr< T >::valid().

Referenced by initialize().

 {
    // DEM provided as file on command line, reset the elev manager to use only this:
    m_pcHandler = ossimPointCloudHandlerRegistry::instance()->open(m_pcFile);
    if(!m_pcHandler.valid())
    {
       ossimNotify(ossimNotifyLevel_WARN)
             << "ossimPointCloudTool::initialize ERR: Cannot open PC file at <"<<m_pcFile
             <<">\n" << std::endl;
       return false;
    }
 
    // Use "rasterized" PC to establish best output image geometry:
    m_pciHandler = new ossimPointCloudImageHandler;
    m_pciHandler->setPointCloudHandler(m_pcHandler.get());
    m_prodGeom = m_pciHandler->getImageGeometry();
    if (!m_prodGeom.valid() || !m_prodGeom->getAsMapProjection())
       return false;
 
    if (m_gsd != 0)
       m_prodGeom->getAsMapProjection()->setMetersPerPixel(ossimDpt(m_gsd, m_gsd));
 
    return true;
 }

◆ saveJSON()

void ossimPointCloudTool::saveJSON ( Json::Value & json ) const

overridevirtual

Fetch product as JSON object when applicable Always returns true since using exception on error.

Parameters

json	Returns non-empty object if valid response available.

Reimplemented from ossimTool.

Definition at line 272 of file ossimPointCloudTool.cpp.

 {
 
 }

◆ setGSD()

void ossimPointCloudTool::setGSD ( const double & meters_per_pixel )

protected

Definition at line 225 of file ossimPointCloudTool.cpp.

References ossimImageGeometry::getAsMapProjection(), m_gsd, m_prodGeom, and ossimMapProjection::setMetersPerPixel().

 {
    if (m_prodGeom->getAsMapProjection() && (meters_per_pixel > 0))
    {
       m_gsd = meters_per_pixel;
       m_prodGeom->getAsMapProjection()->setMetersPerPixel(ossimDpt(m_gsd, m_gsd));
    }
 }

◆ usage()

void ossimPointCloudTool::usage ( ossimArgumentParser & ap )

protected

Definition at line 79 of file ossimPointCloudTool.cpp.

References addArguments(), ossimInit::addOptions(), ossimArgumentParser::getApplicationUsage(), ossimInit::instance(), ossimNotify(), ossimNotifyLevel_INFO, and ossimApplicationUsage::write().

Referenced by initialize().

 {
    // Add global usage options.
    ossimInit::instance()->addOptions(ap);
 
    // Add options.
    addArguments(ap);
 
    // Write usage.
    ap.getApplicationUsage()->write(ossimNotify(ossimNotifyLevel_INFO));
 
    ossimNotify(ossimNotifyLevel_INFO)
    <<"\nPerforms specified processing on point-cloud.\n\n"
    << std::endl;
 }

Friends And Related Function Documentation

◆ ossimPointCloudUtilityFilter

friend class ossimPointCloudUtilityFilter

friend

Definition at line 28 of file ossimPointCloudTool.h.

Referenced by initialize().

Member Data Documentation

◆ m_demFile

ossimFilename ossimPointCloudTool::m_demFile

protected

Definition at line 55 of file ossimPointCloudTool.h.

Referenced by initialize(), and loadDem().

◆ m_gsd

double ossimPointCloudTool::m_gsd

protected

Definition at line 52 of file ossimPointCloudTool.h.

Referenced by initialize(), loadPC(), and setGSD().

◆ m_lutFile

ossimFilename ossimPointCloudTool::m_lutFile

protected

Definition at line 53 of file ossimPointCloudTool.h.

Referenced by execute(), and initialize().

◆ m_operation

enum ossimPointCloudTool::Operation ossimPointCloudTool::m_operation

protected

Referenced by ossimPointCloudUtilityFilter::getTile(), and initialize().

◆ m_pcFile

ossimFilename ossimPointCloudTool::m_pcFile

protected

Definition at line 56 of file ossimPointCloudTool.h.

Referenced by initialize(), and loadPC().

◆ m_pcHandler

ossimRefPtr<ossimPointCloudHandler> ossimPointCloudTool::m_pcHandler

protected

Definition at line 49 of file ossimPointCloudTool.h.

Referenced by loadPC(), and ~ossimPointCloudTool().

◆ m_pciHandler

ossimRefPtr<ossimPointCloudImageHandler> ossimPointCloudTool::m_pciHandler

protected

Definition at line 50 of file ossimPointCloudTool.h.

Referenced by ossimPointCloudUtilityFilter::getTile(), and loadPC().

◆ m_pcuFilter

ossimRefPtr<ossimPointCloudUtilityFilter> ossimPointCloudTool::m_pcuFilter

protected

Definition at line 51 of file ossimPointCloudTool.h.

Referenced by execute(), initialize(), and ~ossimPointCloudTool().

◆ m_prodFile

ossimFilename ossimPointCloudTool::m_prodFile

protected

Definition at line 54 of file ossimPointCloudTool.h.

Referenced by execute(), and initialize().

◆ m_prodGeom

ossimRefPtr<ossimImageGeometry> ossimPointCloudTool::m_prodGeom

protected

Definition at line 48 of file ossimPointCloudTool.h.

Referenced by ossimPointCloudUtilityFilter::getImageGeometry(), ossimPointCloudUtilityFilter::getTile(), loadPC(), setGSD(), and ~ossimPointCloudTool().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Operation

Constructor & Destructor Documentation

◆ ossimPointCloudTool()

◆ ~ossimPointCloudTool()

Member Function Documentation

◆ addArguments()

◆ execute()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ loadDem()

◆ loadJSON()

◆ loadPC()

◆ saveJSON()

◆ setGSD()

◆ usage()

Friends And Related Function Documentation

◆ ossimPointCloudUtilityFilter

Member Data Documentation

◆ m_demFile

◆ m_gsd

◆ m_lutFile

◆ m_operation

◆ m_pcFile

◆ m_pcHandler

◆ m_pciHandler

◆ m_pcuFilter

◆ m_prodFile

◆ m_prodGeom