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

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

All Implemented Interfaces:

GPTool

public class Rotate
extends AbstractGPTool

This tool turns the raster dataset around the specified pivot point by angle specified in degrees; the raster dataset will rotate in a clockwise direction. The Rotate tool is contained in the Data Management Tools tool box.

Usage tips:

• Rotation is, by default, around the lower left corner of the raster. The rotation point can be changed with the optional Pivot Point parameter.
• Resampling is only done if the angle is not a multiple of 90.
• The rotation angle specified must be between 0 and 360, and the dataset will be rotated clockwise.
• 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

Rotate()
Creates the Rotate tool with defaults.

Rotate(Object inRaster, Object outRaster, double angle)
Creates the Rotate tool with the required parameters.

Method Summary

double	getAngle() Returns the Angle 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 .
Object	getPivotPoint() Returns the Pivot Point 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	setAngle(double angle) Sets the Angle 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	setPivotPoint(Object pivotPoint) Sets the Pivot Point 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

Rotate

public Rotate()

Creates the Rotate tool with defaults.

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

Rotate

public Rotate(Object inRaster,
              Object outRaster,
              double angle)

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

angle - the angle in degrees to rotate the raster. This can be any floating-point number.

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.

getAngle

public double getAngle()

Returns the Angle parameter of this tool . This parameter is the angle in degrees to rotate the raster. This can be any floating-point number. This is a required parameter.

Returns:

the Angle

setAngle

public void setAngle(double angle)

Sets the Angle parameter of this tool . This parameter is the angle in degrees to rotate the raster. This can be any floating-point number. This is a required parameter.

Parameters:

angle - the angle in degrees to rotate the raster. This can be any floating-point number.

getPivotPoint

public Object getPivotPoint()

Returns the Pivot Point parameter of this tool . This parameter is the pivot point around which to rotate the raster. The default is the lower left corner of the input raster dataset. To add this variable, press F8 or right-click and click Insert Variable. This is an optional parameter.

Returns:

the Pivot Point

setPivotPoint

public void setPivotPoint(Object pivotPoint)

Sets the Pivot Point parameter of this tool . This parameter is the pivot point around which to rotate the raster. The default is the lower left corner of the input raster dataset. To add this variable, press F8 or right-click and click Insert Variable. This is an optional parameter.

Parameters:

pivotPoint - the pivot point around which to rotate the raster. The default is the lower left corner of the input raster dataset. To add this variable, press F8 or right-click and click Insert Variable.

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