#include <ossimHlzTool.h>

Inheritance diagram for ossimHlzTool:

Classes
class	LsFitPatchProcessorJob

class	MaskSource

class	NormPatchProcessorJob

class	PatchProcessorJob

Public Member Functions
	ossimHlzTool ()

	~ossimHlzTool ()

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 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 ossimRefPtr< ossimImageData >	getChip (const ossimIrect &img_rect)
	The meat and potatos of this class. More...

virtual ossimString	getClassName () const

Public Member Functions inherited from ossimChipProcTool
	ossimChipProcTool ()
	default constructor More...

virtual	~ossimChipProcTool ()
	virtual destructor More...

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

virtual void	abort ()

virtual bool	isChipProcessor () const
	Overrides base class implementation to indicate this class supports getChip() calls. More...

virtual ossimListenerManager *	getManager ()

virtual ossimObject *	getObject ()

virtual const ossimObject *	getObject () const

virtual ossimRefPtr< ossimImageData >	getChip (const 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...

	ossimHlzTool (const ossimHlzTool &obj)
	Hidden from use copy constructor. More...

const ossimHlzTool &	operator= (const ossimHlzTool &rhs)
	Hidden from use assignment operator. More...

void	usage (ossimArgumentParser &ap)
	Initializes arg parser and outputs usage. More...

void	addArguments (ossimArgumentParser &ap)

void	loadPcFiles ()

void	loadMaskFiles ()

void	writeSlopeImage ()

void	setProductGSD (const double &meters_per_pixel)

bool	computeHLZ ()

Protected Member Functions inherited from ossimChipProcTool
void	processRemainingArgs (ossimArgumentParser &ap)
	Intended to be called after derived class has picked off its own options from the parser, and arguments remain (such as input and output filenames). More...

virtual void	finalizeChain ()
	Called after initProcessingChain() to append common items to the processing chain. More...

virtual void	loadImageFiles ()
	Creates chains for image entries associated with specified keyword. More...

virtual void	loadDemFiles ()
	Loads all DEM files specified in master KWL into the elev manager's database. More...

ossimRefPtr< ossimSingleImageChain >	createInputChain (const ossimFilename &image_file, ossim_uint32 entry_index=0)
	Creates the ossimSingleImageChain from image filename and populates the chain with resampler and product output projection on view-side of resampler's IVT. More...

void	createOutputProjection ()
	Creates the output or view projection. More...

ossimRefPtr< ossimMapProjection >	newIdentityProjection ()
	Sets the single image chain for identity operations view to a ossimImageViewAffineTransform. More...

ossimRefPtr< ossimMapProjection >	newUtmProjection ()
	Convenience method to get a utm projection. More...

virtual void	initializeProjectionGsd ()
	Initializes the projection gsd. More...

virtual void	initializeAOI ()
	Initializes m_aoiViewRect with the output area of interest as specified in master KWL. More...

bool	getProjectionOrigin (ossimGpt &gpt)
	Reads the KWL for origin latitude and central meridian. More...

ossimRefPtr< ossimImageFileWriter >	newWriter ()
	Creates a new writer. More...

void	propagateGeometryToChains ()
	Loops through all chains and sets the output projection. More...

ossimRefPtr< ossimImageSource >	combineLayers (std::vector< ossimRefPtr< ossimSingleImageChain > > &layers) const
	When multiple input sources are present, this method instantiates a combiner and adds inputs. More...

void	computeAdjustedViewFromGrect ()
	Initializes m_aoiViewRect given m_aoiGroundRect. More...

void	setAoiToInputs ()
	Assigns the AOI to be the bounding rect of the union of all inputs. More...

void	getBandList (ossim_uint32 image_idx, std::vector< ossim_uint32 > &bandList) const
	Gets the band list if BANDS keyword is set. More...

void	setReaderProps (ossimImageHandler *ih) const
	Passes reader properties to single image handler if any. More...

	ossimChipProcTool (const ossimChipProcTool &obj)
	Hidden from use copy constructor. More...

const ossimChipProcTool &	operator= (const ossimChipProcTool &)
	Hidden from use assignment operator. More...

ossimRefPtr< ossimGeoPolygon >	createClipPolygon () const

void	findCenterGpt (ossimGpt &gpt)
	Tries to determine the AOI center point based on KWL entries, else returns NaNs in gpt. More...

ossimRefPtr< ossimImageSource >	mosaicDemSources ()
	Some utilities need to work on DEMs as images. More...

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Member Functions inherited from ossimListenerManager
	ossimListenerManager (const ossimListenerManager &rhs)

Protected Attributes
double	m_slopeThreshold

double	m_roughnessThreshold

double	m_hlzMinRadius

ossimFilename	m_slopeFile

ossimIpt	m_demFilterSize

ossimRefPtr< ossimImageData >	m_demBuffer

ossimRefPtr< ossimImageData >	m_outBuffer

ossimRefPtr< ossimMemoryImageSource >	m_memSource

ossim_uint8	m_badLzValue

ossim_uint8	m_marginalLzValue

ossim_uint8	m_goodLzValue

bool	m_useLsFitMethod

ossimRefPtr< ossimImageSource >	m_combinedElevSource

std::vector< ossimRefPtr< ossimPointCloudHandler > >	m_pcSources

std::vector< MaskSource >	m_maskSources

ossim_uint32	m_numThreads

double	d_accumT

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

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

Class for finding helicopter landing zones (HLZ) on a DEM given the final destination and max range from destination.

Definition at line 35 of file ossimHlzTool.h.

Constructor & Destructor Documentation

◆ ossimHlzTool() [1/2]

ossimHlzTool::ossimHlzTool ( )

Definition at line 49 of file ossimHlzTool.cpp.

 : m_slopeThreshold(7.0),
   m_roughnessThreshold(0.5),
   m_hlzMinRadius(25.0),
   m_outBuffer(NULL),
   m_badLzValue(255),
   m_marginalLzValue(128),
   m_goodLzValue(64),
   m_useLsFitMethod(true),
   m_numThreads(1),
   d_accumT(0)
 {
 }

◆ ~ossimHlzTool()

ossimHlzTool::~ossimHlzTool ( )

Definition at line 63 of file ossimHlzTool.cpp.

64 {

65 }

◆ ossimHlzTool() [2/2]

ossimHlzTool::ossimHlzTool ( const ossimHlzTool & obj )

protected

Hidden from use copy constructor.

Member Function Documentation

◆ addArguments()

void ossimHlzTool::addArguments ( ossimArgumentParser & ap )

protected

◆ computeHLZ()

bool ossimHlzTool::computeHLZ ( )

protected

Definition at line 421 of file ossimHlzTool.cpp.

References ossimImageDataFactory::create(), d_accumT, ossimImageData::fill(), ossim::getNumberOfThreads(), ossimImageSource::getTile(), ossimIrect::height(), ossimImageData::initialize(), ossimImageDataFactory::instance(), ossimIrect::lr(), ossimChipProcTool::m_aoiViewRect, m_combinedElevSource, m_demBuffer, m_demFilterSize, ossimChipProcTool::m_gsd, m_hlzMinRadius, m_memSource, m_numThreads, m_outBuffer, m_useLsFitMethod, OSSIM_UINT8, ossimNotify(), ossimNotifyLevel_INFO, ossimMemoryImageSource::setImage(), ossimImageData::setImageRectangle(), ossimProcessInterface::setPercentComplete(), ossim::Thread::sleepInMicroSeconds(), ossimIrect::ul(), ossimRefPtr< T >::valid(), ossimIrect::width(), ossimIpt::x, ossimDpt::x, ossimIpt::y, and ossimDpt::y.

Referenced by getChip().

 {
 
    // To help with multithreading, just load entire AOI of DEM into memory:
    m_demBuffer = m_combinedElevSource->getTile(m_aoiViewRect);
    if (!m_demBuffer.valid())
       return false;
 
    // Allocate the output image buffer:
    m_outBuffer = ossimImageDataFactory::instance()->create(0, OSSIM_UINT8, 1, m_aoiViewRect.width(),
                                                            m_aoiViewRect.height());
    ostringstream xmsg;
    if (!m_outBuffer.valid() || !m_memSource.valid())
    {
       xmsg<<"ossimHlzUtil:"<<__LINE__<<"  Error encountered allocating output image buffer.";
       throw(xmsg.str());
    }
 
    // Initialize the image with all points hidden:
    m_outBuffer->initialize();
    m_outBuffer->setImageRectangle(m_aoiViewRect);
    m_outBuffer->fill(0);
    m_memSource->setImage(m_outBuffer);
 
    d_accumT = 0;
 
    // Establish loop limits in input DEM raster coordinate space:
    ossim_int32 min_x = m_aoiViewRect.ul().x;
    ossim_int32 min_y = m_aoiViewRect.ul().y;
    ossim_int32 max_x = m_aoiViewRect.lr().x - m_demFilterSize.x;
    ossim_int32 max_y = m_aoiViewRect.lr().y - m_demFilterSize.y;
    ossimIpt chip_origin;
    ossim_uint32 numPatches = (max_x-min_x)*(max_y-min_y);
 
    // Determine the DEM step size as a fraction of the LZ radius:
    const double CHIP_STEP_FACTOR = 0.25; // chip position increment as fraction of chip width
    ossim_int32 dem_step =
          (ossim_int32) floor(4*CHIP_STEP_FACTOR*m_hlzMinRadius/(m_gsd.x+m_gsd.y));
    if (dem_step <= 0)
       dem_step = 1;
 
    // Hack: degrading to single thread when slope-image scheme is used. Runs extremely slow in
    // multithread mode, but much faster as single thread than multithreaded ls-fit
    if ((m_numThreads == 1) || !m_useLsFitMethod)
    {
       // Not threaded (or slope-image scheme):
       setPercentComplete(0);
       ossim_uint32 chipId = 0;
       for (chip_origin.y = min_y; chip_origin.y <= max_y; chip_origin.y += dem_step)
       {
          for (chip_origin.x = min_x; chip_origin.x <= max_x; chip_origin.x += dem_step)
          {
             std::shared_ptr<ossimHlzTool::PatchProcessorJob> job = 0;
             if (m_useLsFitMethod)
                job = std::make_shared<ossimHlzTool::LsFitPatchProcessorJob>(this, chip_origin, chipId++);
             else
                job = std::make_shared<ossimHlzTool::NormPatchProcessorJob>(this, chip_origin, chipId++);
             job->start();
          }
          setPercentComplete(100*chipId/numPatches);
       }
    }
    else
    {
       if (m_numThreads == 0)
          m_numThreads = ossim::getNumberOfThreads();
 
       // Loop over input DEM, creating a thread job for each filter window:
       std::shared_ptr<ossimJobMultiThreadQueue> jobMtQueue =
             std::make_shared<ossimJobMultiThreadQueue>(nullptr, m_numThreads);
       std::shared_ptr<ossimJobQueue> jobQueue = jobMtQueue->getJobQueue();
 
       ossimNotify(ossimNotifyLevel_INFO) << "\nPreparing " << numPatches << " jobs..." << endl; // TODO: DEBUG
       setPercentComplete(0);
       ossim_int32 qsize = 0;
       ossimIpt chip_origin;
       ossim_uint32 chipId = 0;
       for (chip_origin.y = min_y; chip_origin.y <= max_y; ++chip_origin.y)
       {
          for (chip_origin.x = min_x; chip_origin.x <= max_x; ++chip_origin.x)
          {
             //ossimNotify(ossimNotifyLevel_INFO) << "Submitting " << chipId << endl;
             std::shared_ptr<ossimHlzTool::PatchProcessorJob> job = 0;
             if (m_useLsFitMethod)
                job = std::make_shared<ossimHlzTool::LsFitPatchProcessorJob>(this, chip_origin, chipId++);
             else
                job = std::make_shared<ossimHlzTool::NormPatchProcessorJob>(this, chip_origin, chipId++);
             jobQueue->add(job, false);
          }
          qsize = jobQueue->size();
          setPercentComplete(100*(chipId-qsize)/numPatches);
       }
 
       // Wait until all chips have been processed before proceeding:
       ossimNotify(ossimNotifyLevel_INFO) << "All jobs queued. Waiting for job threads to finish..." << endl;
       while (jobMtQueue->hasJobsToProcess() || jobMtQueue->numberOfBusyThreads())
       {
          qsize = jobMtQueue->getJobQueue()->size();
          setPercentComplete(100*(numPatches-qsize)/numPatches);
          ossim::Thread::sleepInMicroSeconds(10000);
       }
       jobMtQueue = 0;
    }
 
    ossimNotify(ossimNotifyLevel_INFO) << "Finished processing chips." << endl;
    return true;
 }

◆ execute()

bool ossimHlzTool::execute ( )

virtual

Performs the actual product write.

Note: Throws ossimException on error.

Reimplemented from ossimChipProcTool.

Definition at line 412 of file ossimHlzTool.cpp.

References ossimChipProcTool::execute(), ossimChipProcTool::getChip(), ossimChipProcTool::m_aoiViewRect, and ossimTool::m_helpRequested.

 {
    if (m_helpRequested)
       return true;
 
    getChip(m_aoiViewRect);
    return ossimChipProcTool::execute();
 }

◆ getChip()

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

virtual

The meat and potatos of this class.

Performs an execute on specified rect.

Reimplemented from ossimChipProcTool.

Definition at line 392 of file ossimHlzTool.cpp.

References computeHLZ(), ossimImageChain::getTile(), ossimImageGeometry::localToWorld(), ossimChipProcTool::m_aoiGroundRect, ossimChipProcTool::m_aoiViewRect, ossimChipProcTool::m_geom, ossimChipProcTool::m_procChain, ossimImageGeometry::setImageSize(), ossimIrect::size(), and ossimRefPtr< T >::valid().

 {
    ostringstream xmsg;
    if (!m_geom.valid())
       return 0;
 
    m_aoiViewRect = bounding_irect;
    m_geom->setImageSize( m_aoiViewRect.size() );
    m_geom->localToWorld(m_aoiViewRect, m_aoiGroundRect);
 
    if (computeHLZ())
    {
       // The memory source has been populated, now do the getTile on the full chain to pick up
       // other filters inserted after the memsource:
       return m_procChain->getTile( m_aoiViewRect, 0 );
    }
    // else:
    return 0;
 }

◆ getClassName()

virtual ossimString ossimHlzTool::getClassName ( ) const

inlinevirtual

Reimplemented from ossimTool.

Definition at line 47 of file ossimHlzTool.h.

47 { return "ossimHlzUtil"; }

◆ initialize() [1/2]

bool ossimHlzTool::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 110 of file ossimHlzTool.cpp.

References ossimChipProcTool::initialize(), ossimTool::m_helpRequested, and ossimArgumentParser::read().

 {
    if (!ossimChipProcTool::initialize(ap))
       return false;
    if (m_helpRequested)
       return true;
 
    string ts1;
    ossimArgumentParser::ossimParameter sp1(ts1);
    string ts2;
    ossimArgumentParser::ossimParameter sp2(ts2);
    string ts3;
    ossimArgumentParser::ossimParameter sp3(ts3);
    ossimString  key ;
 
    vector<ossimString> maskFnames;
    ap.read("--exclude-regions", maskFnames);
    for(ossim_uint32 idx=0; idx<maskFnames.size(); ++idx)
    {
       key = MASK_EXCLUDE_KW;
       key += ossimString::toString(idx++);
       m_kwl.addPair(key.string(), maskFnames[idx] );
    }
 
    if (ap.read("--hlz-coding", sp1, sp2, sp3) || ap.read("--values", sp1, sp2, sp3))
    {
       ostringstream value;
       value<<ts1<<" "<<ts2<<" "<<ts3;
       m_kwl.addPair( HLZ_CODING_KW, value.str() );
    }
 
    maskFnames.clear();
    ap.read("--include-regions", maskFnames);
    for(ossim_uint32 idx=0; idx<maskFnames.size(); ++idx)
    {
       key = MASK_INCLUDE_KW;
       key += ossimString::toString(idx++);
       m_kwl.addPair(key.string(), maskFnames[idx] );
    }
 
    if ( ap.read("--output-slope", sp1))
       m_kwl.addPair(SLOPE_OUTPUT_FILE_KW, ts1);
 
    vector<ossimString> pcFnames;
    ap.read("--point-clouds", pcFnames);
    for(ossim_uint32 idx=0; idx<pcFnames.size(); ++idx)
    {
       key = POINT_CLOUD_FILE_KW;
       key += ossimString::toString(idx++);
       m_kwl.addPair(key.string(), pcFnames[idx] );
    }
 
    if (ap.read("--min-lz-radius", sp1) || ap.read("--rlz", sp1))
       m_kwl.addPair(LZ_MIN_RADIUS_KW, ts1);
 
    if (ap.read("--max-roughness", sp1) || ap.read("--roughness", sp1))
       m_kwl.addPair(ROUGHNESS_THRESHOLD_KW, ts1);
 
    if (ap.read("--max-slope", sp1) || ap.read("--slope", sp1))
       m_kwl.addPair(SLOPE_THRESHOLD_KW, ts1);
 
    if (ap.read("--threads", sp1))
    {
       // Command line mode only
       m_numThreads = ossimString(ts1).toUInt32();
    }
 
    if (ap.read("--use_slope"))
    {
       // Command line mode only
       m_useLsFitMethod = false;
    }
 
    processRemainingArgs(ap);
    return true;
 }

◆ initialize() [2/2]

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

Definition at line 187 of file ossimHlzTool.cpp.

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

 {
    ossimString value;
    ostringstream xmsg;
 
    // 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 );
    }
 
    value = m_kwl.findKey(LZ_MIN_RADIUS_KW);
    if (!value.empty())
       m_hlzMinRadius = value.toDouble();
    if (m_hlzMinRadius < 1.0)
    {
       xmsg<<"ossimHlzUtil:"<<__LINE__<<"  The HLZ minimum radius is too small.";
       throw(xmsg.str());
    }
 
    value = m_kwl.findKey(ROUGHNESS_THRESHOLD_KW);
    if (!value.empty())
       m_roughnessThreshold = value.toDouble();
 
    value = m_kwl.findKey(SLOPE_THRESHOLD_KW);
    if (!value.empty())
       m_slopeThreshold = value.toDouble();
 
    value = m_kwl.findKey(HLZ_CODING_KW);
    if (!value.empty())
    {
       vector<ossimString> values = value.split(" ");
       if (values.size() == 3)
       {
          m_badLzValue = values[0].toUInt8();
          m_marginalLzValue = values[1].toUInt8();
          m_goodLzValue = values[2].toUInt8();
       }
       else
       {
          xmsg<<"ossimHlzUtil:"<<__LINE__<<"  Unexpected number of values encountered for keyword <"
                <<HLZ_CODING_KW<<">.";
          throw(xmsg.str());
       }
    }
 
    ossimChipProcTool::initialize(kwl);
 }

