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

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

All Implemented Interfaces:

GPTool

public class Contour
extends AbstractGPTool

Creates a line feature class of contours (isolines) from a raster surface. The Contour tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Contours do not extend beyond the spatial extent of the raster, and they are not generated in areas of NoData; therefore, adjacent contour inputs should first be edgematched into a continuous feature dataset. As an alternative to edgematching, you can merge the adjacent rasters before computing contours.
• Contours can be generated in areas of negative raster values. The contour values will be negative in such areas. Negative contour intervals are not allowed.
• Smoother but less accurate contours can be obtained by pre-processing the input raster with a operation with the MEAN option or the tool with the LOW option.
• A base contour is used, for example, when you want to create contours every 15 meters, starting at 10 meters. Here, 10 would be used for the base contour, and 15 would be the contour interval. The values to be contoured would be 10, 25, 40, 55, and so on.
• Specifying a base contour does not prevent contours from being created above or below that value.

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 - the input surface raster.

outPolylineFeatures - output contour polyline features.

contourInterval - interval of contours. this can be any positive number.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input surface 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 the input surface raster. This is a required parameter.

Parameters:

inRaster - the input surface raster.

getOutPolylineFeatures

public Object getOutPolylineFeatures()

Returns the Output polyline features parameter of this tool . This parameter is 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 output contour polyline features. This is a required parameter.

Parameters:

outPolylineFeatures - output contour polyline features.

getContourInterval

public double getContourInterval()

Returns the Contour interval parameter of this tool . This parameter is interval of contours. 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 interval of contours. this can be any positive number. This is a required parameter.

Parameters:

contourInterval - interval of contours. this can be any positive number.

getBaseContour

public double getBaseContour()

Returns the Base contour parameter of this tool . This parameter is base contour value. 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 base contour value. 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 - base contour value. 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 number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. 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 number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. 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 - number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. 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