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

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

All Implemented Interfaces:

GPTool

public class SplitRaster
extends AbstractGPTool

Creates a tiled output from an input raster dataset. The Split Raster tool is contained in the Data Management Tools tool box.

Usage tips:

• The output files will share most of the properties of the input source raster, such as the spatial reference, source type, pixel type, pixel depth, and cell size.
• The tiling method determines which of the optional parameters are used to determine the dimensions and location of the output tiles. In both cases, NoData values are used to pad the tiles where there is no corresponding source data. The data format depends on the limitations of the individual format specifications and the source image data type. Invalid combinations result in an appropriate error message.

Field Summary

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

vals

Constructor Summary

SplitRaster()
Creates the Split Raster tool with defaults.

SplitRaster(Object inRaster, Object outFolder, String outBaseName, String splitMethod, String format)
Creates the Split Raster tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Cellsize parameter of this tool .
String	getFormat() Returns the Output Format parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
Object	getNumRasters() Returns the Number of Output Rasters parameter of this tool .
Object	getOrigin() Returns the Lower left origin parameter of this tool .
String	getOutBaseName() Returns the Output Base Name parameter of this tool .
Object	getOutFolder() Returns the Output Folder parameter of this tool .
String	getOutStatus() Returns the parameter of this tool (Read only).
double	getOverlap() Returns the Overlap parameter of this tool .
String	getResamplingType() Returns the Resampling Techinque parameter of this tool .
String	getSplitMethod() Returns the Split Method parameter of this tool .
Object	getTileSize() Returns the Size of Output Rasters 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.
String	getUnits() Returns the Units for Output Raster Size and Overlap parameter of this tool .
void	setCellSize(Object cellSize) Sets the Cellsize parameter of this tool .
void	setFormat(String format) Sets the Output Format parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setNumRasters(Object numRasters) Sets the Number of Output Rasters parameter of this tool .
void	setOrigin(Object origin) Sets the Lower left origin parameter of this tool .
void	setOutBaseName(String outBaseName) Sets the Output Base Name parameter of this tool .
void	setOutFolder(Object outFolder) Sets the Output Folder parameter of this tool .
void	setOverlap(double overlap) Sets the Overlap parameter of this tool .
void	setResamplingType(String resamplingType) Sets the Resampling Techinque parameter of this tool .
void	setSplitMethod(String splitMethod) Sets the Split Method parameter of this tool .
void	setTileSize(Object tileSize) Sets the Size of Output Rasters parameter of this tool .
void	setUnits(String units) Sets the Units for Output Raster Size and Overlap 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

SplitRaster

public SplitRaster()

Creates the Split Raster tool with defaults.

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

SplitRaster

public SplitRaster(Object inRaster,
                   Object outFolder,
                   String outBaseName,
                   String splitMethod,
                   String format)

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

inRaster - the input raster dataset to be split into tiles.

outFolder - the output folder, where the tiles will be created.

outBaseName - the prefix for each filename. The tile number is then appended to complete the filename, which starts with 0. by default, the prefix is the same name as the input raster.

splitMethod - the tiling method to be used when splitting the raster dataset. It will determine the size and number of tiles for each output dataset.

format - the file format for the output raster datasets.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster dataset to be split into tiles. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the input raster dataset to be split into tiles. This is a required parameter.

Parameters:

inRaster - the input raster dataset to be split into tiles.

getOutFolder

public Object getOutFolder()

Returns the Output Folder parameter of this tool . This parameter is the output folder, where the tiles will be created. This is a required parameter.

Returns:

the Output Folder

setOutFolder

public void setOutFolder(Object outFolder)

Sets the Output Folder parameter of this tool . This parameter is the output folder, where the tiles will be created. This is a required parameter.

Parameters:

outFolder - the output folder, where the tiles will be created.

getOutBaseName

public String getOutBaseName()

Returns the Output Base Name parameter of this tool . This parameter is the prefix for each filename. The tile number is then appended to complete the filename, which starts with 0. by default, the prefix is the same name as the input raster. This is a required parameter.

Returns:

the Output Base Name

setOutBaseName

public void setOutBaseName(String outBaseName)

Sets the Output Base Name parameter of this tool . This parameter is the prefix for each filename. The tile number is then appended to complete the filename, which starts with 0. by default, the prefix is the same name as the input raster. This is a required parameter.

Parameters:

outBaseName - the prefix for each filename. The tile number is then appended to complete the filename, which starts with 0. by default, the prefix is the same name as the input raster.

getSplitMethod

public String getSplitMethod()

Returns the Split Method parameter of this tool . This parameter is the tiling method to be used when splitting the raster dataset. It will determine the size and number of tiles for each output dataset. This is a required parameter.

Returns:

the Split Method

setSplitMethod

public void setSplitMethod(String splitMethod)

Sets the Split Method parameter of this tool . This parameter is the tiling method to be used when splitting the raster dataset. It will determine the size and number of tiles for each output dataset. This is a required parameter.

