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

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

All Implemented Interfaces:

GPTool

public class Mirror
extends AbstractGPTool

This tool reorients the raster by flipping it, from left to right, along the vertical axis through the center of the raster. The Mirror tool is contained in the Data Management Tools tool box.

Usage tips:

• Mirror flips the raster from left to right along the vertical axis through the center of the region.
• 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

Mirror()
Creates the Mirror tool with defaults.

Mirror(java.lang.Object inRaster, java.lang.Object outRaster)
Creates the Mirror tool with the required parameters.

Method Summary

java.lang.Object	getInRaster() Returns the Input 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.
void	setInRaster(java.lang.Object inRaster) Sets the Input Raster parameter of this tool .
void	setOutRaster(java.lang.Object outRaster) Sets the Output Raster Dataset 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

Mirror

public Mirror()

Creates the Mirror tool with defaults.

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

Mirror

public Mirror(java.lang.Object inRaster,
              java.lang.Object outRaster)

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

Method Detail

getInRaster

public java.lang.Object getInRaster()

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

Parameters:

inRaster - 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.

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