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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.conversiontools.FeatureToRaster
All Implemented Interfaces:
GPTool

public class FeatureToRaster
extends AbstractGPTool

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

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
FeatureToRaster()
          Creates the Feature to Raster tool with defaults.
FeatureToRaster(Object inFeatures, Object field, Object outRaster)
          Creates the Feature to Raster tool with the required parameters.
 
Method Summary
 Object getCellSize()
          Returns the Output cell size parameter of this tool .
 Object getField()
          Returns the Field parameter of this tool .
 Object getInFeatures()
          Returns the Input 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 setCellSize(Object cellSize)
          Sets the Output cell size parameter of this tool .
 void setField(Object field)
          Sets the Field parameter of this tool .
 void setInFeatures(Object inFeatures)
          Sets the Input 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

FeatureToRaster

public FeatureToRaster()
Creates the Feature to Raster tool with defaults.

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


FeatureToRaster

public FeatureToRaster(Object inFeatures,
                       Object field,
                       Object outRaster)
Creates the Feature to Raster 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:
inFeatures - Composite Geodataset, the input feature dataset to be converted to a raster dataset.
field - Field, the field used to assign values to the output raster. It can be any field of the input feature dataset's attribute table. If the input feature dataset is a point or multipoint file and contains z, this can be the Shape field.
outRaster - Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format.
Method Detail

getInFeatures

public Object getInFeatures()
Returns the Input features parameter of this tool . This parameter is Composite Geodataset, the input feature dataset to be converted to a raster dataset. This is a required parameter.

Returns:
the Input features

setInFeatures

public void setInFeatures(Object inFeatures)
Sets the Input features parameter of this tool . This parameter is Composite Geodataset, the input feature dataset to be converted to a raster dataset. This is a required parameter.

Parameters:
inFeatures - Composite Geodataset, the input feature dataset to be converted to a raster dataset.

getField

public Object getField()
Returns the Field parameter of this tool . This parameter is Field, the field used to assign values to the output raster. It can be any field of the input feature dataset's attribute table. If the input feature dataset is a point or multipoint file and contains z, this can be the Shape field. This is a required parameter.

Returns:
the Field

setField

public void setField(Object field)
Sets the Field parameter of this tool . This parameter is Field, the field used to assign values to the output raster. It can be any field of the input feature dataset's attribute table. If the input feature dataset is a point or multipoint file and contains z, this can be the Shape field. This is a required parameter.

Parameters:
field - Field, the field used to assign values to the output raster. It can be any field of the input feature dataset's attribute table. If the input feature dataset is a point or multipoint file and contains z, this can be the Shape field.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format. 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 Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format. This is a required parameter.

Parameters:
outRaster - Raster Dataset, when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format.

getCellSize

public Object getCellSize()
Returns the Output cell size parameter of this tool . This parameter is Analysis Cell Size, the default cell size is the shortest of the width or height of the extent of in_features, in the output spatial reference, divided by 250. This is an optional parameter.

Returns:
the Output cell size

setCellSize

public void setCellSize(Object cellSize)
Sets the Output cell size parameter of this tool . This parameter is Analysis Cell Size, the default cell size is the shortest of the width or height of the extent of in_features, in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:
cellSize - Analysis Cell Size, the default cell size is the shortest of the width or height of the extent of in_features, in the output spatial reference, divided by 250.

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