◆ initProcessingChain()

void ossimHlzTool::initProcessingChain ( )

protectedvirtual

Derived classes initialize their custom chains here.

Implements ossimChipProcTool.

Definition at line 238 of file ossimHlzTool.cpp.

References ossimImageChain::add(), ossimChipProcTool::combineLayers(), ossimConnectableObject::connectMyInputTo(), ossimImageDataFactory::create(), ossimSlopeFilter::DEGREES, ossimKeywordlist::findKey(), ossimRefPtr< T >::get(), ossimGrect::hasNans(), ossimIrect::hasNans(), ossimIrect::height(), ossimImageSource::initialize(), ossimImageDataFactory::instance(), loadMaskFiles(), loadPcFiles(), ossimChipProcTool::m_aoiGroundRect, ossimChipProcTool::m_aoiViewRect, m_combinedElevSource, ossimChipProcTool::m_geom, ossimChipProcTool::m_imgLayers, ossimTool::m_kwl, m_memSource, m_outBuffer, ossimChipProcTool::m_procChain, m_slopeFile, m_useLsFitMethod, ossimChipProcTool::mosaicDemSources(), OSSIM_UINT8, ossimMemoryImageSource::setImage(), ossimMemoryImageSource::setImageGeometry(), ossimSlopeFilter::setSlopeType(), ossimRefPtr< T >::valid(), and ossimIrect::width().

 {
    ostringstream xmsg;
 
    if (m_aoiGroundRect.hasNans() || m_aoiViewRect.hasNans())
    {
       xmsg<<"ossimHlzUtil:"<<__LINE__<<"  Encountered NaNs in AOI."<<ends;
       throw ossimException(xmsg.str());
    }
 
 
    // If PC provided as file on command line, Load it. This uses the output ground rect so needs to
    // be after the initialization of m_geom:
    loadPcFiles();
 
    // If threat-domes spec (or any mask) provided as file on command line, Load it:
    loadMaskFiles();
 
    // In order to use the slope filter to establish terrain quality, the elevation data needs to
    // be loaded as images, not elevation cells. Need to transfer relevant cells to image chains:
    m_combinedElevSource = mosaicDemSources();
 
    // The "chain" for this utility is just the memory source containing the output buffer:
    m_outBuffer = ossimImageDataFactory::instance()->create(0, OSSIM_UINT8, 1, m_aoiViewRect.width(),
                                                            m_aoiViewRect.height());
    if (!m_outBuffer.valid())
    {
       xmsg<<"ossimHlzUtil:"<<__LINE__<<"  Error encountered allocating output image buffer.";
       throw(xmsg.str());
    }
    m_memSource = new ossimMemoryImageSource;
    m_memSource->setImage(m_outBuffer);
    m_memSource->setImageGeometry(m_geom.get());
 
    // If input image(s) provided, need to combine them with the product:
    if (m_imgLayers.empty())
    {
       m_procChain->add(m_memSource.get());
    }
    else
    {
       ossimRefPtr<ossimImageSource> combiner = combineLayers(m_imgLayers);
       combiner->connectMyInputTo(m_memSource.get());
       m_procChain->add(combiner.get());
    }
 
    if (!m_useLsFitMethod)
    {
       // Add the slope computation engine on the elevation source.
       // Set up processing chain with plane to normal filter, equation combiner, and band selector.
       ossimRefPtr<ossimSlopeFilter> slope_filter = new ossimSlopeFilter;
       slope_filter->connectMyInputTo(m_combinedElevSource.get());
       slope_filter->setSlopeType(ossimSlopeFilter::DEGREES);
       m_combinedElevSource = slope_filter.get();
       m_combinedElevSource->initialize();
 
       m_slopeFile = m_kwl.findKey(SLOPE_OUTPUT_FILE_KW);
       if (!m_slopeFile.empty())
          writeSlopeImage();
    }
    // Determine number of posts (in one dimension) needed to cover the specified LZ radius:
    if ((m_gsd.x == 0) || (m_gsd.y == 0) || m_gsd.hasNans())
    {
       ostringstream xmsg;
       xmsg<<"ossimHlzUtil:"<<__LINE__<<"  Invalid GSD: "<<m_gsd;
       throw(xmsg.str());
    }
 
    m_demFilterSize.x = (int) ceil(m_hlzMinRadius/m_gsd.x);
    m_demFilterSize.y = (int) ceil(m_hlzMinRadius/m_gsd.y);
    if ((m_demFilterSize.x < 2) || (m_demFilterSize.y < 2))
    {
       xmsg<<"ossimHlzUtil:"<<__LINE__<<"  The DEM provided does not have sufficient"
                   " resolution to determine HLZs.";
       throw ossimException(xmsg.str());
    }
 }

