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

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

All Implemented Interfaces:

GPTool

public class Aggregate

extends AbstractGPTool

Generates a reduced resolution version of a raster. The Aggregate tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Aggregate works

Software restrictions: none

Illustration:

Usage tips:

• If the values of the input raster are integers and any statistics type option other than Mean is used, the output raster will be integer. If the values of the input raster are floating point or the statistics type is Mean, the output raster will be floating point.
• The geoprocessing analysis environment (Extent, Cell Size, and Mask) is recognized by the Aggregate function. To determine the output raster's resolution when an integer cell size has been specified, multiply the cell resolution of the analysis environment by the input cell factor parameter. If the cell size for the analysis environment is set to the minimum or maximum of the inputs, the resolution of the output raster will be the product of the input raster's resolution multiplied by the specified cell factor.

Field Summary

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

vals

Constructor Summary

Aggregate()
Creates the Aggregate tool with defaults.

Aggregate(java.lang.Object inRaster, java.lang.Object outRaster, int cellFactor)
Creates the Aggregate tool with the required parameters.

Method Summary

java.lang.String	getAggregationType() Returns the Aggregation technique parameter of this tool .
int	getCellFactor() Returns the Cell factor parameter of this tool .
java.lang.String	getExtentHandling() Returns the Expand extent if needed parameter of this tool .
java.lang.String	getIgnoreNodata() Returns the Ignore NoData in calculations parameter of this tool .
java.lang.Object	getInRaster() Returns the Input raster parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setAggregationType(java.lang.String aggregationType) Sets the Aggregation technique parameter of this tool .
void	setCellFactor(int cellFactor) Sets the Cell factor parameter of this tool .
void	setExtentHandling(java.lang.String extentHandling) Sets the Expand extent if needed parameter of this tool .
void	setIgnoreNodata(java.lang.String ignoreNodata) Sets the Ignore NoData in calculations parameter of this tool .
void	setInRaster(java.lang.Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(java.lang.Object outRaster) Sets the Output raster 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

Aggregate

public Aggregate()

Creates the Aggregate tool with defaults.

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

Aggregate

public Aggregate(java.lang.Object inRaster,
                 java.lang.Object outRaster,
                 int cellFactor)

Creates the Aggregate 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:

inRaster - Composite Geodataset, input raster.

outRaster - Raster Dataset, the raster to be created.

cellFactor - Long, factor by which to multiply the cell size of the input raster to obtain the desired resolution for the output raster. A cell_factor of three would result in an output cell size three times larger than that of the input raster. The cell_factor must be an integer greater than one.

Method Detail

getInRaster

public java.lang.Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(java.lang.Object inRaster)

Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, input raster.

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getCellFactor

public int getCellFactor()

Returns the Cell factor parameter of this tool . This parameter is Long, factor by which to multiply the cell size of the input raster to obtain the desired resolution for the output raster. A cell_factor of three would result in an output cell size three times larger than that of the input raster. The cell_factor must be an integer greater than one. This is a required parameter.

Returns:

the Cell factor

setCellFactor

public void setCellFactor(int cellFactor)

Sets the Cell factor parameter of this tool . This parameter is Long, factor by which to multiply the cell size of the input raster to obtain the desired resolution for the output raster. A cell_factor of three would result in an output cell size three times larger than that of the input raster. The cell_factor must be an integer greater than one. This is a required parameter.

Parameters:

cellFactor - Long, factor by which to multiply the cell size of the input raster to obtain the desired resolution for the output raster. A cell_factor of three would result in an output cell size three times larger than that of the input raster. The cell_factor must be an integer greater than one.

getAggregationType

public java.lang.String getAggregationType()

Returns the Aggregation technique parameter of this tool . This parameter is String, establishes how the value for each output cell will be determined. The output value for each cell can be the sum, maximum, mean, median, or minimum value of the input cells that the coarser output cell will encompass. Sum is the default value. This is an optional parameter.

Returns:

the Aggregation technique

setAggregationType

public void setAggregationType(java.lang.String aggregationType)

Sets the Aggregation technique parameter of this tool . This parameter is String, establishes how the value for each output cell will be determined. The output value for each cell can be the sum, maximum, mean, median, or minimum value of the input cells that the coarser output cell will encompass. Sum is the default value. This is an optional parameter.

Parameters:

aggregationType - String, establishes how the value for each output cell will be determined. The output value for each cell can be the sum, maximum, mean, median, or minimum value of the input cells that the coarser output cell will encompass. Sum is the default value.

getExtentHandling

public java.lang.String getExtentHandling()

Returns the Expand extent if needed parameter of this tool . This parameter is String, defines how to handle the boundaries of the input raster when its rows or columns are not a multiple of the cell factor. If the number of rows and columns in the input grid is a multiple of the cell_factor, these keywords are not used. This is an optional parameter.

Returns:

the Expand extent if needed

setExtentHandling

public void setExtentHandling(java.lang.String extentHandling)

Sets the Expand extent if needed parameter of this tool . This parameter is String, defines how to handle the boundaries of the input raster when its rows or columns are not a multiple of the cell factor. If the number of rows and columns in the input grid is a multiple of the cell_factor, these keywords are not used. This is an optional parameter.

Parameters:

extentHandling - String, defines how to handle the boundaries of the input raster when its rows or columns are not a multiple of the cell factor. If the number of rows and columns in the input grid is a multiple of the cell_factor, these keywords are not used.

• EXPAND — Expands the bottom or right boundaries of the input raster so the total number of cells in a row or column is a multiple of the cell_factor. Expanded cells are given a value of NoData. With this option, the output raster can cover a larger spatial extent than the input raster.
• TRUNCATE — Reduces the number of rows or columns in the output raster by one. This will truncate the remaining cells on the bottom or right boundaries of the input raster, making the number of rows or columns in the input raster a multiple of the cell_factor. With this option, the output raster can cover a smaller spatial extent than the input raster.

getIgnoreNodata

public java.lang.String getIgnoreNodata()

Returns the Ignore NoData in calculations parameter of this tool . This parameter is String, denotes whether NoData values are ignored by the aggregation calculation. This is an optional parameter.

Returns:

the Ignore NoData in calculations

setIgnoreNodata

public void setIgnoreNodata(java.lang.String ignoreNodata)

Sets the Ignore NoData in calculations parameter of this tool . This parameter is String, denotes whether NoData values are ignored by the aggregation calculation. This is an optional parameter.

Parameters:

ignoreNodata - String, denotes whether NoData values are ignored by the aggregation calculation.

• DATA — Specifies that if NoData values exist for any of the cells that fall within the spatial extent of a larger cell on the output raster, the NoData values will be ignored when determining the value for output cell locations. Only input cells within the extent of the output cell that have data values will be used in determining the value of the output cell.
• NODATA — Specifies that if any cell that falls within the spatial extent of a larger cell on the output raster has a value of NoData, the value for that output cell location will be NoData. When the NODATA keyword is used, it is implied that when cells within an aggregation contain the NoData value, there is insufficient information to perform the specified calculations necessary to determine an output value.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias