EETG_RasterVolume

Raster Volume

Calculates the Volume and Area of a raster surface above and below a horizontal reference plane defined by the user specified level or a reference raster.

Inputs:

A raster dataset representing the surface for which the analysis will be performed.
Output raster name and format
The level (Z value) of the reference plane or Overlay raster which will be used for the volume calculations
Volume Option
- Below
- Above
- Both
A reference raster to be used for volume calculation

Outputs:

An integer raster with values assigned to each zone derived from the input surface raster and the level of the reference plane.
The raster attribute table will contain the following fields
- Value - the zone ID
- ET_Volume - the volume of the zone in the units of the spatial reference of the input raster.
  - Negative values of the volume indicate areas where the Z values of the raster surface is above the level of the polygons - CUT.
  - Positive values of the volume indicate areas where the Z values of the surface is below the levels of the polygons. - FILL
- ET_Area - the area of the zone in the units of the spatial reference of the input raster
- ET_Status - Cut or Fill

Example:

Volume for a dam calculated for three different levels - 1350, 1355 and 1360 meters. The option to calculate the volume only below the reference plane used. The result rasters converted to polygons. The polygons downstream from the dam wall removed.

Notes:

The input raster must be in a projected coordinate system.
If an Overlay Raster is used it must have the same spatial reference as the Base Raster
The cells of the input raster that have the same value as the level of the plane will have assigned NODATA values
The input format accepted are file based rasters - ERDAS IMAGINE or Tagged Image File Format (TIFF).
The .NET ToolBox for ArcGIS Desktop accepts also FileGDB Raster inputs.
For file based rasters initially the name of the output raster define the raster format:
- .img extension (for example raster1.img) - ERDAS IMAGINE image.
- .tif extension (for example raster1.tif - image.
- The initial output raster format can be changed by selecting the desired output in the dialog.

Running Programmatically

(Go to TOP)

Parameters

Expression	Explanation
Function Name	RasterVolume
<input raster>	A String representing the input raster dataset.
<output raster>	A String - the full name of the output raster.
<Level>	A Double representing the Z level of the reference plane.
{VolumeOption}	A String representing the volume option. Valid values - Below - Above - Below and Above
{ReferenceRaster}	A String - full path to the reference raster dataset.

Running the function

ETSPath used in the table below is the full path to ETSRun.exe (E.G. "C:\Program Files\ETSpatial Techniques\ETSurface\ETSRun.exe")

Level

Language	Syntax
Python	subprocess.call([ETSPath, "RasterVolume", "input raster", "output raster", "Level", "VolumeOption", "ReferenceRaster"])
.NET using ETSRun.exe	StartInfo.FileName = ETSPath StartInfo.Arguments = "RasterVolume" "input raster" "output raster" "Level" "VolumeOption" "ReferenceRaster"
.NET using ETSOutX.dll	RasterVolume(input raster, output raster, Level, VolumeOption, ReferenceRaster)
ArcPy	arcpy.RasterVolume("input raster", "output raster", "Level", "VolumeOption", "ReferenceRaster")

Notes:

<> - required parameter
{} - optional parameter
See examples for Python , .NET or ArcPy
The argument separator for StartInfo.Arguments is space. If a string might contain a space, you need to double quote it.

(Go to TOP)