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 and Cell Size) 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.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

Aggregate()
Creates the Aggregate tool with defaults.

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

Method Summary

String	getAggregationType() Returns the Aggregation technique parameter of this tool .
int	getCellFactor() Returns the Cell factor parameter of this tool .
String	getExtentHandling() Returns the Expand extent if needed parameter of this tool .
String	getIgnoreNodata() Returns the Ignore NoData in calculations parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutRaster() Returns the Output raster 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.
void	setAggregationType(String aggregationType) Sets the Aggregation technique parameter of this tool .
void	setCellFactor(int cellFactor) Sets the Cell factor parameter of this tool .
void	setExtentHandling(String extentHandling) Sets the Expand extent if needed parameter of this tool .
void	setIgnoreNodata(String ignoreNodata) Sets the Ignore NoData in calculations parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(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(Object inRaster,
                 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, the input raster to aggregate.

outRaster - Raster Dataset, the raster to be created.

cellFactor - Long, the cell_factor must be an integer greater than one.

Method Detail

getInRaster

public Object getInRaster()

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

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

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

Parameters:

inRaster - Composite Geodataset, the input raster to aggregate.

getOutRaster

public 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(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, 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, the cell_factor must be an integer greater than one. This is a required parameter.

Parameters:

cellFactor - Long, the cell_factor must be an integer greater than one.

getAggregationType

public String getAggregationType()

Returns the Aggregation technique parameter of this tool . This parameter is String, sum is the default value. This is an optional parameter.

Returns:

the Aggregation technique

setAggregationType

public void setAggregationType(String aggregationType)

Sets the Aggregation technique parameter of this tool . This parameter is String, sum is the default value. This is an optional parameter.

Parameters:

aggregationType - String, sum is the default value.

getExtentHandling

public String getExtentHandling()

Returns the Expand extent if needed parameter of this tool . This parameter is String, 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(String extentHandling)

Sets the Expand extent if needed parameter of this tool . This parameter is String, 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, if the number of rows and columns in the input grid is a multiple of the cell_factor, these keywords are not used.

getIgnoreNodata

public 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(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.

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