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

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

All Implemented Interfaces:

GPTool

public class RasterToPolygon
extends AbstractGPTool

Converts a raster dataset to polygon features. The Raster to Polygon tool is contained in the Conversion Tools tool box.

Usage tips:

• The input raster can have any cell size and must be a 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

RasterToPolygon()
Creates the Raster to Polygon tool with defaults.

RasterToPolygon(Object inRaster, Object outPolygonFeatures)
Creates the Raster to Polygon tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutPolygonFeatures() Returns the Output polygon features parameter of this tool .
Object	getRasterField() Returns the Field parameter of this tool .
String	getSimplify() Returns the Simplify polygons 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	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutPolygonFeatures(Object outPolygonFeatures) Sets the Output polygon features parameter of this tool .
void	setRasterField(Object rasterField) Sets the Field parameter of this tool .
void	setSimplify(String simplify) Sets the Simplify polygons 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

RasterToPolygon

public RasterToPolygon()

Creates the Raster to Polygon tool with defaults.

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

RasterToPolygon

public RasterToPolygon(Object inRaster,
                       Object outPolygonFeatures)

Creates the Raster to Polygon 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.

outPolygonFeatures - the output feature class that will contain the converted polygons.

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.

getOutPolygonFeatures

public Object getOutPolygonFeatures()

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

Returns:

the Output polygon features

setOutPolygonFeatures

public void setOutPolygonFeatures(Object outPolygonFeatures)

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

Parameters:

outPolygonFeatures - the output feature class that will contain the converted polygons.

getSimplify

public String getSimplify()

Returns the Simplify polygons parameter of this tool . This parameter is determines if the output polygons will be smoothed into simpler shapes or conform to the input raster's cell edges. This is an optional parameter.

Returns:

the Simplify polygons

setSimplify

public void setSimplify(String simplify)

Sets the Simplify polygons parameter of this tool . This parameter is determines if the output polygons will be smoothed into simpler shapes or conform to the input raster's cell edges. This is an optional parameter.

Parameters:

simplify - determines if the output polygons will be smoothed into simpler shapes or conform to the input raster's cell edges.

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 polygons 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 polygons 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 polygons 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