AREAREPORT

Description

AREAREPORT calculates the total area for each pixel value in a raster image.

Parameters

areareport(file, dbic, dbib, units)

Name	Type	Caption	Length	Value range
FILE *	str	Input file name	1 -
DBIC *	List[int]	Input raster channel or layer	1 - 1
DBIB	List[int]	Input bitmap	0 - 1
UNITS	str	Area units	0 - 17	Square Meters, Square Kilometers, Hectares, Square Miles, Acres, Square Feet Default: Hectares

* Required parameter

Parameter descriptions

FILE

Specifies the name of the PCIDSK database file that contains the input raster image.

DBIC

Specifies the input raster channel or layer to use in generating the report. The raster can be of any data type.

DBIB

If specified, the report is generated only for pixels under the bitmap.

UNITS

Specifies the area units to use in the report.

The default value is Hectares.

Details

The report generated from AREAREPORT enumerates every pixel in the raster along with its description (from metadata), the percentage of the total area covered by the pixel, the cumulative percentage, the total number of pixels, and the area in units specified by the user. If no metadata entry is available for the description, the name is listed from any existing in the metadata.

Optionally, the report can be generated for only the pixel values that fall under a specified bitmap.

Pixels with a NO_DATA_VALUE are omitted from the report.

Example

Calculate the area report for raster channel 1 of irvine.pix with 'Hectares' area units.

from pci.areareport import areareport

file     =  "irvine.pix"
dbic     =  [1]	# Use raster channel 1 as input
dbib     = [] 	# Not using DBIB
units    = '' 	# Defaults to 'Hectares'

areareport( file, dbic, dbib, units )