com.esri.arcgis.geoprocessing.tools.conversiontools
Class RasterToPolyline

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.RasterToPolyline

All Implemented Interfaces:

GPTool

public class RasterToPolyline
extends AbstractGPTool

Converts a raster to polyline features. The Raster to Polyline tool is contained in the Conversion Tools tool box.

Usage tips:

• The input raster can have any cell size and may be any valid integer raster dataset.
• The Field parameter allows you to choose which attribute field of the input raster dataset will become an attribute in the output feature class. If a field is not specified, the cell values of the input raster (the VALUE field) will become a column with the heading Grid_code in the attribute table of the output feature class.

Field Summary

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

vals

Constructor Summary

RasterToPolyline()
Creates the Raster to Polyline tool with defaults.

RasterToPolyline(Object inRaster, Object outPolylineFeatures)
Creates the Raster to Polyline tool with the required parameters.

Method Summary

String	getBackgroundValue() Returns the Background value parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
double	getMinimumDangleLength() Returns the Minimum dangle length parameter of this tool .
Object	getOutPolylineFeatures() Returns the Output polyline features parameter of this tool .
Object	getRasterField() Returns the Field parameter of this tool .
String	getSimplify() Returns the Simplify polylines 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	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setMinimumDangleLength(double minimumDangleLength) Sets the Minimum dangle length parameter of this tool .
void	setOutPolylineFeatures(Object outPolylineFeatures) Sets the Output polyline features parameter of this tool .
void	setRasterField(Object rasterField) Sets the Field parameter of this tool .
void	setSimplify(String simplify) Sets the Simplify polylines 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

RasterToPolyline

public RasterToPolyline()

Creates the Raster to Polyline tool with defaults.

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

RasterToPolyline

public RasterToPolyline(Object inRaster,
                        Object outPolylineFeatures)

Creates the Raster to Polyline 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 dataset. the raster must be integer type.

outPolylineFeatures - the output feature class that will contain the converted polylines.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster dataset. the raster must be 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 dataset. the raster must be integer type. This is a required parameter.

Parameters:

inRaster - the input raster dataset. the raster must be integer type.

getOutPolylineFeatures

public Object getOutPolylineFeatures()

Returns the Output polyline features parameter of this tool . This parameter is the output feature class that will contain the converted polylines. This is a required parameter.

Returns:

the Output polyline features

setOutPolylineFeatures

public void setOutPolylineFeatures(Object outPolylineFeatures)

Sets the Output polyline features parameter of this tool . This parameter is the output feature class that will contain the converted polylines. This is a required parameter.

Parameters:

outPolylineFeatures - the output feature class that will contain the converted polylines.

getBackgroundValue

public String getBackgroundValue()

Returns the Background value parameter of this tool . This parameter is specifies the value that will identify the background cells. The raster dataset is viewed as a set of foreground cells and 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 value that will identify the background cells. The raster dataset is viewed as a set of foreground cells and background cells. The linear features are formed from the foreground cells. This is an optional parameter.

Parameters:

backgroundValue - specifies the value that will identify the background cells. The raster dataset is viewed as a set of foreground cells and background cells. The linear features are formed from the foreground cells.

getMinimumDangleLength

public double getMinimumDangleLength()

Returns the Minimum dangle length parameter of this tool . This parameter is minimum length of dangling polylines that will be retained. The default is zero. This is an optional parameter.

Returns:

the Minimum dangle length

setMinimumDangleLength

public void setMinimumDangleLength(double minimumDangleLength)

Sets the Minimum dangle length parameter of this tool . This parameter is minimum length of dangling polylines that will be retained. The default is zero. This is an optional parameter.

Parameters:

minimumDangleLength - minimum length of dangling polylines that will be retained. The default is zero.

getSimplify

public String getSimplify()

Returns the Simplify polylines parameter of this tool . This parameter is simplifies a line by removing small fluctuations or extraneous bends from it while preserving its essential shape. This is an optional parameter.

Returns:

the Simplify polylines

setSimplify

public void setSimplify(String simplify)

Sets the Simplify polylines parameter of this tool . This parameter is simplifies a line by removing small fluctuations or extraneous bends from it while preserving its essential shape. This is an optional parameter.

Parameters:

simplify - simplifies a line by removing small fluctuations or extraneous bends from it while preserving its essential shape.

getRasterField

public Object getRasterField()

Returns the Field parameter of this tool . This parameter is the field used to assign values from the cells in the input raster to the polyline features in the output dataset. it can be an integer or a string field. This is an optional parameter.

Returns:

the Field

setRasterField

public void setRasterField(Object rasterField)

Sets the Field parameter of this tool . This parameter is the field used to assign values from the cells in the input raster to the polyline features in the output dataset. it can be an integer or a string field. This is an optional parameter.

Parameters:

rasterField - the field used to assign values from the cells in the input raster to the polyline features in the output dataset. it can be an integer or a string field.

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