Polygon Volume (3D Analyst)
Summary
Calculates the volumetric and surface area between polygons of an input feature class and a terrain dataset or TIN surface.
Usage
-
The input polygons and the TIN or terrain dataset surface need to overlap in horizontal extent in order for surface area or volume to be calculated.
Syntax
| Parameter | Explanation | Data Type |
in_surface |
The input Terrain dataset or TIN surface. | Tin Layer | Terrain Layer |
in_feature_class |
The input polygon feature class. | Feature Layer |
in_height_field |
The name of the field containing polygon reference plane heights. | String |
reference_plane (Optional) |
The keyword used to indicate whether volume and surface area are calculated ABOVE the reference plane height of the polygons, or BELOW. The default is BELOW. | String |
out_volume_field (Optional) |
The name of the output field used to store the volume result. The default is Volume. | String |
surface_area_field (Optional) |
The name of the output field used to store the surface area result. The default is SArea. | String |
pyramid_level_resolution (Optional) |
The pyramid level resolution of the terrain dataset to use for interpolation. The default is 0, full resolution. | Double |
Code Sample
The following Python Window script demonstrates how to use the Polygon Volume function in immediate mode.
import arcpy
from arcpy import env
arcpy.CheckOutExtension("3D")
env.workspace = "C:/data"
arcpy.PolygonVolume_3d("sample.gdb/featuredataset/terrain", "polygon.shp", "<None>", "ABOVE", "Volume", "SArea", "5")
The following Python script demonstrates how to use the Polygon Volume function in a stand-alone script.
'''****************************************************************************
Name: PolygonVolume Example
Description: This script demonstrates how to use the
PolygonVolume tool.
****************************************************************************'''
# Import system modules
import arcpy
from arcpy import env
# Obtain a license for the ArcGIS 3D Analyst extension
arcpy.CheckOutExtension("3D")
# Set environment settings
env.workspace = "C:/data"
# Set Local Variables
inSurface = "sample.gdb/featuredataset/terrain"
inPoly = "floodplain_100.shp"
zField = "Height"
refPlane = "BELOW"
volFld = "Volume"
sAreaFld = "SArea"
#Execute PolygonVolume
arcpy.PolygonVolume_3d(inSurface, inPoly, zField, refPlane, volFld, sAreaFld)