◆ loadMaskFiles()

void ossimHlzTool::loadMaskFiles ( )

protected

Definition at line 355 of file ossimHlzTool.cpp.

Referenced by initProcessingChain().

 {
    ostringstream xmsg;
 
    ossimString key;
    ossimFilename mask_file;
 
   // Exclusion masks:
    for(ossim_uint32 idx=0; true; ++idx)
    {
       key = MASK_EXCLUDE_KW;
       key += ossimString::toString(idx++);
       mask_file = m_kwl.find(key.chars());
       if (mask_file.empty())
          break;
 
       MaskSource mask_image (this, mask_file, true);
       if (mask_image.image.valid())
          m_maskSources.push_back(mask_image);
    }
 
    // Inclusion masks:
    for(ossim_uint32 idx=0; true; ++idx)
    {
       key = MASK_INCLUDE_KW;
       key += ossimString::toString(idx++);
       mask_file = m_kwl.find(key.chars());
       if (mask_file.empty())
          break;
 
       // First check if the filename specified is an image file:
       MaskSource mask_image (this, mask_file, false);
       if (mask_image.image.valid())
          m_maskSources.push_back(mask_image);
    }
 }

◆ loadPcFiles()

void ossimHlzTool::loadPcFiles ( )

protected

Definition at line 316 of file ossimHlzTool.cpp.

