com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class BatchBuildPyramids

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.BatchBuildPyramids

All Implemented Interfaces:

GPTool

public class BatchBuildPyramids

extends AbstractGPTool

Allows you to build pyramids for multiple raster datasets. The Batch Build Pyramids tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• Building pyramids for a raster dataset will improve the display performance of large raster datasets.
• Pyramids can only be built for raster datasets that do not have internal pyramids.
• Pyramids cannot be built for raster catalogs, but they can be built for each raster catalog item.
• The input raster datasets can be any valid raster dataset that ArcGIS recognizes and that does not have an internal pyramid structure.
• Batch building of pyramids is useful when you have a large directory of raster datasets that do not have pyramids or to build pyramids on the items of a raster catalog (drag and drop them into the dialog box).
• The following environment settings affect this tool: current workspace; and pyramid; (except for GRID, IMG, and TIFF formats).

Field Summary

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

vals

Constructor Summary

BatchBuildPyramids()
Creates the Batch Build Pyramids tool with defaults.

BatchBuildPyramids(java.lang.Object inputRasterDatasets)
Creates the Batch Build Pyramids tool with the required parameters.

Method Summary

java.lang.String	getBatchBuildPyramidsSucceeded() Returns the Batch Build Pyramids Succeeded parameter of this tool (Read only).
java.lang.Object	getInputRasterDatasets() Returns the Input Raster Datasets 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	setInputRasterDatasets(java.lang.Object inputRasterDatasets) Sets the Input Raster Datasets 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

BatchBuildPyramids

public BatchBuildPyramids()

Creates the Batch Build Pyramids tool with defaults.

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

BatchBuildPyramids

public BatchBuildPyramids(java.lang.Object inputRasterDatasets)

Creates the Batch Build Pyramids 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:

inputRasterDatasets - Raster Dataset, the input raster datasets that you want to build a raster pyramids for.

Method Detail

getInputRasterDatasets

public java.lang.Object getInputRasterDatasets()

Returns the Input Raster Datasets parameter of this tool . This parameter is Raster Dataset, the input raster datasets that you want to build a raster pyramids for. This is a required parameter.

Returns:

the Input Raster Datasets

setInputRasterDatasets

public void setInputRasterDatasets(java.lang.Object inputRasterDatasets)

Sets the Input Raster Datasets parameter of this tool . This parameter is Raster Dataset, the input raster datasets that you want to build a raster pyramids for. This is a required parameter.

Parameters:

inputRasterDatasets - Raster Dataset, the input raster datasets that you want to build a raster pyramids for.

getBatchBuildPyramidsSucceeded

public java.lang.String getBatchBuildPyramidsSucceeded()

Returns the Batch Build Pyramids Succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:

the Batch Build Pyramids Succeeded

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