This tools estimates the area of each category, polygon, or patch in an input image. The input image must be categorical in data scale. The user must specify whether the output is given in Map Units or Grid Cells. Map Units are physical units, e.g. if the image's scale is in metres, Area will report in square-metres. Notice that square-metres can be converted into hectares by dividing by 10,000 and into square-kilometres by dividing by 1,000,000.
The user can specify whether they would like an image output, text output, or both. No output image is created if the Output Raster File box is left blank. At least one output type must be chosen for the tool to operate.
NoData values are ignored during the area analysis.
The following is an example of a Python script that uses this tool:
wd = pluginHost.getWorkingDirectory()
inputFile = wd + "input.dep"
outputFile = "not specified"
outputText = "true"
units = "map units"
zeroBackground = "false"
args = [inputFile, outputFile, outputText, units, zeroBackground]
pluginHost.runPlugin("Area", args, False)
This is a Groovy script also using this tool:
def wd = pluginHost.getWorkingDirectory()
def inputFile = wd + "input.dep"
def outputFile = wd + "output.dep"
def outputText = "false"
def units = "grid cells"
def zeroBackground = "false"
String args = [inputFile, outputFile, outputText, units, zeroBackground]
pluginHost.runPlugin("Area", args, false)