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

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

All Implemented Interfaces:

GPTool

public class Warp
extends AbstractGPTool

Performs a transformation on the raster based on the source and target control points using a polynomial transformation. This is similar to georeferencing using a text file. The Warp tool is contained in the Data Management Tools tool box.

Usage tips:

• You must specify the source and target coordinates. The transformation type (polynomial order) from which to choose is dependent on the number of control points entered.
• The default polynomial order (1) will perform an affine transformation.
• Warp is useful when the raster requires a systematic geometric correction that can be modeled with a polynomial. A spatial transformation can invert or remove a distortion by using polynomial transformation of the proper order. The higher the order, the more complex the distortion that can be corrected. The higher orders of polynomial will involve progressively more processing time.
• To determine the minimum number of links necessary for a given order of polynomial, use the following formula:
• 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

Warp()
Creates the Warp tool with defaults.

Warp(Object inRaster, Object sourceControlPoints, Object targetControlPoints, Object outRaster)
Creates the Warp tool with the required parameters.

Method Summary

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 .
Object	getSourceControlPoints() Returns the Source Control Points parameter of this tool .
Object	getTargetControlPoints() Returns the Target Control Points 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	getTransformationType() Returns the Transformation Type 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 .
void	setSourceControlPoints(Object sourceControlPoints) Sets the Source Control Points parameter of this tool .
void	setTargetControlPoints(Object targetControlPoints) Sets the Target Control Points parameter of this tool .
void	setTransformationType(String transformationType) Sets the Transformation Type 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

Warp

public Warp()

Creates the Warp tool with defaults.

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

Warp

public Warp(Object inRaster,
            Object sourceControlPoints,
            Object targetControlPoints,
            Object outRaster)

Creates the Warp 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.

sourceControlPoints - the source points are the "from" coordinates of the links.

targetControlPoints - the target points are the "to" coordinates of the links.

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.

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.

getSourceControlPoints

public Object getSourceControlPoints()

Returns the Source Control Points parameter of this tool . This parameter is the source points are the "from" coordinates of the links. This is a required parameter.

Returns:

the Source Control Points

setSourceControlPoints

public void setSourceControlPoints(Object sourceControlPoints)

Sets the Source Control Points parameter of this tool . This parameter is the source points are the "from" coordinates of the links. This is a required parameter.

Parameters:

sourceControlPoints - the source points are the "from" coordinates of the links.

getTargetControlPoints

public Object getTargetControlPoints()

Returns the Target Control Points parameter of this tool . This parameter is the target points are the "to" coordinates of the links. This is a required parameter.

Returns:

the Target Control Points

setTargetControlPoints

public void setTargetControlPoints(Object targetControlPoints)

Sets the Target Control Points parameter of this tool . This parameter is the target points are the "to" coordinates of the links. This is a required parameter.

Parameters:

targetControlPoints - the target points are the "to" coordinates of the links.

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.

getTransformationType

public String getTransformationType()

Returns the Transformation Type parameter of this tool . This parameter is the geometric transformation type. This is an optional parameter.

Returns:

the Transformation Type

setTransformationType

public void setTransformationType(String transformationType)

Sets the Transformation Type parameter of this tool . This parameter is the geometric transformation type. This is an optional parameter.

Parameters:

transformationType - the geometric transformation type.

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. the NEAREST and MAJORITY options are used for categorical data, such as a land use classification. The NEAREST option is the default since it is the quickest and also because it will not change the cell values. Do not use NEAREST or MAJORITY for continuous data, such as elevation surfaces. the BILINEAR option and the CUBIC option are most appropriate for continuous data. It is not recommended that BILINEAR or CUBIC be used with categorical data because the cell values may be altered. 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. the NEAREST and MAJORITY options are used for categorical data, such as a land use classification. The NEAREST option is the default since it is the quickest and also because it will not change the cell values. Do not use NEAREST or MAJORITY for continuous data, such as elevation surfaces. the BILINEAR option and the CUBIC option are most appropriate for continuous data. It is not recommended that BILINEAR or CUBIC be used with categorical data because the cell values may be altered. This is an optional parameter.

Parameters:

resamplingType - the resampling algorithm to be used. The default is NEAREST. the NEAREST and MAJORITY options are used for categorical data, such as a land use classification. The NEAREST option is the default since it is the quickest and also because it will not change the cell values. Do not use NEAREST or MAJORITY for continuous data, such as elevation surfaces. the BILINEAR option and the CUBIC option are most appropriate for continuous data. It is not recommended that BILINEAR or CUBIC be used with categorical data because the cell values may be altered.

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