AREAREPORT

Raster image area report


EnvironmentsPYTHON :: EASI :: MODELER
Batch ModeYes
Quick linksDescription :: Parameters :: Parameter descriptions :: Details :: Related

Back to top

Description


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

Parameters


Name Type Length Value range
Input1: Input raster channel or layer * Raster port 1 - 1  
Bitmap: Input bitmap Bitmap port 0 - 1  
Units String 0 - 1 Square Meters, Square Kilometers, Hectares, Square Miles, Acres, Square Feet
Default: Hectares
Report String 0 - 192 See parameter description

* Required parameter
Back to top

Parameter descriptions

Input1: Input raster channel or layer

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

Bitmap: Input bitmap

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:

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.

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