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

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

All Implemented Interfaces:

GPTool

public class DefineOverviews
extends AbstractGPTool

Defines the tiling schema and properties of the preprocessed raster datasets that will cover part or all of a mosaic dataset at varying resolutions. The Define Overviews tool is contained in the Data Management Tools tool box.

Usage tips:

• This tool is used when there are specific parameters you need to set to generate your overviews, such as
  • Defining the location to write the files
  • Defining an extent that varies from the boundary
  • Defining the properties of the overview images, such as the resampling or compression methods
  • Defining the overview sampling factor
  Otherwise, you can check the option to build the overviews when you add your raster data to a mosaic dataset and the defaults will be used.
• Use the to generate the overviews after they've been defined with this tool.
• You can use a polygon feature class to define the shape of the overview. An overview image will be created for every polygon in the feature class. Ideally, your feature class will be used to create one overview image. If you do not wish to use all the polygons in the feature class you can make a selection on the layer in the table of contents or use a tool such as Make Feature Layer to create a temporary layer representing only the desired polygons.

Field Summary

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

vals

Constructor Summary

DefineOverviews()
Creates the Define Overviews tool with defaults.

DefineOverviews(Object inMosaicDataset)
Creates the Define Overviews tool with the required parameters.

Method Summary

String	getCompressionMethod() Returns the Compression Method parameter of this tool .
int	getCompressionQuality() Returns the Compression Quality parameter of this tool .
Object	getExtent() Returns the Extent parameter of this tool .
String	getForceOverviewTiles() Returns the Force Overview Tiles parameter of this tool .
int	getImageTileSize() Returns the Tile Size parameter of this tool .
Object	getInMosaicDataset() Returns the Mosaic Dataset parameter of this tool .
Object	getInTemplateDataset() Returns the Extent from Dataset parameter of this tool .
int	getNumberOfLevels() Returns the Number Of Levels parameter of this tool .
Object	getOutMosaicDataset() Returns the Mosaic Dataset parameter of this tool (Read only).
int	getOverviewFactor() Returns the Overview Sampling Factor parameter of this tool .
Object	getOverviewImageFolder() Returns the Output Location parameter of this tool .
double	getPixelSize() Returns the Pixel Size parameter of this tool .
String	getResamplingMethod() Returns the Resampling Method parameter of this tool .
int	getTileCols() Returns the Number Of Columns parameter of this tool .
int	getTileRows() Returns the Number Of Rows 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	setCompressionMethod(String compressionMethod) Sets the Compression Method parameter of this tool .
void	setCompressionQuality(int compressionQuality) Sets the Compression Quality parameter of this tool .
void	setExtent(Object extent) Sets the Extent parameter of this tool .
void	setForceOverviewTiles(String forceOverviewTiles) Sets the Force Overview Tiles parameter of this tool .
void	setImageTileSize(int imageTileSize) Sets the Tile Size parameter of this tool .
void	setInMosaicDataset(Object inMosaicDataset) Sets the Mosaic Dataset parameter of this tool .
void	setInTemplateDataset(Object inTemplateDataset) Sets the Extent from Dataset parameter of this tool .
void	setNumberOfLevels(int numberOfLevels) Sets the Number Of Levels parameter of this tool .
void	setOverviewFactor(int overviewFactor) Sets the Overview Sampling Factor parameter of this tool .
void	setOverviewImageFolder(Object overviewImageFolder) Sets the Output Location parameter of this tool .
void	setPixelSize(double pixelSize) Sets the Pixel Size parameter of this tool .
void	setResamplingMethod(String resamplingMethod) Sets the Resampling Method parameter of this tool .
void	setTileCols(int tileCols) Sets the Number Of Columns parameter of this tool .
void	setTileRows(int tileRows) Sets the Number Of Rows 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

DefineOverviews

public DefineOverviews()

Creates the Define Overviews tool with defaults.

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

DefineOverviews

public DefineOverviews(Object inMosaicDataset)

Creates the Define Overviews 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 - the path and name of the mosaic dataset.

Method Detail

getInMosaicDataset

public Object getInMosaicDataset()

Returns the Mosaic Dataset parameter of this tool . This parameter is the path and name of the 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 the path and name of the mosaic dataset. This is a required parameter.

Parameters:

inMosaicDataset - the path and name of the mosaic dataset.

getOverviewImageFolder

public Object getOverviewImageFolder()

Returns the Output Location parameter of this tool . This parameter is the folder or geodatabase where the overviews will be stored. overviews that are stored and managed within personal and file geodatabases have the default overview folder location in the same workspace as the residing geodatabase. for ArcSDE geodatabases, the overview location must be the ArcSDE database itself. This is an optional parameter.

