jwo.landserf.process
Class ScaleSurfParam

java.lang.Object
  jwo.landserf.process.ScaleSurfParam

public class ScaleSurfParam

extends Object

Calculates surface parameters from a raster map over a range scales.

Version:

2.2, 4th March, 2004.

Author:

Jo Wood

Field Summary

static int	AVERAGE Indicates multiscale summary should be in form of mean and dispersion.
static int	RANGE Indicates multiscale summary should be in form of minimum and maximum.

Constructor Summary

ScaleSurfParam(GISFrame gisFrame, int pt, int st, boolean isSurface)
Sets up a surface ready for parameterisation (slope, aspect etc.) or feature extraction from a raster surface.

ScaleSurfParam(RasterMap s, int pt, int st, boolean isSurface)
Sets up a surface ready for parameterisation (slope, aspect etc.) or feature extraction from a raster surface.

Method Summary

void	calcParams() Calculates a surface parameter (slope, aspect etc.) for an entire raster over a range of scales.
void	calcParams(float e, float n) Calculates a surface parameter (slope, aspect etc.) at a single point over a given range of scales.
int	getMaxWSize() Returns the maximum size window used for scale-based parameterisation.
float[]	getParam() Returns the array holding surface parameter results.
float	getParamAverage() Returns the average parameter value for a particular point over a given range of scales.
RasterMap	getParamAverageSurf() Returns a surface of average parameter values over a given range of scales.
float	getParamMax() Returns the maximum parameter value for a particular point over a given range of scales.
float	getParamMin() Returns the minimum parameter value for a particular point over a given range of scales.
int	getParamType() Returns the type of parameter type calculated.
float	getParamVariation() Returns the variation of parameter values for a particular point over a given range of scales.
RasterMap	getParamVariationSurf() Returns a surface of variation measures of parameter valuess over a given range of scales.
void	setCallingThread(LSThread lsThread) Passes the thread that calls this process to the processor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AVERAGE

public static final int AVERAGE

Indicates multiscale summary should be in form of mean and dispersion.

See Also:

Constant Field Values

RANGE

public static final int RANGE

Indicates multiscale summary should be in form of minimum and maximum.

See Also:

Constant Field Values

Constructor Detail

ScaleSurfParam

public ScaleSurfParam(RasterMap s,
                      int pt,
                      int st,
                      boolean isSurface)

Sets up a surface ready for parameterisation (slope, aspect etc.) or feature extraction from a raster surface. The calculations done here are dependent on the window size, so an array of quadratic objects is created, each element storing values at a different scale.

Parameters:

s - RasterMap object to calculate parameter from.

pt - Parameter type to calculate.

st - Summary type (either RANGE or AVERAGE).

isSurface - Flag indicating whole surface to be calculated.

ScaleSurfParam

public ScaleSurfParam(GISFrame gisFrame,
                      int pt,
                      int st,
                      boolean isSurface)

Sets up a surface ready for parameterisation (slope, aspect etc.) or feature extraction from a raster surface. The calculations done here are dependent on the window size, so an array of quadratic objects are created, each one storing values at a different scale.

Parameters:

gisFrame - GUI holding the raster DEM from which to calculate parameter.

pt - Parameter type to calculate.

st - Summary type (either RANGE or AVERAGE).

isSurface - Flag indicating whole surface to be calculated.

Method Detail

calcParams

public void calcParams(float e,
                       float n)

Calculates a surface parameter (slope, aspect etc.) at a single point over a given range of scales.

Parameters:

e - Easting of point to parameterise.

n - Northing of point to parameterise.

setCallingThread

public void setCallingThread(LSThread lsThread)

Passes the thread that calls this process to the processor. If provided, this allows the processing to be interrupted. Typical use is to allow the user to interrupt the processing of large rasters or large range of scales. This method does not need to be called if processing is not to be interrupted.

Parameters:

lsThread - Thread that called this process.

calcParams

public void calcParams()

Calculates a surface parameter (slope, aspect etc.) for an entire raster over a range of scales.

getParamType

public int getParamType()

Returns the type of parameter type calculated.

Returns:

Type of scale-based parameterisation.

See Also:

SurfParam

getParam

public float[] getParam()

Returns the array holding surface parameter results.

Returns:

Array holding scale-based parameterisation.

getParamAverage

public float getParamAverage()

Returns the average parameter value for a particular point over a given range of scales.

Returns:

Average surface parameter value over range of scales.

getParamVariation

public float getParamVariation()

Returns the variation of parameter values for a particular point over a given range of scales.

Returns:

Variation measure of surface parameter value over a range of scales.

getParamMin

public float getParamMin()

Returns the minimum parameter value for a particular point over a given range of scales.

Returns:

Average surface parameter value over range of scales.

getParamMax

public float getParamMax()

Returns the maximum parameter value for a particular point over a given range of scales.

Returns:

Variation measure of surface parameter value over a range of scales.

getParamAverageSurf

public RasterMap getParamAverageSurf()

Returns a surface of average parameter values over a given range of scales.

Returns:

Surface of average parameter values.

getParamVariationSurf

public RasterMap getParamVariationSurf()

Returns a surface of variation measures of parameter valuess over a given range of scales.

Returns:

Surface of variation of parameter values.

getMaxWSize

public int getMaxWSize()

Returns the maximum size window used for scale-based parameterisation.

Returns:

Maximum window size.