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

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

public class Contour
extends AbstractGPTool

Creates contours or isolines from a raster surface. The Contour tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Contour works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Contour()
          Creates the Contour tool with defaults.
Contour(Object inRaster, Object outPolylineFeatures, double contourInterval)
          Creates the Contour tool with the required parameters.
 
Method Summary
 double getBaseContour()
          Returns the Base contour parameter of this tool .
 double getContourInterval()
          Returns the Contour interval parameter of this tool .
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 Object getOutPolylineFeatures()
          Returns the Output polyline features 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.
 double getZFactor()
          Returns the Z factor parameter of this tool .
 void setBaseContour(double baseContour)
          Sets the Base contour parameter of this tool .
 void setContourInterval(double contourInterval)
          Sets the Contour interval parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setOutPolylineFeatures(Object outPolylineFeatures)
          Sets the Output polyline features parameter of this tool .
 void setZFactor(double zFactor)
          Sets the Z factor 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

Contour

public Contour()
Creates the Contour tool with defaults.

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


Contour

public Contour(Object inRaster,
               Object outPolylineFeatures,
               double contourInterval)
Creates the Contour 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 - Composite Geodataset, input raster.
outPolylineFeatures - Feature Class, output contour polyline features.
contourInterval - Double, this can be any positive number.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. 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 Composite Geodataset, input raster. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, input raster.

getOutPolylineFeatures

public Object getOutPolylineFeatures()
Returns the Output polyline features parameter of this tool . This parameter is Feature Class, output contour polyline features. 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 Feature Class, output contour polyline features. This is a required parameter.

Parameters:
outPolylineFeatures - Feature Class, output contour polyline features.

getContourInterval

public double getContourInterval()
Returns the Contour interval parameter of this tool . This parameter is Double, this can be any positive number. This is a required parameter.

Returns:
the Contour interval

setContourInterval

public void setContourInterval(double contourInterval)
Sets the Contour interval parameter of this tool . This parameter is Double, this can be any positive number. This is a required parameter.

Parameters:
contourInterval - Double, this can be any positive number.

getBaseContour

public double getBaseContour()
Returns the Base contour parameter of this tool . This parameter is Double, contours are generated above and below this value as needed to cover the entire value range of the input raster. The default is zero. This is an optional parameter.

Returns:
the Base contour

setBaseContour

public void setBaseContour(double baseContour)
Sets the Base contour parameter of this tool . This parameter is Double, contours are generated above and below this value as needed to cover the entire value range of the input raster. The default is zero. This is an optional parameter.

Parameters:
baseContour - Double, contours are generated above and below this value as needed to cover the entire value range of the input raster. The default is zero.

getZFactor

public double getZFactor()
Returns the Z factor parameter of this tool . This parameter is Double, for example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). This is an optional parameter.

Returns:
the Z factor

setZFactor

public void setZFactor(double zFactor)
Sets the Z factor parameter of this tool . This parameter is Double, for example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). This is an optional parameter.

Parameters:
zFactor - Double, for example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter).

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