Parameters:

splitMethod - the tiling method to be used when splitting the raster dataset. It will determine the size and number of tiles for each output dataset.

getFormat

public String getFormat()

Returns the Output Format parameter of this tool . This parameter is the file format for the output raster datasets. This is a required parameter.

Returns:

the Output Format

setFormat

public void setFormat(String format)

Sets the Output Format parameter of this tool . This parameter is the file format for the output raster datasets. This is a required parameter.

Parameters:

format - the file format for the output raster datasets.

getResamplingType

public String getResamplingType()

Returns the Resampling Techinque parameter of this tool . This parameter is choose the resampling method to use when creating the DTEDs. The default is bilinear interpolation resampling. This is an optional parameter.

Returns:

the Resampling Techinque

setResamplingType

public void setResamplingType(String resamplingType)

Sets the Resampling Techinque parameter of this tool . This parameter is choose the resampling method to use when creating the DTEDs. The default is bilinear interpolation resampling. This is an optional parameter.

Parameters:

resamplingType - choose the resampling method to use when creating the DTEDs. The default is bilinear interpolation resampling.

getNumRasters

public Object getNumRasters()

Returns the Number of Output Rasters parameter of this tool . This parameter is specify the number of tiles in each direction. The default value is 1 tile for each direction. this option is only valid when the tiling method is NUMBER_OF_TILES. This is an optional parameter.

Returns:

the Number of Output Rasters

setNumRasters

public void setNumRasters(Object numRasters)

Sets the Number of Output Rasters parameter of this tool . This parameter is specify the number of tiles in each direction. The default value is 1 tile for each direction. this option is only valid when the tiling method is NUMBER_OF_TILES. This is an optional parameter.

Parameters:

numRasters - specify the number of tiles in each direction. The default value is 1 tile for each direction. this option is only valid when the tiling method is NUMBER_OF_TILES.

getTileSize

public Object getTileSize()

Returns the Size of Output Rasters parameter of this tool . This parameter is the x and y dimensions of the output tiles. The "Units for Output Raster Size and Overlap" parameter will determine the units that are used for these values. this option is only valid when the tiling method is SIZE_OF_TILE. This is an optional parameter.

Returns:

the Size of Output Rasters

setTileSize

public void setTileSize(Object tileSize)

Sets the Size of Output Rasters parameter of this tool . This parameter is the x and y dimensions of the output tiles. The "Units for Output Raster Size and Overlap" parameter will determine the units that are used for these values. this option is only valid when the tiling method is SIZE_OF_TILE. This is an optional parameter.

Parameters:

tileSize - the x and y dimensions of the output tiles. The "Units for Output Raster Size and Overlap" parameter will determine the units that are used for these values. this option is only valid when the tiling method is SIZE_OF_TILE.

getOverlap

public double getOverlap()

Returns the Overlap parameter of this tool . This parameter is the number of pixels of overlap between the adjoining tiles. The overlap value will be determined by the "Units for Output Raster Size and Overlap" parameter. This is an optional parameter.

Returns:

the Overlap

setOverlap

public void setOverlap(double overlap)

Sets the Overlap parameter of this tool . This parameter is the number of pixels of overlap between the adjoining tiles. The overlap value will be determined by the "Units for Output Raster Size and Overlap" parameter. This is an optional parameter.

Parameters:

overlap - the number of pixels of overlap between the adjoining tiles. The overlap value will be determined by the "Units for Output Raster Size and Overlap" parameter.

getUnits

public String getUnits()

Returns the Units for Output Raster Size and Overlap parameter of this tool . This is an optional parameter.

Returns:

the Units for Output Raster Size and Overlap

setUnits

public void setUnits(String units)

Sets the Units for Output Raster Size and Overlap parameter of this tool . This is an optional parameter.

Parameters:

units - null

getCellSize

public Object getCellSize()

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

Returns:

the Cellsize

setCellSize

public void setCellSize(Object cellSize)

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

Parameters:

cellSize - null

getOrigin

public Object getOrigin()

Returns the Lower left origin parameter of this tool . This parameter is the coordinate for the lower left origin point, where the tiling scheme will begin. By default, the lower left origin would be the same as the input raster. this parameter is based on the output spatial reference system, which is set in the Environment Settings. This is an optional parameter.

Returns:

the Lower left origin

setOrigin

public void setOrigin(Object origin)

Sets the Lower left origin parameter of this tool . This parameter is the coordinate for the lower left origin point, where the tiling scheme will begin. By default, the lower left origin would be the same as the input raster. this parameter is based on the output spatial reference system, which is set in the Environment Settings. This is an optional parameter.

Parameters:

origin - the coordinate for the lower left origin point, where the tiling scheme will begin. By default, the lower left origin would be the same as the input raster. this parameter is based on the output spatial reference system, which is set in the Environment Settings.

getOutStatus

public String getOutStatus()

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

Returns:

the

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