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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.SurfaceVolume

All Implemented Interfaces:

GPTool

public class SurfaceVolume
extends AbstractGPTool

Calculates the area and volume of a raster or TIN surface above or below a given reference plane. The Surface Volume tool is contained in the 3D Analyst Tools tool box.
Learn more about how Surface Volume (3D Analyst) works

Software restrictions: none

Illustration:

Usage tips:

• To determine the volume of an isolated portion of a TIN surface, use the Add Feature Class To TIN tool to add a clip polygon defining your study area.
• Using a z factor is essential for correct volume calculations when the surface z units are expressed in a different unit of measure than the ground units. Using a z factor does not modify the original data.
• The following environment settings affect this tool:

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SurfaceVolume()
Creates the Surface Volume tool with defaults.

SurfaceVolume(Object inSurface)
Creates the Surface Volume tool with the required parameters.

Method Summary

double	getBaseZ() Returns the Plane Height parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
Object	getOutTextFile() Returns the Output Text File parameter of this tool .
String	getReferencePlane() Returns the Reference Plane 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	setBaseZ(double baseZ) Sets the Plane Height parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setOutTextFile(Object outTextFile) Sets the Output Text File parameter of this tool .
void	setReferencePlane(String referencePlane) Sets the Reference Plane 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

SurfaceVolume

public SurfaceVolume()

Creates the Surface Volume tool with defaults.

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

SurfaceVolume

public SurfaceVolume(Object inSurface)

Creates the Surface Volume 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:

inSurface - Tin Layer | Raster Layer, the input raster or TIN surface used for calculating area and volume.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is Tin Layer | Raster Layer, the input raster or TIN surface used for calculating area and volume. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is Tin Layer | Raster Layer, the input raster or TIN surface used for calculating area and volume. This is a required parameter.

Parameters:

inSurface - Tin Layer | Raster Layer, the input raster or TIN surface used for calculating area and volume.

getOutTextFile

public Object getOutTextFile()

Returns the Output Text File parameter of this tool . This parameter is File, the output text file. This is an optional parameter.

Returns:

the Output Text File

setOutTextFile

public void setOutTextFile(Object outTextFile)

Sets the Output Text File parameter of this tool . This parameter is File, the output text file. This is an optional parameter.

Parameters:

outTextFile - File, the output text file.

getReferencePlane

public String getReferencePlane()

Returns the Reference Plane parameter of this tool . This parameter is String, choose whether to calculate above or below a given height. By default, volume is calculated above base z. This is an optional parameter.

Returns:

the Reference Plane

setReferencePlane

public void setReferencePlane(String referencePlane)

Sets the Reference Plane parameter of this tool . This parameter is String, choose whether to calculate above or below a given height. By default, volume is calculated above base z. This is an optional parameter.

Parameters:

referencePlane - String, choose whether to calculate above or below a given height. By default, volume is calculated above base z.

getBaseZ

public double getBaseZ()

Returns the Plane Height parameter of this tool . This parameter is Double, the surface value from which the area and volume will be calculated. By default, the value is the surface minimum for ABOVE and the surface maximum for BELOW. This is an optional parameter.

Returns:

the Plane Height

setBaseZ

public void setBaseZ(double baseZ)

Sets the Plane Height parameter of this tool . This parameter is Double, the surface value from which the area and volume will be calculated. By default, the value is the surface minimum for ABOVE and the surface maximum for BELOW. This is an optional parameter.

Parameters:

baseZ - Double, the surface value from which the area and volume will be calculated. By default, the value is the surface minimum for ABOVE and the surface maximum for BELOW.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is Double, the factor by which the heights of the input surface will be multiplied to calculate surface volume. Used for converting z units to match x,y units. 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, the factor by which the heights of the input surface will be multiplied to calculate surface volume. Used for converting z units to match x,y units. This is an optional parameter.

Parameters:

zFactor - Double, the factor by which the heights of the input surface will be multiplied to calculate surface volume. Used for converting z units to match x,y units.

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