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

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

All Implemented Interfaces:

GPTool

public class CreateRandomRaster
extends AbstractGPTool

Creates a raster of random floating point values between 0 and 1 on a cell-by-cell basis within the Analysis window. The Create Random Raster tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• Repeatedly using the same seed value or the default will not produce the same raster.
• The Create Random Raster tool creates numbers with up to 20 digits after the decimal point.
• The output raster from the Create Random Raster function is always floating point.
• To generate the random values, the random number generator accompanying the standard C libraries from Microsoft is used. The source code is contained in the RAND.c file, and the file is generally stored in ProgramFiles/Microsoft Visual Studio/VC98/CRT/SRC.
• The following environment settings affect this tool:

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 outRaster)
Creates the Create Random Raster tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getExtent() Returns the Output extent parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
double	getSeedValue() Returns the Seed value 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(Object cellSize) Sets the Output cell size parameter of this tool .
void	setExtent(Object extent) Sets the Output extent parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setSeedValue(double seedValue) Sets the Seed value 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 outRaster)

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:

outRaster - Raster Dataset, the raster to be created.

Method Detail

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getSeedValue

public double getSeedValue()

Returns the Seed value parameter of this tool . This parameter is Double, the random number generator is automatically seeded with the current value of the system clock (seconds since January 1, 1970). The range of permissible values for {seed_value} is from -231+1 to 231 (or -2,147,483,647 to 2,147,483,648). This is an optional parameter.

Returns:

the Seed value

setSeedValue

public void setSeedValue(double seedValue)

Sets the Seed value parameter of this tool . This parameter is Double, the random number generator is automatically seeded with the current value of the system clock (seconds since January 1, 1970). The range of permissible values for {seed_value} is from -231+1 to 231 (or -2,147,483,647 to 2,147,483,648). This is an optional parameter.

Parameters:

seedValue - Double, the random number generator is automatically seeded with the current value of the system clock (seconds since January 1, 1970). The range of permissible values for {seed_value} is from -231+1 to 231 (or -2,147,483,647 to 2,147,483,648).

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this is the value in the environment if specifically set. If not specifically set, it is the shorter of the width or height of the environment extent in the output spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, this is the value in the environment if specifically set. If not specifically set, it is the shorter of the width or height of the environment extent in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, this is the value in the environment if specifically set. If not specifically set, it is the shorter of the width or height of the environment extent in the output spatial reference, divided by 250.

getExtent

public Object getExtent()

Returns the Output extent parameter of this tool . This parameter is Envelope, this is the value in the environment if specifically set. If not specifically set, it is 0, 0, 250, 250. This is an optional parameter.

Returns:

the Output extent

setExtent

public void setExtent(Object extent)

Sets the Output extent parameter of this tool . This parameter is Envelope, this is the value in the environment if specifically set. If not specifically set, it is 0, 0, 250, 250. This is an optional parameter.

Parameters:

extent - Envelope, this is the value in the environment if specifically set. If not specifically set, it is 0, 0, 250, 250.

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