References ossimPointCloudHandlerRegistry::instance().

Referenced by initProcessingChain().

 {
    ostringstream xmsg;
 
    ossimString key;
    ossimFilename pc_file;
    ossimPointCloudHandlerRegistry* registry = ossimPointCloudHandlerRegistry::instance();
    ossimGrect pc_bbox;
 
    for(ossim_uint32 idx=0; true; ++idx)
    {
       key = POINT_CLOUD_FILE_KW;
       key += ossimString::toString(idx++);
       pc_file = m_kwl.find(key.chars());
       if (pc_file.empty())
          break;
 
       ossimRefPtr<ossimPointCloudHandler> pc_handler =  registry->open(pc_file);
       if (!pc_handler.valid())
       {
          xmsg<<"ossimHlzUtil:"<<__LINE__<<"  Error loading point cloud file <"<<pc_file<<">.";
          throw(xmsg.str());
       }
 
       // Verify that PC bounding rect overlaps the output bounding rect:
       pc_handler->getBounds(pc_bbox);
       if (m_aoiGroundRect.intersects(pc_bbox))
       {
          m_pcSources.push_back(pc_handler);
       }
       else
       {
          ossimNotify(ossimNotifyLevel_WARN)
                << "ossimHLZUtil::loadPcFile() WARNING: point-cloud file <" << pc_file << "> "
                << "does not overlap the output ROI." << endl;
       }
    }
 }

