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

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

All Implemented Interfaces:

GPTool

public class BuildPyramids
extends AbstractGPTool

Builds raster pyramids for a raster dataset. The Build Pyramids tool is contained in the Data Management Tools tool box.

Usage tips:

• Building improves the display performance of raster datasets.
• You only need to build pyramids once per dataset. The pyramids will be accessed every time you display the raster dataset.
• 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.
• 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.
• 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

BuildPyramids()
Creates the Build Pyramids tool with defaults.

BuildPyramids(Object inRasterDataset)
Creates the Build Pyramids tool with the required parameters.

Method Summary

Object	getInRasterDataset() Returns the Input Raster Dataset parameter of this tool .
Object	getOutRaster() Returns the Output Raster Dataset parameter of this tool (Read only).
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	setInRasterDataset(Object inRasterDataset) Sets the Input Raster Dataset 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

BuildPyramids

public BuildPyramids()

Creates the Build Pyramids tool with defaults.

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

BuildPyramids

public BuildPyramids(Object inRasterDataset)

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

inRasterDataset - the input raster dataset. the input should have more than 1024 rows and 1024 columns.

Method Detail

getInRasterDataset

public Object getInRasterDataset()

Returns the Input Raster Dataset parameter of this tool . This parameter is the input raster dataset. the input should have more than 1024 rows and 1024 columns. This is a required parameter.

Returns:

the Input Raster Dataset

setInRasterDataset

public void setInRasterDataset(Object inRasterDataset)

Sets the Input Raster Dataset parameter of this tool . This parameter is the input raster dataset. the input should have more than 1024 rows and 1024 columns. This is a required parameter.

Parameters:

inRasterDataset - the input raster dataset. the input should have more than 1024 rows and 1024 columns.

getOutRaster

public Object getOutRaster()

Returns the Output Raster Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Raster Dataset

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