Returns:

the Output Location

setOverviewImageFolder

public void setOverviewImageFolder(Object overviewImageFolder)

Sets the Output Location parameter of this tool . This parameter is the folder or geodatabase where the overviews will be stored. overviews that are stored and managed within personal and file geodatabases have the default overview folder location in the same workspace as the residing geodatabase. for ArcSDE geodatabases, the overview location must be the ArcSDE database itself. This is an optional parameter.

Parameters:

overviewImageFolder - the folder or geodatabase where the overviews will be stored. overviews that are stored and managed within personal and file geodatabases have the default overview folder location in the same workspace as the residing geodatabase. for ArcSDE geodatabases, the overview location must be the ArcSDE database itself.

getInTemplateDataset

public Object getInTemplateDataset()

Returns the Extent from Dataset parameter of this tool . This parameter is a raster dataset or polygon feature class used to define the extent or shape of the overview. the extent of the raster dataset will be used when using a raster dataset. The shape of the polygon will be used when using a feature class. This is an optional parameter.

Returns:

the Extent from Dataset

setInTemplateDataset

public void setInTemplateDataset(Object inTemplateDataset)

Sets the Extent from Dataset parameter of this tool . This parameter is a raster dataset or polygon feature class used to define the extent or shape of the overview. the extent of the raster dataset will be used when using a raster dataset. The shape of the polygon will be used when using a feature class. This is an optional parameter.

Parameters:

inTemplateDataset - a raster dataset or polygon feature class used to define the extent or shape of the overview. the extent of the raster dataset will be used when using a raster dataset. The shape of the polygon will be used when using a feature class.

getExtent

public Object getExtent()

Returns the Extent parameter of this tool . This is an optional parameter.

Returns:

the Extent

setExtent

public void setExtent(Object extent)

Sets the Extent parameter of this tool . This is an optional parameter.

Parameters:

extent - null

getPixelSize

public double getPixelSize()

Returns the Pixel Size parameter of this tool . This parameter is base pixel size used to generate the overviews. The default is determined by the software. This is an optional parameter.

Returns:

the Pixel Size

setPixelSize

public void setPixelSize(double pixelSize)

Sets the Pixel Size parameter of this tool . This parameter is base pixel size used to generate the overviews. The default is determined by the software. This is an optional parameter.

Parameters:

pixelSize - base pixel size used to generate the overviews. The default is determined by the software.

getNumberOfLevels

public int getNumberOfLevels()

Returns the Number Of Levels parameter of this tool . This parameter is the number of overview levels that will be generated. for a number greater than 0, it will be the number of overview levels generated. For example, 3 will generate three levels of overviews. If the value is left blank or -1, then overviews will only be generated up to a maximum of 1500 rows or columns. This is an optional parameter.

Returns:

the Number Of Levels

setNumberOfLevels

public void setNumberOfLevels(int numberOfLevels)

Sets the Number Of Levels parameter of this tool . This parameter is the number of overview levels that will be generated. for a number greater than 0, it will be the number of overview levels generated. For example, 3 will generate three levels of overviews. If the value is left blank or -1, then overviews will only be generated up to a maximum of 1500 rows or columns. This is an optional parameter.

Parameters:

numberOfLevels - the number of overview levels that will be generated. for a number greater than 0, it will be the number of overview levels generated. For example, 3 will generate three levels of overviews. If the value is left blank or -1, then overviews will only be generated up to a maximum of 1500 rows or columns.

getTileRows

public int getTileRows()

Returns the Number Of Rows parameter of this tool . This parameter is optimum number of rows in the overview. the larger the value, the bigger the file, and the more likely it will need to be regenerated if any lower image changes. this number can affect the number of overview images created. If it's a large number, then fewer overviews will be generated. If it's a small number, then more files are generated. This is an optional parameter.

Returns:

the Number Of Rows

setTileRows

public void setTileRows(int tileRows)

Sets the Number Of Rows parameter of this tool . This parameter is optimum number of rows in the overview. the larger the value, the bigger the file, and the more likely it will need to be regenerated if any lower image changes. this number can affect the number of overview images created. If it's a large number, then fewer overviews will be generated. If it's a small number, then more files are generated. This is an optional parameter.

Parameters:

tileRows - optimum number of rows in the overview. the larger the value, the bigger the file, and the more likely it will need to be regenerated if any lower image changes. this number can affect the number of overview images created. If it's a large number, then fewer overviews will be generated. If it's a small number, then more files are generated.