◆ operator=()

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

protected

Hidden from use assignment operator.

◆ setProductGSD()

void ossimHlzTool::setProductGSD ( const double & meters_per_pixel )

protected

◆ setUsage()

void ossimHlzTool::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 67 of file ossimHlzTool.cpp.

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

 {
    // Add global usage options.
    ossimChipProcTool::setUsage(ap);
 
    // Set the general usage:
    ossimApplicationUsage* au = ap.getApplicationUsage();
    ossimString usageString = ap.getApplicationName();
    usageString += " hlz [options] <output-image>";
    au->setCommandLineUsage(usageString);
 
    // Set the command line options:
    au->addCommandLineOption("--exclude-regions <file1>[, <file2>...]",
          "List of raster image(s) representing mask files that defines regions to be excluded from "
          "HLZ solutions. Any non-zero pixel is excluded Multiple filenames must be comma-separated.");
    au->addCommandLineOption("--hlz-coding <bad> <marginal> <good>",
          "Specifies the pixel values (0-255) for the output product corresponding to bad, marginal, "
          "and good landing zones, respectively. Defaults to bad=255 (null), marginal=128, and "
          "good=64.");
    au->addCommandLineOption("--include-regions <file1>[, <file2>...]",
          "List of raster image(s) representing mask files that defines regions where the HLZs ."
          "identified must overlap. Any non-zero pixel represents an inclusion zone. Multiple "
          "filenames must be comma-separated.");
    au->addCommandLineOption("--output-slope <filename.tif>",
          "Generates a slope byproduct image (floating point degrees) to the specified filename. "
          "Only valid if normal-vector method used (i.e., --ls-fit option NOT specified)");
    au->addCommandLineOption("--point-clouds <file1>[, <file2>...]",
          "Specifies ancillary point-cloud data file(s) for level-2 search for obstructions. "
          "Must be comma-separated file names.");
    au->addCommandLineOption("--min-lz-radius <meters>",
          "Specifies minimum radius of landing zone. Defaults to 25 m. ");
    au->addCommandLineOption("--max-roughness <meters>",
          "Specifies the terrain roughness threshold (meters). This is the maximum deviation from a "
          "flat plane permitted. Defaults to 0.5 m. Valid only with --ls-fit specified.");
    au->addCommandLineOption("--max-slope <degrees>",
          "Threshold for acceptable landing zone terrain slope. Defaults to 7 deg.");
    au->addCommandLineOption("--threads <n>",
          "Number of threads. Defaults to use single core. For engineering/debug purposes.");
    au->addCommandLineOption("--use-slope",
          "Slope is computed from the normal vector using neighboring posts instead of "
          "least-squares fit to a plane (prefered). For engineering/debug purposes.");
 }

