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

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

public class Shift
extends AbstractGPTool

Moves (slides) the raster to a new geographic location, based on x and y shift values. This tool is helpful if your raster dataset needs to be shifted to align with another data file. The Shift 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
Shift()
          Creates the Shift tool with defaults.
Shift(Object inRaster, Object outRaster, double xValue, double yValue)
          Creates the Shift tool with the required parameters.
 
Method Summary
 Object getInRaster()
          Returns the Input Raster parameter of this tool .
 Object getInSnapRaster()
          Returns the Input Snap Raster parameter of this tool .
 Object getOutRaster()
          Returns the Output Raster Dataset 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.
 double getXValue()
          Returns the Shift X Coordinates by parameter of this tool .
 double getYValue()
          Returns the Shift Y Coordinates by parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input Raster parameter of this tool .
 void setInSnapRaster(Object inSnapRaster)
          Sets the Input Snap Raster parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output Raster Dataset parameter of this tool .
 void setXValue(double xValue)
          Sets the Shift X Coordinates by parameter of this tool .
 void setYValue(double yValue)
          Sets the Shift Y Coordinates by 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

Shift

public Shift()
Creates the Shift tool with defaults.

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


Shift

public Shift(Object inRaster,
             Object outRaster,
             double xValue,
             double yValue)
Creates the Shift 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 - 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.
xValue - the value used to shift the x coordinates.
yValue - the value used to shift the y coordinates.
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 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 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 - 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.

getXValue

public double getXValue()
Returns the Shift X Coordinates by parameter of this tool . This parameter is the value used to shift the x coordinates. This is a required parameter.

Returns:
the Shift X Coordinates by

setXValue

public void setXValue(double xValue)
Sets the Shift X Coordinates by parameter of this tool . This parameter is the value used to shift the x coordinates. This is a required parameter.

Parameters:
xValue - the value used to shift the x coordinates.

getYValue

public double getYValue()
Returns the Shift Y Coordinates by parameter of this tool . This parameter is the value used to shift the y coordinates. This is a required parameter.

Returns:
the Shift Y Coordinates by

setYValue

public void setYValue(double yValue)
Sets the Shift Y Coordinates by parameter of this tool . This parameter is the value used to shift the y coordinates. This is a required parameter.

Parameters:
yValue - the value used to shift the y coordinates.

getInSnapRaster

public Object getInSnapRaster()
Returns the Input Snap Raster parameter of this tool . This parameter is the raster dataset used to align the cells of the output raster dataset. This is an optional parameter.

Returns:
the Input Snap Raster

setInSnapRaster

public void setInSnapRaster(Object inSnapRaster)
Sets the Input Snap Raster parameter of this tool . This parameter is the raster dataset used to align the cells of the output raster dataset. This is an optional parameter.

Parameters:
inSnapRaster - the raster dataset used to align the cells of the output raster 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