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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.Resample
All Implemented Interfaces:
GPTool

public class Resample
extends AbstractGPTool

Alters the raster dataset by changing the cell size and resampling method. The Resample tool is contained in the Data Management Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Resample()
          Creates the Resample tool with defaults.
Resample(Object inRaster, Object outRaster)
          Creates the Resample tool with the required parameters.
 
Method Summary
 Object getCellSize()
          Returns the Output Cell Size parameter of this tool .
 Object getInRaster()
          Returns the Input Raster parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster Dataset parameter of this tool .
 String getResamplingType()
          Returns the Resampling Techinque 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 setCellSize(Object cellSize)
          Sets the Output Cell Size parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input Raster parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output Raster Dataset parameter of this tool .
 void setResamplingType(String resamplingType)
          Sets the Resampling Techinque 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

Resample

public Resample()
Creates the Resample tool with defaults.

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


Resample

public Resample(Object inRaster,
                Object outRaster)
Creates the Resample 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.
outRaster - the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input Raster parameter of this tool . This parameter is the input raster dataset. 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. This is a required parameter.

Parameters:
inRaster - the input raster dataset.

getOutRaster

public Object getOutRaster()
Returns the Output Raster Dataset parameter of this tool . This parameter is the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Returns:
the Output Raster Dataset

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output Raster Dataset parameter of this tool . This parameter is the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Parameters:
outRaster - the output raster dataset. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

getCellSize

public Object getCellSize()
Returns the Output Cell Size parameter of this tool . This parameter is the cell size for the new raster dataset. This is an optional parameter.

Returns:
the Output Cell Size

setCellSize

public void setCellSize(Object cellSize)
Sets the Output Cell Size parameter of this tool . This parameter is the cell size for the new raster dataset. This is an optional parameter.

Parameters:
cellSize - the cell size for the new raster dataset.

getResamplingType

public String getResamplingType()
Returns the Resampling Techinque parameter of this tool . This parameter is the resampling algorithm to be used. The default is NEAREST. 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 the resampling algorithm to be used. The default is NEAREST. This is an optional parameter.

Parameters:
resamplingType - the resampling algorithm to be used. The default is NEAREST.

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