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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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:

• The cell size of the output raster will be the same as that of the input raster.
• The number of rows and columns in the output raster will be the same as those of the input raster, no matter what parameters are specified.
• The coordinates of the lower left corner of the output raster will be offset from the input raster by the x and y shift coordinate values specified.
• Using a negative shift x-coordinate value will shift the output to the left. A positive shift x-coordinate value will shift the output to the right. Using a negative shift y-coordinate value will shift the output down. A positive shift y-coordinate value will shift the output to the top.
• The output raster dataset is nudged according to the location of the input snap raster, so the new shifted raster dataset can be aligned perfectly with another raster dataset.
• Shift does not perform any resampling or warping.
• You can save your output to BIL, BIP, BMP, BSQ, DAT, GIF, GRID, IMG, JPEG, JPEG 2000, PNG, TIFF, or any geodatabase raster dataset.
• When storing your raster dataset to a JPEG file, a JPEG 2000 file, or a geodatabase, you can specify a Compression type and Compression Quality within the Environment Settings.

Field Summary

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

vals

Constructor Summary

Shift()
Creates the Shift tool with defaults.

Shift(java.lang.Object inRaster, java.lang.Object outRaster, double xValue, double yValue)
Creates the Shift tool with the required parameters.

Method Summary

java.lang.Object	getInRaster() Returns the Input Raster parameter of this tool .
java.lang.Object	getInSnapRaster() Returns the Input Snap Raster parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output Raster Dataset parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.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(java.lang.Object inRaster) Sets the Input Raster parameter of this tool .
void	setInSnapRaster(java.lang.Object inSnapRaster) Sets the Input Snap Raster parameter of this tool .
void	setOutRaster(java.lang.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(java.lang.Object inRaster,
             java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias