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

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

All Implemented Interfaces:

GPTool

public class BuildPyramidsandStatistics
extends AbstractGPTool

Traverses a folder structure, building pyramids and calculating statistics for all the raster datasets it contains. It can also build pyramids and calculate statistics for all the items in a raster catalog or mosaic dataset. The Build Pyramids And Statistics tool is contained in the Data Management Tools tool box.

Usage tips:

• Building improves the display performance of raster datasets.
• Calculating allows ArcGIS applications to properly stretch and symbolize raster data for display.
• All supported raster formats will be processed.
• Raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.
• 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.
• Skip factors and pyramid resampling can be set in the geoprocessing environment .

Field Summary

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

vals

Constructor Summary

BuildPyramidsandStatistics()
Creates the Build Pyramids And Statistics tool with defaults.

BuildPyramidsandStatistics(Object inWorkspace)
Creates the Build Pyramids And Statistics tool with the required parameters.

Method Summary

String	getBUILDONSOURCE() Returns the Include Source Datasets parameter of this tool .
String	getBuildPyramids() Returns the Build Pyramids parameter of this tool .
String	getCalculateStatistics() Returns the Calculate Statistics parameter of this tool .
String	getIncludeSubdirectories() Returns the Include Sub-directories parameter of this tool .
Object	getInWorkspace() Returns the Input Data or Workspace parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace 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	setBUILDONSOURCE(String bUILDONSOURCE) Sets the Include Source Datasets parameter of this tool .
void	setBuildPyramids(String buildPyramids) Sets the Build Pyramids parameter of this tool .
void	setCalculateStatistics(String calculateStatistics) Sets the Calculate Statistics parameter of this tool .
void	setIncludeSubdirectories(String includeSubdirectories) Sets the Include Sub-directories parameter of this tool .
void	setInWorkspace(Object inWorkspace) Sets the Input Data or Workspace 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

BuildPyramidsandStatistics

public BuildPyramidsandStatistics()

Creates the Build Pyramids And Statistics tool with defaults.

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

BuildPyramidsandStatistics

public BuildPyramidsandStatistics(Object inWorkspace)

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

inWorkspace - the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.

Method Detail

getInWorkspace

public Object getInWorkspace()

Returns the Input Data or Workspace parameter of this tool . This parameter is the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is a required parameter.

Returns:

the Input Data or Workspace

setInWorkspace

public void setInWorkspace(Object inWorkspace)

Sets the Input Data or Workspace parameter of this tool . This parameter is the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is a required parameter.

Parameters:

inWorkspace - the workspace that contains all the raster datasets to be processed. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.

getIncludeSubdirectories

public String getIncludeSubdirectories()

Returns the Include Sub-directories parameter of this tool . This parameter is specify whether to include subdirectories. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is an optional parameter.

Returns:

the Include Sub-directories

setIncludeSubdirectories

public void setIncludeSubdirectories(String includeSubdirectories)

Sets the Include Sub-directories parameter of this tool . This parameter is specify whether to include subdirectories. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs. This is an optional parameter.

Parameters:

includeSubdirectories - specify whether to include subdirectories. raster catalogs and mosaic datasets must be specified as the input workspace. If the workspace includes a raster catalog or mosaic dataset, then these items will not be included when the tool runs.

getBuildPyramids

public String getBuildPyramids()

Returns the Build Pyramids parameter of this tool . This parameter is specify whether to build pyramids. This is an optional parameter.

Returns:

the Build Pyramids

setBuildPyramids

public void setBuildPyramids(String buildPyramids)

Sets the Build Pyramids parameter of this tool . This parameter is specify whether to build pyramids. This is an optional parameter.

Parameters:

buildPyramids - specify whether to build pyramids.

getCalculateStatistics

public String getCalculateStatistics()

Returns the Calculate Statistics parameter of this tool . This parameter is specify whether to calculate statistics. This is an optional parameter.

Returns:

the Calculate Statistics

setCalculateStatistics

public void setCalculateStatistics(String calculateStatistics)

Sets the Calculate Statistics parameter of this tool . This parameter is specify whether to calculate statistics. This is an optional parameter.

Parameters:

calculateStatistics - specify whether to calculate statistics.

getBUILDONSOURCE

public String getBUILDONSOURCE()

Returns the Include Source Datasets parameter of this tool . This is an optional parameter.

Returns:

the Include Source Datasets

setBUILDONSOURCE

public void setBUILDONSOURCE(String bUILDONSOURCE)

Sets the Include Source Datasets parameter of this tool . This is an optional parameter.

Parameters:

bUILDONSOURCE - null

getOutWorkspace

public Object getOutWorkspace()

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

Returns:

the Output Workspace

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