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

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

All Implemented Interfaces:

GPTool

public class Rescale
extends AbstractGPTool

Resizes a raster by the specified x and y scale factors. The Rescale tool is contained in the Data Management Tools tool box.

Usage tips:

• The output size is multiplied by the scale factor for both the x and y directions. The number of columns and rows stays the same in this process, but the cell size is multiplied by the scale factor.
• The scale factor must be positive.
• A scale factor greater than one means the image will be rescaled to a larger dimension, resulting in a larger extent because of a larger cell size.
• A scale factor less than one means the image will be rescaled to a smaller dimension, resulting in a smaller extent because of a smaller cell size.
• 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

Rescale()
Creates the Rescale tool with defaults.

Rescale(Object inRaster, Object outRaster, double xScale, double yScale)
Creates the Rescale 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.
double	getXScale() Returns the X Scale Factor parameter of this tool .
double	getYScale() Returns the Y Scale Factor 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	setXScale(double xScale) Sets the X Scale Factor parameter of this tool .
void	setYScale(double yScale) Sets the Y Scale Factor 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

Rescale

public Rescale()

Creates the Rescale tool with defaults.

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

Rescale

public Rescale(Object inRaster,
               Object outRaster,
               double xScale,
               double yScale)

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

xScale - the factor in which to scale the cell size in the x direction. the factor must be greater than zero.

yScale - the factor in which to scale the cell size in the y direction. the factor must be greater than zero.

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

getXScale

public double getXScale()

Returns the X Scale Factor parameter of this tool . This parameter is the factor in which to scale the cell size in the x direction. the factor must be greater than zero. This is a required parameter.

Returns:

the X Scale Factor

setXScale

public void setXScale(double xScale)

Sets the X Scale Factor parameter of this tool . This parameter is the factor in which to scale the cell size in the x direction. the factor must be greater than zero. This is a required parameter.

Parameters:

xScale - the factor in which to scale the cell size in the x direction. the factor must be greater than zero.

getYScale

public double getYScale()

Returns the Y Scale Factor parameter of this tool . This parameter is the factor in which to scale the cell size in the y direction. the factor must be greater than zero. This is a required parameter.

Returns:

the Y Scale Factor

setYScale

public void setYScale(double yScale)

Sets the Y Scale Factor parameter of this tool . This parameter is the factor in which to scale the cell size in the y direction. the factor must be greater than zero. This is a required parameter.

Parameters:

yScale - the factor in which to scale the cell size in the y direction. the factor must be greater than zero.

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