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

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

public class Flip
extends AbstractGPTool

Reorients the raster by turning it over, from top to bottom, along the horizontal axis through the center of the raster. This may be useful to correct raster datasets that are upside down. The Flip tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Flip()
          Creates the Flip tool with defaults.
Flip(Object inRaster, Object outRaster)
          Creates the Flip 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 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 setInRaster(Object inRaster)
          Sets the Input Raster parameter of this tool .
 void setOutRaster(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

Flip

public Flip()
Creates the Flip tool with defaults.

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


Flip

public Flip(Object inRaster,
            Object outRaster)
Creates the Flip 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 - Composite Geodataset, input raster dataset.
outRaster - Raster Dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; 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 Composite Geodataset, 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 Composite Geodataset, input raster dataset. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, input raster dataset.

getOutRaster

public Object getOutRaster()
Returns the Output Raster Dataset parameter of this tool . This parameter is Raster Dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; 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 Raster Dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality. This is a required parameter.

Parameters:
outRaster - Raster Dataset, when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. A raster dataset stored in a geodatabase can be compressed; you can specify a compression type and compression quality.

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