getTileCols

public int getTileCols()

Returns the Number Of Columns parameter of this tool . This parameter is optimum number of columns in the overview. the larger the value, the bigger the file, and the more likely it will need to be regenerated if any lower image changes. this number can affect the number of overview images created. If it's a large number, then fewer overviews will be generated. If it's a small number, then more files are generated. This is an optional parameter.

Returns:

the Number Of Columns

setTileCols

public void setTileCols(int tileCols)

Sets the Number Of Columns parameter of this tool . This parameter is optimum number of columns in the overview. the larger the value, the bigger the file, and the more likely it will need to be regenerated if any lower image changes. this number can affect the number of overview images created. If it's a large number, then fewer overviews will be generated. If it's a small number, then more files are generated. This is an optional parameter.

Parameters:

tileCols - optimum number of columns in the overview. the larger the value, the bigger the file, and the more likely it will need to be regenerated if any lower image changes. this number can affect the number of overview images created. If it's a large number, then fewer overviews will be generated. If it's a small number, then more files are generated.

getOverviewFactor

public int getOverviewFactor()

Returns the Overview Sampling Factor parameter of this tool . This parameter is the ratio used to determine the size of the next overview. For example, if the cell size of the first level is x, and the overview factor is 3, then the next overview pixel size will be 3x. This is an optional parameter.

Returns:

the Overview Sampling Factor

setOverviewFactor

public void setOverviewFactor(int overviewFactor)

Sets the Overview Sampling Factor parameter of this tool . This parameter is the ratio used to determine the size of the next overview. For example, if the cell size of the first level is x, and the overview factor is 3, then the next overview pixel size will be 3x. This is an optional parameter.

Parameters:

overviewFactor - the ratio used to determine the size of the next overview. For example, if the cell size of the first level is x, and the overview factor is 3, then the next overview pixel size will be 3x.

getForceOverviewTiles

public String getForceOverviewTiles()

Returns the Force Overview Tiles parameter of this tool . This parameter is affects the levels at which overviews will be generated. This is an optional parameter.

Returns:

the Force Overview Tiles

setForceOverviewTiles

public void setForceOverviewTiles(String forceOverviewTiles)

Sets the Force Overview Tiles parameter of this tool . This parameter is affects the levels at which overviews will be generated. This is an optional parameter.

Parameters:

forceOverviewTiles - affects the levels at which overviews will be generated.

getResamplingMethod

public String getResamplingMethod()

Returns the Resampling Method parameter of this tool . This parameter is the resampling algorithm used when creating the overviews. This is an optional parameter.

Returns:

the Resampling Method

setResamplingMethod

public void setResamplingMethod(String resamplingMethod)

Sets the Resampling Method parameter of this tool . This parameter is the resampling algorithm used when creating the overviews. This is an optional parameter.

Parameters:

resamplingMethod - the resampling algorithm used when creating the overviews.

getCompressionMethod

public String getCompressionMethod()

Returns the Compression Method parameter of this tool . This parameter is this defines the type of data compression that will be used to store the overview images. This is an optional parameter.

Returns:

the Compression Method

setCompressionMethod

public void setCompressionMethod(String compressionMethod)

Sets the Compression Method parameter of this tool . This parameter is this defines the type of data compression that will be used to store the overview images. This is an optional parameter.

Parameters:

compressionMethod - this defines the type of data compression that will be used to store the overview images.

getCompressionQuality

public int getCompressionQuality()

Returns the Compression Quality parameter of this tool . This parameter is quality of the compression used with the JPEG compression method. The compression quality can range from 1 to 100. A higher number means better image quality but less compression. This is an optional parameter.

Returns:

the Compression Quality

setCompressionQuality

public void setCompressionQuality(int compressionQuality)

Sets the Compression Quality parameter of this tool . This parameter is quality of the compression used with the JPEG compression method. The compression quality can range from 1 to 100. A higher number means better image quality but less compression. This is an optional parameter.

Parameters:

compressionQuality - quality of the compression used with the JPEG compression method. The compression quality can range from 1 to 100. A higher number means better image quality but less compression.

getImageTileSize

public int getImageTileSize()

Returns the Tile Size parameter of this tool . This parameter is the internal tiling size used by the overview images. This is an optional parameter.

Returns:

the Tile Size

setImageTileSize

public void setImageTileSize(int imageTileSize)

Sets the Tile Size parameter of this tool . This parameter is the internal tiling size used by the overview images. This is an optional parameter.

Parameters:

imageTileSize - the internal tiling size used by the overview images.

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