◆ usage()

void ossimHlzTool::usage ( ossimArgumentParser & ap )

protected

Initializes arg parser and outputs usage.

◆ writeSlopeImage()

void ossimHlzTool::writeSlopeImage ( )

protected

Definition at line 529 of file ossimHlzTool.cpp.

References ossimConnectableObject::connectMyInputTo(), ossimImageFileWriter::execute(), ossimRefPtr< T >::get(), ossimChipProcTool::m_aoiViewRect, m_combinedElevSource, m_slopeFile, ossimNotify(), ossimNotifyLevel_INFO, ossimNotifyLevel_WARN, ossimImageFileWriter::setAreaOfInterest(), ossimImageFileWriter::setFilename(), and ossimTiffWriter::setGeotiffFlag().

 {
    // Set up the writer:
    ossimRefPtr<ossimImageFileWriter> writer = 0;
    ossimTiffWriter* tif_writer = new ossimTiffWriter();
    tif_writer->setGeotiffFlag(true);
    tif_writer->setFilename(m_slopeFile);
    writer = tif_writer;
    writer->connectMyInputTo(0, m_combinedElevSource.get());
    writer->setAreaOfInterest(m_aoiViewRect);
    if (writer->execute())
       ossimNotify(ossimNotifyLevel_INFO)<<"Wrote slope image to <"<<m_slopeFile<<">."<<endl;
    else
    {
       ossimNotify(ossimNotifyLevel_WARN)<<"ossimHLZUtil::writeSlopeImage() Error encountered "
             "writing slope image to <"<<m_slopeFile<<">."<<endl;
    }
 }

