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

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

All Implemented Interfaces:

GPTool

public class CalculateCellSizeRanges
extends AbstractGPTool

Computes the minimum and maximum cell sizes for the rasters in a mosaic dataset. The Calculate Cell Size Ranges tool is contained in the Data Management Tools tool box.

Usage tips:

• Cell size ranges are specified in the attribute table, under the minPS and maxPS columns. You can edit these values manually if needed.
• You cannot calculate cell size ranges for a referenced mosaic dataset.

Field Summary

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

vals

Constructor Summary

CalculateCellSizeRanges()
Creates the Calculate Cell Size Ranges tool with defaults.

CalculateCellSizeRanges(Object inMosaicDataset)
Creates the Calculate Cell Size Ranges tool with the required parameters.

Method Summary

double	getCellSizeToleranceFactor() Returns the Cell Size Tolerance Factor parameter of this tool .
String	getDoComputeMax() Returns the Compute Maximum Cell Sizes parameter of this tool .
String	getDoComputeMin() Returns the Compute Minimum Cell Sizes parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
double	getMaxRangeFactor() Returns the Maximum Cell Size Range Factor parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic 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.
String	getUpdateMissingOnly() Returns the Update Missing Values Only parameter of this tool .
Object	getWhereClause() Returns the Query Definition parameter of this tool .
void	setCellSizeToleranceFactor(double cellSizeToleranceFactor) Sets the Cell Size Tolerance Factor parameter of this tool .
void	setDoComputeMax(String doComputeMax) Sets the Compute Maximum Cell Sizes parameter of this tool .
void	setDoComputeMin(String doComputeMin) Sets the Compute Minimum Cell Sizes parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setMaxRangeFactor(double maxRangeFactor) Sets the Maximum Cell Size Range Factor parameter of this tool .
void	setUpdateMissingOnly(String updateMissingOnly) Sets the Update Missing Values Only parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Query Definition 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

CalculateCellSizeRanges

public CalculateCellSizeRanges()

Creates the Calculate Cell Size Ranges tool with defaults.

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

CalculateCellSizeRanges

public CalculateCellSizeRanges(Object inMosaicDataset)

Creates the Calculate Cell Size Ranges 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:

inMosaicDataset - path and name of mosaic dataset.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is path and name of mosaic dataset. This is a required parameter.

Returns:

the Mosaic Dataset

setInMosaicDataset

public void setInMosaicDataset(Object inMosaicDataset)

Sets the Mosaic Dataset parameter of this tool . This parameter is path and name of mosaic dataset. This is a required parameter.

Parameters:

inMosaicDataset - path and name of mosaic dataset.

getWhereClause

public Object getWhereClause()

Returns the Query Definition parameter of this tool . This parameter is using SQL you can define a query, or use the Query Builder to build a query. This is an optional parameter.

Returns:

the Query Definition

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Query Definition parameter of this tool . This parameter is using SQL you can define a query, or use the Query Builder to build a query. This is an optional parameter.

Parameters:

whereClause - using SQL you can define a query, or use the Query Builder to build a query.

getDoComputeMin

public String getDoComputeMin()

Returns the Compute Minimum Cell Sizes parameter of this tool . This parameter is computes the minimum pixel size for all the rasters in the mosaic dataset. This is an optional parameter.

Returns:

the Compute Minimum Cell Sizes

setDoComputeMin

public void setDoComputeMin(String doComputeMin)

Sets the Compute Minimum Cell Sizes parameter of this tool . This parameter is computes the minimum pixel size for all the rasters in the mosaic dataset. This is an optional parameter.

Parameters:

doComputeMin - computes the minimum pixel size for all the rasters in the mosaic dataset.

getDoComputeMax

public String getDoComputeMax()

Returns the Compute Maximum Cell Sizes parameter of this tool . This parameter is computes the maximum pixel size for all the rasters in the mosaic dataset. This is an optional parameter.

Returns:

the Compute Maximum Cell Sizes

setDoComputeMax

public void setDoComputeMax(String doComputeMax)

Sets the Compute Maximum Cell Sizes parameter of this tool . This parameter is computes the maximum pixel size for all the rasters in the mosaic dataset. This is an optional parameter.

Parameters:

doComputeMax - computes the maximum pixel size for all the rasters in the mosaic dataset.

getMaxRangeFactor

public double getMaxRangeFactor()

Returns the Maximum Cell Size Range Factor parameter of this tool . This parameter is controls the factor by which the maximum pixel size of the top-most overview is multiplied to ensure visibility of the mosaic when viewed at small scales. The default is 10. This is an optional parameter.

Returns:

the Maximum Cell Size Range Factor

setMaxRangeFactor

public void setMaxRangeFactor(double maxRangeFactor)

Sets the Maximum Cell Size Range Factor parameter of this tool . This parameter is controls the factor by which the maximum pixel size of the top-most overview is multiplied to ensure visibility of the mosaic when viewed at small scales. The default is 10. This is an optional parameter.

Parameters:

maxRangeFactor - controls the factor by which the maximum pixel size of the top-most overview is multiplied to ensure visibility of the mosaic when viewed at small scales. The default is 10.

getCellSizeToleranceFactor

public double getCellSizeToleranceFactor()

Returns the Cell Size Tolerance Factor parameter of this tool . This parameter is allows you to specify a cell size tolerance. This is useful when you have rasters with differing pixel sizes that should be considered the same. The default is 0.1. This is an optional parameter.

Returns:

the Cell Size Tolerance Factor

setCellSizeToleranceFactor

public void setCellSizeToleranceFactor(double cellSizeToleranceFactor)

Sets the Cell Size Tolerance Factor parameter of this tool . This parameter is allows you to specify a cell size tolerance. This is useful when you have rasters with differing pixel sizes that should be considered the same. The default is 0.1. This is an optional parameter.

Parameters:

cellSizeToleranceFactor - allows you to specify a cell size tolerance. This is useful when you have rasters with differing pixel sizes that should be considered the same. The default is 0.1.

getUpdateMissingOnly

public String getUpdateMissingOnly()

Returns the Update Missing Values Only parameter of this tool . This parameter is allows you to calculate only the missing cell size range values. This is an optional parameter.

Returns:

the Update Missing Values Only

setUpdateMissingOnly

public void setUpdateMissingOnly(String updateMissingOnly)

Sets the Update Missing Values Only parameter of this tool . This parameter is allows you to calculate only the missing cell size range values. This is an optional parameter.

Parameters:

updateMissingOnly - allows you to calculate only the missing cell size range values.

getOutMosaicDataset

public Object getOutMosaicDataset()

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

Returns:

the Mosaic 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