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

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

public class CreateRasterDataset
extends AbstractGPTool

Creates a raster dataset as a file or in a geodatabase. The Create Raster Dataset tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateRasterDataset()
          Creates the Create Raster Dataset tool with defaults.
CreateRasterDataset(Object outPath, String outName, String pixelType, int numberOfBands)
          Creates the Create Raster Dataset tool with the required parameters.
 
Method Summary
 double getCellsize()
          Returns the Cellsize parameter of this tool .
 Object getCompression()
          Returns the Compression parameter of this tool .
 String getConfigKeyword()
          Returns the Configuration Keyword parameter of this tool .
 int getNumberOfBands()
          Returns the Number of Bands 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).
 String getPixelType()
          Returns the Pixel Type parameter of this tool .
 Object getPyramidOrigin()
          Returns the Pyramid Reference Point parameter of this tool .
 Object getPyramids()
          Returns the Create pyramids parameter of this tool .
 Object getRasterSpatialReference()
          Returns the Spatial Reference for Raster parameter of this tool .
 Object getTileSize()
          Returns the Tile size 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 setCompression(Object compression)
          Sets the Compression parameter of this tool .
 void setConfigKeyword(String configKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setNumberOfBands(int numberOfBands)
          Sets the Number of Bands 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 setPixelType(String pixelType)
          Sets the Pixel Type parameter of this tool .
 void setPyramidOrigin(Object pyramidOrigin)
          Sets the Pyramid Reference Point parameter of this tool .
 void setPyramids(Object pyramids)
          Sets the Create pyramids parameter of this tool .
 void setRasterSpatialReference(Object rasterSpatialReference)
          Sets the Spatial Reference for Raster parameter of this tool .
 void setTileSize(Object tileSize)
          Sets the Tile size 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

CreateRasterDataset

public CreateRasterDataset()
Creates the Create Raster Dataset tool with defaults.

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


CreateRasterDataset

public CreateRasterDataset(Object outPath,
                           String outName,
                           String pixelType,
                           int numberOfBands)
Creates the Create Raster Dataset 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 - Workspace |Raster catalog, the output location to contain the raster dataset.
outName - String, 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.
pixelType - String, help topic to be sure the format you are using will support the data type you need.
numberOfBands - Long, the number of bands to be contained by the raster dataset.
Method Detail

getOutPath

public Object getOutPath()
Returns the Output Location parameter of this tool . This parameter is Workspace |Raster catalog, the output location to contain the 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 Workspace |Raster catalog, the output location to contain the raster dataset. This is a required parameter.

Parameters:
outPath - Workspace |Raster catalog, the output location to contain the raster dataset.

getOutName

public String getOutName()
Returns the Raster Dataset Name with Extension parameter of this tool . This parameter is String, 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. 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 String, 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. This is a required parameter.

Parameters:
outName - String, 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.

getCellsize

public double getCellsize()
Returns the Cellsize parameter of this tool . This parameter is Double, the cell size for the new 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 Double, the cell size for the new raster dataset. This is an optional parameter.

Parameters:
cellsize - Double, the cell size for the new raster dataset.

getPixelType

public String getPixelType()
Returns the Pixel Type parameter of this tool . This parameter is String, help topic to be sure the format you are using will support the data type you need. This is a required parameter.

Returns:
the Pixel Type

setPixelType

public void setPixelType(String pixelType)
Sets the Pixel Type parameter of this tool . This parameter is String, help topic to be sure the format you are using will support the data type you need. This is a required parameter.

Parameters:
pixelType - String, help topic to be sure the format you are using will support the data type you need.

getRasterSpatialReference

public Object getRasterSpatialReference()
Returns the Spatial Reference for Raster parameter of this tool . This parameter is Coordinate system, if this is not specified, the coordinate system set in the environment settings will be used. This is an optional parameter.

Returns:
the Spatial Reference for Raster

setRasterSpatialReference

public void setRasterSpatialReference(Object rasterSpatialReference)
Sets the Spatial Reference for Raster parameter of this tool . This parameter is Coordinate system, if this is not specified, the coordinate system set in the environment settings will be used. This is an optional parameter.

Parameters:
rasterSpatialReference - Coordinate system, if this is not specified, the coordinate system set in the environment settings will be used.

getNumberOfBands

public int getNumberOfBands()
Returns the Number of Bands parameter of this tool . This parameter is Long, the number of bands to be contained by the raster dataset. This is a required parameter.

Returns:
the Number of Bands

setNumberOfBands

public void setNumberOfBands(int numberOfBands)
Sets the Number of Bands parameter of this tool . This parameter is Long, the number of bands to be contained by the raster dataset. This is a required parameter.

Parameters:
numberOfBands - Long, the number of bands to be contained by the raster dataset.

getConfigKeyword

public String getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . This parameter is String, arcSDE configuration keywords are set up by your database administrator. This is an optional parameter.

Returns:
the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Configuration Keyword parameter of this tool . This parameter is String, arcSDE configuration keywords are set up by your database administrator. This is an optional parameter.

Parameters:
configKeyword - String, arcSDE configuration keywords are set up by your database administrator.

getPyramids

public Object getPyramids()
Returns the Create pyramids parameter of this tool . This parameter is Pyramid, the resampling technique instructs ArcGIS on how to resample the data when building the pyramids. This is an optional parameter.

Returns:
the Create pyramids

setPyramids

public void setPyramids(Object pyramids)
Sets the Create pyramids parameter of this tool . This parameter is Pyramid, the resampling technique instructs ArcGIS on how to resample the data when building the pyramids. This is an optional parameter.

Parameters:
pyramids - Pyramid, the resampling technique instructs ArcGIS on how to resample the data when building the pyramids.

getTileSize

public Object getTileSize()
Returns the Tile size parameter of this tool . This parameter is Tile size, only file geodatabases and ArcSDE geodatabases use tile size. This is an optional parameter.

Returns:
the Tile size

setTileSize

public void setTileSize(Object tileSize)
Sets the Tile size parameter of this tool . This parameter is Tile size, only file geodatabases and ArcSDE geodatabases use tile size. This is an optional parameter.

Parameters:
tileSize - Tile size, only file geodatabases and ArcSDE geodatabases use tile size.

getCompression

public Object getCompression()
Returns the Compression parameter of this tool . This parameter is Compression, the JPEG and JPEG 2000 compression quality can range from 1 to 100. A higher number means better image quality but less compression. This is an optional parameter.

Returns:
the Compression

setCompression

public void setCompression(Object compression)
Sets the Compression parameter of this tool . This parameter is Compression, the JPEG and JPEG 2000 compression quality can range from 1 to 100. A higher number means better image quality but less compression. This is an optional parameter.

Parameters:
compression - Compression, the JPEG and JPEG 2000 compression quality can range from 1 to 100. A higher number means better image quality but less compression.

getPyramidOrigin

public Object getPyramidOrigin()
Returns the Pyramid Reference Point parameter of this tool . This parameter is Point, in setting this point for a file geodatabase or an ArcSDE geodatabase, partial pyramiding will be used when updating with a new mosaicked raster dataset. Partial pyramiding updates the parts of the pyramid that do not exist due to the new mosaicked raster datasets. Therefore, it is good to set your pyramid reference point so that your entire raster mosaic will be below and to the right of this point. However, a pyramid reference point should not be set too large either. This is an optional parameter.

Returns:
the Pyramid Reference Point

setPyramidOrigin

public void setPyramidOrigin(Object pyramidOrigin)
Sets the Pyramid Reference Point parameter of this tool . This parameter is Point, in setting this point for a file geodatabase or an ArcSDE geodatabase, partial pyramiding will be used when updating with a new mosaicked raster dataset. Partial pyramiding updates the parts of the pyramid that do not exist due to the new mosaicked raster datasets. Therefore, it is good to set your pyramid reference point so that your entire raster mosaic will be below and to the right of this point. However, a pyramid reference point should not be set too large either. This is an optional parameter.

Parameters:
pyramidOrigin - Point, in setting this point for a file geodatabase or an ArcSDE geodatabase, partial pyramiding will be used when updating with a new mosaicked raster dataset. Partial pyramiding updates the parts of the pyramid that do not exist due to the new mosaicked raster datasets. Therefore, it is good to set your pyramid reference point so that your entire raster mosaic will be below and to the right of this point. However, a pyramid reference point should not be set too large either.

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