Member Data Documentation

◆ d_accumT

double ossimHlzTool::d_accumT

protected

Definition at line 96 of file ossimHlzTool.h.

Referenced by computeHLZ().

◆ DESCRIPTION

const char * ossimHlzTool::DESCRIPTION

static

Initial value:

=

"Computes bitmap of helicopter landing zones given ROI and DEM."

Used by ossimUtilityFactory.

Definition at line 50 of file ossimHlzTool.h.

Referenced by ossimToolFactory::getCapabilities().

◆ m_badLzValue

ossim_uint8 ossimHlzTool::m_badLzValue

protected

Definition at line 86 of file ossimHlzTool.h.

◆ m_combinedElevSource

ossimRefPtr<ossimImageSource> ossimHlzTool::m_combinedElevSource

protected

Definition at line 90 of file ossimHlzTool.h.

Referenced by computeHLZ(), initProcessingChain(), and writeSlopeImage().

◆ m_demBuffer

ossimRefPtr<ossimImageData> ossimHlzTool::m_demBuffer

protected

Definition at line 83 of file ossimHlzTool.h.

Referenced by computeHLZ().

◆ m_demFilterSize

ossimIpt ossimHlzTool::m_demFilterSize

protected

Definition at line 82 of file ossimHlzTool.h.

