com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class Curvature

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

public class Curvature
extends AbstractGPTool

Calculates the curvature of a raster surface, optionally including profile and plan curvature. The Curvature tool is contained in the 3D Analyst Tools tool box.
Learn more about how Curvature works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Curvature()
          Creates the Curvature tool with defaults.
Curvature(Object inRaster, Object outCurvatureRaster)
          Creates the Curvature tool with the required parameters.
 
Method Summary
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 Object getOutCurvatureRaster()
          Returns the Output curvature raster parameter of this tool .
 Object getOutPlanCurveRaster()
          Returns the Output plan curve raster parameter of this tool .
 Object getOutProfileCurveRaster()
          Returns the Output profile curve 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.
 double getZFactor()
          Returns the Z factor parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setOutCurvatureRaster(Object outCurvatureRaster)
          Sets the Output curvature raster parameter of this tool .
 void setOutPlanCurveRaster(Object outPlanCurveRaster)
          Sets the Output plan curve raster parameter of this tool .
 void setOutProfileCurveRaster(Object outProfileCurveRaster)
          Sets the Output profile curve raster 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

Curvature

public Curvature()
Creates the Curvature tool with defaults.

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


Curvature

public Curvature(Object inRaster,
                 Object outCurvatureRaster)
Creates the Curvature 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.
outCurvatureRaster - Raster Dataset, output curvature raster dataset.
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.

getOutCurvatureRaster

public Object getOutCurvatureRaster()
Returns the Output curvature raster parameter of this tool . This parameter is Raster Dataset, output curvature raster dataset. This is a required parameter.

Returns:
the Output curvature raster

setOutCurvatureRaster

public void setOutCurvatureRaster(Object outCurvatureRaster)
Sets the Output curvature raster parameter of this tool . This parameter is Raster Dataset, output curvature raster dataset. This is a required parameter.

Parameters:
outCurvatureRaster - Raster Dataset, output curvature raster dataset.

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).

getOutProfileCurveRaster

public Object getOutProfileCurveRaster()
Returns the Output profile curve raster parameter of this tool . This parameter is Raster Dataset, this is the curvature of the surface in the direction of slope. This is an optional parameter.

Returns:
the Output profile curve raster

setOutProfileCurveRaster

public void setOutProfileCurveRaster(Object outProfileCurveRaster)
Sets the Output profile curve raster parameter of this tool . This parameter is Raster Dataset, this is the curvature of the surface in the direction of slope. This is an optional parameter.

Parameters:
outProfileCurveRaster - Raster Dataset, this is the curvature of the surface in the direction of slope.

getOutPlanCurveRaster

public Object getOutPlanCurveRaster()
Returns the Output plan curve raster parameter of this tool . This parameter is Raster Dataset, this is the curvature of the surface perpendicular to the slope direction. This is an optional parameter.

Returns:
the Output plan curve raster

setOutPlanCurveRaster

public void setOutPlanCurveRaster(Object outPlanCurveRaster)
Sets the Output plan curve raster parameter of this tool . This parameter is Raster Dataset, this is the curvature of the surface perpendicular to the slope direction. This is an optional parameter.

Parameters:
outPlanCurveRaster - Raster Dataset, this is the curvature of the surface perpendicular to the slope direction.

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