Polygon Volume (3D Analyst)

License Level:BasicStandardAdvanced

Summary

Calculates the volume and surface area between a polygon and terrain or TIN surface.

Usage

Syntax

PolygonVolume_3d (in_surface, in_feature_class, in_height_field, {reference_plane}, {out_volume_field}, {surface_area_field}, {pyramid_level_resolution})
ParameterExplanationData Type
in_surface

The input terrain or TIN surface.

Tin Layer; Terrain Layer
in_feature_class

The input polygon feature class.

Feature Layer
in_height_field

The field in the polygon's attribute table that defines the height of the reference plane used in determining volumetric calculations.

String
reference_plane
(Optional)

Determines how volume and surface area are calculated.

  • ABOVEVolume and surface area are calculated above the reference plane height of the polygons.
  • BELOWVolume and surface area are calculated below the reference plane height of the polygons. This is the default.
String
out_volume_field
(Optional)

The name of the field in the output that will contain the volume calculated in the analysis. The default is Volume.

String
surface_area_field
(Optional)

The name of the field in the output that will contain the surface area calculated in the analysis. The default is SArea.

String
pyramid_level_resolution
(Optional)

The z-tolerance or window-size resolution of the terrain pyramid level that will be used by this tool. The default is 0, or full resolution.

Double

Code Sample

PolygonVolume example 1 (Python window)

The following sample demonstrates the use of this tool in the Python window:

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")
PolygonVolume example 2 (stand-alone script)

The following sample demonstrates the use of this tool in a stand-alone Python 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)

Environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires 3D Analyst
ArcGIS for Desktop Standard: Requires 3D Analyst
ArcGIS for Desktop Advanced: Requires 3D Analyst
3/7/2014