Referenced by computeHLZ(), and ossimHlzTool::PatchProcessorJob::PatchProcessorJob().

◆ m_goodLzValue

ossim_uint8 ossimHlzTool::m_goodLzValue

protected

Definition at line 88 of file ossimHlzTool.h.

◆ m_hlzMinRadius

double ossimHlzTool::m_hlzMinRadius

protected

Definition at line 80 of file ossimHlzTool.h.

Referenced by computeHLZ().

◆ m_marginalLzValue

ossim_uint8 ossimHlzTool::m_marginalLzValue

protected

Definition at line 87 of file ossimHlzTool.h.

◆ m_maskSources

std::vector<MaskSource> ossimHlzTool::m_maskSources

protected

Definition at line 92 of file ossimHlzTool.h.

◆ m_memSource

ossimRefPtr<ossimMemoryImageSource> ossimHlzTool::m_memSource

protected

Definition at line 85 of file ossimHlzTool.h.

Referenced by computeHLZ(), and initProcessingChain().

◆ m_numThreads

ossim_uint32 ossimHlzTool::m_numThreads

protected

Definition at line 95 of file ossimHlzTool.h.

Referenced by computeHLZ().

◆ m_outBuffer

ossimRefPtr<ossimImageData> ossimHlzTool::m_outBuffer

protected

Definition at line 84 of file ossimHlzTool.h.

Referenced by computeHLZ(), and initProcessingChain().

◆ m_pcSources

std::vector< ossimRefPtr<ossimPointCloudHandler> > ossimHlzTool::m_pcSources

protected

Definition at line 91 of file ossimHlzTool.h.

◆ m_roughnessThreshold

double ossimHlzTool::m_roughnessThreshold

protected

Definition at line 79 of file ossimHlzTool.h.

◆ m_slopeFile

ossimFilename ossimHlzTool::m_slopeFile

protected

Definition at line 81 of file ossimHlzTool.h.

Referenced by initProcessingChain(), and writeSlopeImage().

◆ m_slopeThreshold

double ossimHlzTool::m_slopeThreshold

protected

Definition at line 78 of file ossimHlzTool.h.

◆ m_useLsFitMethod

bool ossimHlzTool::m_useLsFitMethod

protected

Definition at line 89 of file ossimHlzTool.h.

Referenced by computeHLZ(), and initProcessingChain().

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

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimHlzTool() [1/2]

◆ ~ossimHlzTool()

◆ ossimHlzTool() [2/2]

Member Function Documentation

◆ addArguments()

◆ computeHLZ()

◆ execute()

◆ getChip()

◆ getClassName()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ initProcessingChain()

◆ loadMaskFiles()

◆ loadPcFiles()

◆ operator=()

◆ setProductGSD()

◆ setUsage()

◆ usage()

◆ writeSlopeImage()

Member Data Documentation

◆ d_accumT

◆ DESCRIPTION

◆ m_badLzValue

◆ m_combinedElevSource

◆ m_demBuffer

◆ m_demFilterSize

◆ m_goodLzValue

◆ m_hlzMinRadius

◆ m_marginalLzValue

◆ m_maskSources

◆ m_memSource

◆ m_numThreads

◆ m_outBuffer

◆ m_pcSources

◆ m_roughnessThreshold

◆ m_slopeFile

◆ m_slopeThreshold

◆ m_useLsFitMethod