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

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

All Implemented Interfaces:

GPTool

public class CreateRandomRaster
extends AbstractGPTool

Creates a random raster dataset based on a user-specified distribution and extent. The Create Random Raster tool is contained in the Data Management Tools tool box.

Usage tips:

• The Uniform, Integer, Normal, and Exponential distributions' processing times are independent of their arguments, while the Poisson, Gamma, Binomial, Geometric, and Pascal distributions' processing times can vary considerably when arguments are changed.
• The values assigned to each cell in the random raster are derived from the random number generator and the selected distribution. The random number generator is identified in the Environments Settings, under Random Numbers. The random number generator starts a stream of random numbers based on the generator type and seed. The numbers are randomly determined and the values are between 0 and 1. The numbers are created as needed.The Create Random Raster tool pulls numbers from the random stream and transforms them based on the distribution identified in the tool. Each value is independent of the other values. There are multiple distributions available for assigning (or transforming) the values in the random output raster. The distributions generally produce different results, and which distribution to select is determined by the end use of the raster. If the random raster is to model some natural phenomenon, the distribution selected should be the best representation of the process of the phenomenon.For a description of the distributions and how they are generally used, see .
• A default value is calculated for the cell size parameter if no value is provided. This value is based on the size of the extent.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CreateRandomRaster()
Creates the Create Random Raster tool with defaults.

CreateRandomRaster(Object outPath, String outName)
Creates the Create Random Raster tool with the required parameters.

Method Summary

double	getCellsize() Returns the Cellsize parameter of this tool .
String	getDistribution() Returns the Distribution parameter of this tool .
String	getOutName() Returns the Raster Dataset Name with Extension parameter of this tool .
Object	getOutPath() Returns the Output Location parameter of this tool .
Object	getOutRasterDataset() Returns the Output Raster Dataset parameter of this tool (Read only).
Object	getRasterExtent() Returns the Output extent 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	setCellsize(double cellsize) Sets the Cellsize parameter of this tool .
void	setDistribution(String distribution) Sets the Distribution parameter of this tool .
void	setOutName(String outName) Sets the Raster Dataset Name with Extension parameter of this tool .
void	setOutPath(Object outPath) Sets the Output Location parameter of this tool .
void	setRasterExtent(Object rasterExtent) Sets the Output extent 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

CreateRandomRaster

public CreateRandomRaster()

Creates the Create Random Raster tool with defaults.

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

CreateRandomRaster

public CreateRandomRaster(Object outPath,
                          String outName)

Creates the Create Random Raster 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:

outPath - the location of the output raster dataset.

outName - the name of the raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format.

Method Detail

getOutPath

public Object getOutPath()

Returns the Output Location parameter of this tool . This parameter is the location of the output raster dataset. This is a required parameter.

Returns:

the Output Location

setOutPath

public void setOutPath(Object outPath)

Sets the Output Location parameter of this tool . This parameter is the location of the output raster dataset. This is a required parameter.

Parameters:

outPath - the location of the output raster dataset.

getOutName

public String getOutName()

Returns the Raster Dataset Name with Extension parameter of this tool . This parameter is the name of the raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format. This is a required parameter.

Returns:

the Raster Dataset Name with Extension

setOutName

public void setOutName(String outName)

Sets the Raster Dataset Name with Extension parameter of this tool . This parameter is the name of the raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format. This is a required parameter.

Parameters:

outName - the name of the raster dataset to be created. when not saving to a geodatabase, specify .tif for a TIFF file format, .img for an ERDAS IMAGINE file format, or no extension for a GRID file format.

getDistribution

public String getDistribution()

Returns the Distribution parameter of this tool . This parameter is the distribution of random values desired is as follows: This is an optional parameter.

Returns:

the Distribution

setDistribution

public void setDistribution(String distribution)

Sets the Distribution parameter of this tool . This parameter is the distribution of random values desired is as follows: This is an optional parameter.

Parameters:

distribution - the distribution of random values desired is as follows:

getRasterExtent

public Object getRasterExtent()

Returns the Output extent parameter of this tool . This parameter is the spatial extent of the random raster dataset. This is an optional parameter.

Returns:

the Output extent

setRasterExtent

public void setRasterExtent(Object rasterExtent)

Sets the Output extent parameter of this tool . This parameter is the spatial extent of the random raster dataset. This is an optional parameter.

Parameters:

rasterExtent - the spatial extent of the random raster dataset.

getCellsize

public double getCellsize()

Returns the Cellsize parameter of this tool . This parameter is the cell size of the new random raster dataset. This is an optional parameter.

Returns:

the Cellsize

setCellsize

public void setCellsize(double cellsize)

Sets the Cellsize parameter of this tool . This parameter is the cell size of the new random raster dataset. This is an optional parameter.

Parameters:

cellsize - the cell size of the new random raster dataset.

getOutRasterDataset

public Object getOutRasterDataset()

Returns the Output Raster Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Raster Dataset

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