com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class Thin

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.Thin

All Implemented Interfaces:

GPTool

public class Thin
extends AbstractGPTool

Thins rasterized linear features by reducing the number of cells representing the width of the features. The Thin tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• A typical application for the Thin tool is for processing a scanned elevation contour map. Because of the resolution of the scanner and the width of the lines on the original map, the contours are respresented in the resulting raster as linear elements from five to ten cells wide. After running Thin, each contour will be represented as a linear feature of a single cell width.
• The FILTER option uses the same filtering algorithm as Boundary Clean to remove short linear features extending from the major branch. It can also remove features narrower than three cells.
• Specifying the maximum thickness of input linear features is essential for thinning rasters where the thickness of linear features may exceed or stay below the default maximum thickness value. The best results can be expected when the maximum thickness fits the thickest linear features to be thinned.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

Thin()
Creates the Thin tool with defaults.

Thin(Object inRaster, Object outRaster)
Creates the Thin tool with the required parameters.

Method Summary

String	getBackgroundValue() Returns the Background value parameter of this tool .
String	getCorners() Returns the Shape for corners parameter of this tool .
String	getFilter() Returns the Filter input first parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
double	getMaximumThickness() Returns the Maximum thickness of input linear features parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setBackgroundValue(String backgroundValue) Sets the Background value parameter of this tool .
void	setCorners(String corners) Sets the Shape for corners parameter of this tool .
void	setFilter(String filter) Sets the Filter input first parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setMaximumThickness(double maximumThickness) Sets the Maximum thickness of input linear features parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Thin

public Thin()

Creates the Thin tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

Thin

public Thin(Object inRaster,
            Object outRaster)

Creates the Thin tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRaster - the input raster to be thinned. it must be of integer type.

outRaster - the output thinned raster.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster to be thinned. it must be of integer type. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input raster parameter of this tool . This parameter is the input raster to be thinned. it must be of integer type. This is a required parameter.

Parameters:

inRaster - the input raster to be thinned. it must be of integer type.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output thinned raster. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output thinned raster. This is a required parameter.

Parameters:

outRaster - the output thinned raster.

getBackgroundValue

public String getBackgroundValue()

Returns the Background value parameter of this tool . This parameter is specifies the cell value that will identify the background cells. The linear features are formed from the foreground cells. This is an optional parameter.

Returns:

the Background value

setBackgroundValue

public void setBackgroundValue(String backgroundValue)

Sets the Background value parameter of this tool . This parameter is specifies the cell value that will identify the background cells. The linear features are formed from the foreground cells. This is an optional parameter.

Parameters:

backgroundValue - specifies the cell value that will identify the background cells. The linear features are formed from the foreground cells.

getFilter

public String getFilter()

Returns the Filter input first parameter of this tool . This parameter is specifies whether a filter will be applied as the first phase of thinning. This is an optional parameter.

Returns:

the Filter input first

setFilter

public void setFilter(String filter)

Sets the Filter input first parameter of this tool . This parameter is specifies whether a filter will be applied as the first phase of thinning. This is an optional parameter.

Parameters:

filter - specifies whether a filter will be applied as the first phase of thinning.

getCorners

public String getCorners()

Returns the Shape for corners parameter of this tool . This parameter is specifies whether round or sharp turns will be made at turns or junctions. it is also used during the vector conversion process to spline curves or create sharp intersections and corners. This is an optional parameter.

Returns:

the Shape for corners

setCorners

public void setCorners(String corners)

Sets the Shape for corners parameter of this tool . This parameter is specifies whether round or sharp turns will be made at turns or junctions. it is also used during the vector conversion process to spline curves or create sharp intersections and corners. This is an optional parameter.

Parameters:

corners - specifies whether round or sharp turns will be made at turns or junctions. it is also used during the vector conversion process to spline curves or create sharp intersections and corners.

getMaximumThickness

public double getMaximumThickness()

Returns the Maximum thickness of input linear features parameter of this tool . This parameter is the maximum thickness, in map units, of linear features in the input raster. the default thickness is ten times the cell size. This is an optional parameter.

Returns:

the Maximum thickness of input linear features

setMaximumThickness

public void setMaximumThickness(double maximumThickness)

Sets the Maximum thickness of input linear features parameter of this tool . This parameter is the maximum thickness, in map units, of linear features in the input raster. the default thickness is ten times the cell size. This is an optional parameter.

Parameters:

maximumThickness - the maximum thickness, in map units, of linear features in the input raster. the default thickness is ten times the cell size.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias