jwo.landserf.process
Class ScaleParamThread

java.lang.Object
  java.lang.Thread
      jwo.landserf.process.LSThread
          jwo.landserf.process.ScaleParamThread

All Implemented Interfaces:

Runnable, JWInterruptionListener

public class ScaleParamThread
extends LSThread

Calculates a given surface parameter over a range of window sizes and places the result back in the given GIS frame.

Version:

2.3, 11th September, 2008.

Author:

Jo Wood

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

ScaleParamThread(GISFrame gisFrame, ScaleSurfParam ssp)
Calculates a given surface parameter over a range of scales.

Method Summary

void	doProcessing() Performs the multiscale processing.
RasterMap	getParamAverage() Deprecated. Use getSummarySurf1() instead. This performs an identical function but its new name reflects the fact that it can return either a surface of averages or minimum values.
RasterMap	getParamVariation() Deprecated. Use getSummarySurf2() instead. This performs an identical function but its new name reflects the fact that it can return either a surface of variation or maximum values.
RasterMap	getSummarySurf1() Retrieves the newly created surface of either averages or minimum values over a range of window sizes depending on the the type of ScaleSurfParam provided in the constructor.
RasterMap	getSummarySurf2() Retrieves the newly created surface of either variation or maximum values over a range of window sizes depending on the the type of ScaleSurfParam provided in the constructor.

Methods inherited from class jwo.landserf.process.LSThread

checkStoppedThread, interruptionRequested, resetTimer, run, setErrorMessage, setFinalMessage, setMessage

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, 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

ScaleParamThread

public ScaleParamThread(GISFrame gisFrame,
                        ScaleSurfParam ssp)

Calculates a given surface parameter over a range of scales.

Parameters:

gisFrame - GIS frame containing raster to process.

ssp - Multiscale surface parameter to calculate.

Method Detail

doProcessing

public void doProcessing()

Performs the multiscale processing. Adds the surface of average parameter values as a secondary raster map, and the surface of variation of the parameter as an unselected raster map. A newly created raster map containing the average parameter values over the range of scales for each cell in the DEM, and one containing the variation of those parameters are added to the GISFrame provided to the constructor. The average parameter surface can be retrieved directly via this class's getParamAverage() method, or by calling gisFrame.getRaster2();. The raster map containing the variation in parameter values can be retrieved via getParamVariation() 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. myScaleParamThread.start()). Alternatively it can be called directly as a non-threaded process.

Specified by:

doProcessing in class LSThread

See Also:

GISFrame

getParamAverage

public RasterMap getParamAverage()

Deprecated. Use getSummarySurf1() instead. This performs an identical function but its new name reflects the fact that it can return either a surface of averages or minimum values.

Retrieves the newly created surface of either averages or minimum values over a range of window sizes depending on the the type of ScaleSurfParam provided in the constructor.

Returns:

Surface of average or minimum parameter values, or null if process yet to take place.

getSummarySurf1

public RasterMap getSummarySurf1()

Retrieves the newly created surface of either averages or minimum values over a range of window sizes depending on the the type of ScaleSurfParam provided in the constructor. The measure of average will depend on whether the original surface is measurement scale (in which case, the mean is returned) or categorical (in which case, the mode is returned).

Returns:

Surface of average or minimum parameter values, or null if process yet to take place.

getParamVariation

public RasterMap getParamVariation()

Deprecated. Use getSummarySurf2() instead. This performs an identical function but its new name reflects the fact that it can return either a surface of variation or maximum values.

Retrieves the newly created surface of either variation or maximum values over a range of window sizes depending on the the type of ScaleSurfParam provided in the constructor.

Returns:

Surface of variation or maximum parameter values, or null if process yet to take place.

getSummarySurf2

public RasterMap getSummarySurf2()

Retrieves the newly created surface of either variation or maximum values over a range of window sizes depending on the the type of ScaleSurfParam provided in the constructor. The measure of variation will depend on whether the original surface is measurement scale (in which case, the standard deviation is returned) or categorical (in which case, entropy is returned).

Returns:

Surface of variation or maximum parameter values, or null if process yet to take place.