AREAREPORT

Raster image area report


EnvironmentsPYTHON :: EASI :: MODELER
Quick linksDescription :: Parameters :: Parameter descriptions :: Details :: Example :: Related

Back to top

Description


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

Parameters


Name Type Caption Length Value range
FILE * String Input file name 1 - 192  
DBIC * Integer Input raster channel or layer 1 - 1  
DBIB Integer Input bitmap 0 - 1  
UNITS String Area units 0 - 17 Square Meters, Square Kilometers, Hectares, Square Miles, Acres, Square Feet
Default: Hectares
REPORT String Report mode 0 - 192 Quick links
MONITOR String Monitor mode 0 - 3 ON, OFF
Default: ON

* Required parameter
Back to top

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.

Values include:

The default value is Hectares.

REPORT

Specifies where to direct the generated report.

Available options are:

MONITOR

The program progress can be monitored by printing the percentage of processing completed. A system parameter, MONITOR, controls this activity.

Available options are:

Back to top

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.

Back to top

Example

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

EASI>FILE    = "irvine.pix"  
EASI>DBIC    = 1                 ! Use raster channel 1 as input
EASI>DBIB    =                   ! Not using DBIB
EASI>UNITS   =                   ! Defaults to 'Hectares'

EASI> run areareport

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.