jwo.landserf.process
Class PitRemovalThread

java.lang.Object
  extended byjava.lang.Thread
      extended byjwo.landserf.process.LSThread
          extended byjwo.landserf.process.PitRemovalThread
All Implemented Interfaces:
JWInterruptionListener, Runnable

public class PitRemovalThread
extends LSThread

Detects pits in a DEM and creates a pitless surface. This is useful for hydrological analysis that requires all cells to drain to the boundary of the DEM.

Version:
2.2, 26th February, 2005.
Author:
Jo Wood

Field Summary
 
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
 
Constructor Summary
PitRemovalThread(GISFrame gisFrame)
          Processes the primary DEM by identifying pits and creates a new pitless surface.
 
Method Summary
 void doProcessing()
          Removes pits from the DEM stored as the primary raster in the GISFrame provided to the constructor into TIN representation.
 RasterMap getPitlessMap()
          Retrieves the newly created pitless DEM.
 RasterMap getPitMap()
          Retrieves the newly created raster map containing pits removed from DEM.
 
Methods inherited from class jwo.landserf.process.LSThread
checkStoppedThread, interruptionRequested, resetTimer, run, setErrorMessage, setMessage
 
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, sleep, sleep, start, stop, stop, suspend, toString, yield
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PitRemovalThread

public PitRemovalThread(GISFrame gisFrame)
Processes the primary DEM by identifying pits and creates a new pitless surface.

Parameters:
gisFrame - GISFrame holding DEM to process.
Method Detail

doProcessing

public void doProcessing()
Removes pits from the DEM stored as the primary raster in the GISFrame provided to the constructor into TIN representation. A newly created raster map containing the pitless DEM and one containing the location and depth of pits are added to the GISFrame provided to the constructor. The pitless DEM can be retrieved directly via this class's getPitlessMap() method, or by calling gisFrame.getRaster2();. The raster map containing pits can be retrieved via getPitMap() or by calling gisFrame.getRasters() and selecting the last raster map added.

Note that this method will be called automatically if this is run as a threaded process (e.g. myPitRemovalThread.start()). Alternatively it can be called directly as a non-threaded process.

Specified by:
doProcessing in class LSThread
See Also:
GISFrame

getPitlessMap

public RasterMap getPitlessMap()
Retrieves the newly created pitless DEM.

Returns:
New pitless DEM, or null if process yet to take place.

getPitMap

public RasterMap getPitMap()
Retrieves the newly created raster map containing pits removed from DEM.

Returns:
New pits map, or null if process yet to take place.


Copyright Jo Wood, 1996-2005, last modified, 11th March, 2005