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

Builds pyramids for multiple raster datasets. The Batch Build Pyramids tool is contained in the Data Management Tools tool box.

Usage tips:

• Building improves the display performance of raster datasets.
• 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 them into the dialog box).
• Wavelet compressed raster datasets, such as ECW, JPEG 2000, and MrSID, do not need to have pyramids built. These formats have internal pyramids that are created upon encoding.
• Pyramids will not be built for raster datasets that have less than 1024 pixels in the row or column. Pyramids are not needed since the raster dataset is small enough, and building pyramids will not help increase the performance.
• Pyramids cannot be built for raster catalogs, but they can be built for each raster catalog item.
• You can choose the compression type for your overview pyramid file, in the Raster Storage Environment Settings. Compression will create a smaller .ovr file. The IMAGINE format and older versions of ArcGIS will create reduced resolution dataset (.rrd) files, where compression is not available.
• The default pyramid compression will use the optimal compression type, given the type of data. You can manually choose to have LZ77, JPEG, or no compression.
• JPEG compression can only be used with file formats that can store data according to the JPEG specifications.

Field Summary

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

vals

Constructor Summary

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

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

Method Summary

String	getBatchBuildPyramidsSucceeded() Returns the Batch Build Pyramids Succeeded parameter of this tool (Read only).
Object	getInputRasterDatasets() Returns the Input Raster Datasets 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	setInputRasterDatasets(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(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 - the input raster datasets that you want to build raster pyramids for. each input should have more than 1024 rows and 1024 columns.

Method Detail

getInputRasterDatasets

public Object getInputRasterDatasets()

Returns the Input Raster Datasets parameter of this tool . This parameter is the input raster datasets that you want to build raster pyramids for. each input should have more than 1024 rows and 1024 columns. This is a required parameter.

Returns:

the Input Raster Datasets

setInputRasterDatasets

public void setInputRasterDatasets(Object inputRasterDatasets)

Sets the Input Raster Datasets parameter of this tool . This parameter is the input raster datasets that you want to build raster pyramids for. each input should have more than 1024 rows and 1024 columns. This is a required parameter.

Parameters:

inputRasterDatasets - the input raster datasets that you want to build raster pyramids for. each input should have more than 1024 rows and 1024 columns.

getBatchBuildPyramidsSucceeded

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