com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class ZonalHistogram

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ZonalHistogram

All Implemented Interfaces:

GPTool

public class ZonalHistogram
extends AbstractGPTool

Creates a table and a histogram graph that shows the amount of cells of a Value input for each unique Zone. The Zonal Histogram tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• A zone is all the cells in a raster with the same value. Zones can be classes defined in the renderer of the raster layer. Zones can also be from a polygon feature class.
• A zonal histogram enables you to investigate the frequency distribution of values in one dataset within classes of another dataset. Examples include slope distribution within land use classes, rainfall distribution within elevation classes, or crime distribution by police beat.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

ZonalHistogram()
Creates the Zonal Histogram tool with defaults.

ZonalHistogram(Object inZoneData, Object zoneField, Object inValueRaster, Object outTable)
Creates the Zonal Histogram tool with the required parameters.

Method Summary

Object	getInValueRaster() Returns the Input value raster parameter of this tool .
Object	getInZoneData() Returns the Input raster or feature zone data parameter of this tool .
Object	getOutGraph() Returns the Output graph name parameter of this tool .
Object	getOutTable() Returns the Output table parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
Object	getZoneField() Returns the Zone field parameter of this tool .
void	setInValueRaster(Object inValueRaster) Sets the Input value raster parameter of this tool .
void	setInZoneData(Object inZoneData) Sets the Input raster or feature zone data parameter of this tool .
void	setOutGraph(Object outGraph) Sets the Output graph name parameter of this tool .
void	setOutTable(Object outTable) Sets the Output table parameter of this tool .
void	setZoneField(Object zoneField) Sets the Zone field parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ZonalHistogram

public ZonalHistogram()

Creates the Zonal Histogram tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

ZonalHistogram

public ZonalHistogram(Object inZoneData,
                      Object zoneField,
                      Object inValueRaster,
                      Object outTable)

Creates the Zonal Histogram tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inZoneData - dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer.

zoneField - field that holds the values that define each zone. it can be an integer or a string field of the zone dataset.

inValueRaster - the raster values to create the histograms.

outTable - the output table file. The graph is created from the table.

Method Detail

getInZoneData

public Object getInZoneData()

Returns the Input raster or feature zone data parameter of this tool . This parameter is dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer. This is a required parameter.

Returns:

the Input raster or feature zone data

setInZoneData

public void setInZoneData(Object inZoneData)

Sets the Input raster or feature zone data parameter of this tool . This parameter is dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer. This is a required parameter.

Parameters:

inZoneData - dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer.

getZoneField

public Object getZoneField()

Returns the Zone field parameter of this tool . This parameter is field that holds the values that define each zone. it can be an integer or a string field of the zone dataset. This is a required parameter.

Returns:

the Zone field

setZoneField

public void setZoneField(Object zoneField)

Sets the Zone field parameter of this tool . This parameter is field that holds the values that define each zone. it can be an integer or a string field of the zone dataset. This is a required parameter.

Parameters:

zoneField - field that holds the values that define each zone. it can be an integer or a string field of the zone dataset.

getInValueRaster

public Object getInValueRaster()

Returns the Input value raster parameter of this tool . This parameter is the raster values to create the histograms. This is a required parameter.

Returns:

the Input value raster

setInValueRaster

public void setInValueRaster(Object inValueRaster)

Sets the Input value raster parameter of this tool . This parameter is the raster values to create the histograms. This is a required parameter.

Parameters:

inValueRaster - the raster values to create the histograms.

getOutTable

public Object getOutTable()

Returns the Output table parameter of this tool . This parameter is the output table file. The graph is created from the table. This is a required parameter.

Returns:

the Output table

setOutTable

public void setOutTable(Object outTable)

Sets the Output table parameter of this tool . This parameter is the output table file. The graph is created from the table. This is a required parameter.

Parameters:

outTable - the output table file. The graph is created from the table.

getOutGraph

public Object getOutGraph()

Returns the Output graph name parameter of this tool . This parameter is the name of the output graph for display. This is an optional parameter.

Returns:

the Output graph name

setOutGraph

public void setOutGraph(Object outGraph)

Sets the Output graph name parameter of this tool . This parameter is the name of the output graph for display. This is an optional parameter.

Parameters:

outGraph - the name of the output graph for display.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias