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

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

All Implemented Interfaces:

GPTool

public class CopyRaster
extends AbstractGPTool

Make a copy of a raster dataset or loads raster datasets into a raster catalog. The Copy Raster tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• You can save your output to BMP, GIF, GRID, IMG, JPEG, JPEG 2000, PNG, TIFF, or any geodatabase raster dataset.
• When storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. When storing the raster dataset in a file format, you need to specify the file extension: .bmp for BMP, .gif for GIF, .img for an ERDAS IMAGINE file, .jpg for JPEG, .jp2 for JPEG 2000, .png for PNG, .tif for TIFF, or no extension for GRID.
• It can be used to load raster datasets into a raster catalog. If you want to load raster datasets into a raster catalog, you will need to type out the full path of the raster catalog as the output location or drag the raster catalog into the output text box.
• If this tool is used to load raster datasets into a raster catalog, then the Calculate Default Spatial Grid Index tool; will need to be run after the loading is completed. Learn more about Geodatabase items Spatial index grid size;
• For file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step.
• 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 Raster Storage Settings in the Environment Settings dialog box.
• The GIF format only supports single-band raster datasets.
• The pixel type parameter determines the bit depth of the output raster dataset. There is rescaling of the raster values when a different pixel type is chosen. If the pixel type is demoted (lowered), the raster values outside the valid range for that pixel depth will be truncated and lost. To learn about the bit depth capacity for supported export formats, see Technical specifications for raster dataset formats;
• The following environments affect this tool: current workspace; scratch workspace; output extent; snap raster; pyramid; raster statistics; compression; , and tile size;

Field Summary

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

vals

Constructor Summary

CopyRaster()
Creates the Copy Raster tool with defaults.

CopyRaster(Object inRaster, Object outRasterdataset)
Creates the Copy Raster tool with the required parameters.

Method Summary

double	getBackgroundValue() Returns the Ignore Background Value parameter of this tool .
String	getColormapToRGB() Returns the Colormap to RGB parameter of this tool .
String	getConfigKeyword() Returns the Configuration Keyword parameter of this tool .
Object	getInRaster() Returns the Input Raster parameter of this tool .
double	getNodataValue() Returns the NoData Value parameter of this tool .
String	getOnebitToEightbit() Returns the Convert 1 bit data to 8 bit parameter of this tool .
Object	getOutRasterdataset() Returns the Output Raster Dataset parameter of this tool .
String	getPixelType() Returns the Pixel Type 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	setBackgroundValue(double backgroundValue) Sets the Ignore Background Value parameter of this tool .
void	setColormapToRGB(String colormapToRGB) Sets the Colormap to RGB parameter of this tool .
void	setConfigKeyword(String configKeyword) Sets the Configuration Keyword parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input Raster parameter of this tool .
void	setNodataValue(double nodataValue) Sets the NoData Value parameter of this tool .
void	setOnebitToEightbit(String onebitToEightbit) Sets the Convert 1 bit data to 8 bit parameter of this tool .
void	setOutRasterdataset(Object outRasterdataset) Sets the Output Raster Dataset parameter of this tool .
void	setPixelType(String pixelType) Sets the Pixel Type 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

CopyRaster

public CopyRaster()

Creates the Copy Raster tool with defaults.

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

CopyRaster

public CopyRaster(Object inRaster,
                  Object outRasterdataset)

Creates the Copy 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:

inRaster - Raster layer, the name and location of the raster dataset to be copied.

outRasterdataset - Raster dataset | Raster catalog, 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.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is Raster layer, the name and location of the raster dataset to be copied. 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 Raster layer, the name and location of the raster dataset to be copied. This is a required parameter.

Parameters:

inRaster - Raster layer, the name and location of the raster dataset to be copied.

getOutRasterdataset

public Object getOutRasterdataset()

Returns the Output Raster Dataset parameter of this tool . This parameter is Raster dataset | Raster catalog, 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 Output Raster Dataset

setOutRasterdataset

public void setOutRasterdataset(Object outRasterdataset)

Sets the Output Raster Dataset parameter of this tool . This parameter is Raster dataset | Raster catalog, 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:

outRasterdataset - Raster dataset | Raster catalog, 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.

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.

getBackgroundValue

public double getBackgroundValue()

Returns the Ignore Background Value parameter of this tool . This parameter is Double, for file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step. This is an optional parameter.

Returns:

the Ignore Background Value

setBackgroundValue

public void setBackgroundValue(double backgroundValue)

Sets the Ignore Background Value parameter of this tool . This parameter is Double, for file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step. This is an optional parameter.

Parameters:

backgroundValue - Double, for file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step.

getNodataValue

public double getNodataValue()

Returns the NoData Value parameter of this tool . This parameter is Double, all the pixels with the specified value will be set to NoData in the output raster dataset. This is an optional parameter.

Returns:

the NoData Value

setNodataValue

public void setNodataValue(double nodataValue)

Sets the NoData Value parameter of this tool . This parameter is Double, all the pixels with the specified value will be set to NoData in the output raster dataset. This is an optional parameter.

Parameters:

nodataValue - Double, all the pixels with the specified value will be set to NoData in the output raster dataset.

getOnebitToEightbit

public String getOnebitToEightbit()

Returns the Convert 1 bit data to 8 bit parameter of this tool . This parameter is String, choose whether the input 1-bit raster dataset will be converted to an 8-bit raster dataset. In this conversion the value 1 in the input raster dataset will be changed to 255 in the output raster dataset. This is useful when importing a 1-bit raster dataset to ArcSDE. One-bit raster dataset have 8-bit pyramid layers when stored in a file system, but in ArcSDE, 1-bit raster datasets can only have 1-bit pyramid layers, which makes the display unpleasant. By converting the data to 8-bit in ArcSDE, the pyramid layers are built as 8-bit instead of 1-bit, resulting in a proper raster dataset in the display. This is an optional parameter.

Returns:

the Convert 1 bit data to 8 bit

setOnebitToEightbit

public void setOnebitToEightbit(String onebitToEightbit)

Sets the Convert 1 bit data to 8 bit parameter of this tool . This parameter is String, choose whether the input 1-bit raster dataset will be converted to an 8-bit raster dataset. In this conversion the value 1 in the input raster dataset will be changed to 255 in the output raster dataset. This is useful when importing a 1-bit raster dataset to ArcSDE. One-bit raster dataset have 8-bit pyramid layers when stored in a file system, but in ArcSDE, 1-bit raster datasets can only have 1-bit pyramid layers, which makes the display unpleasant. By converting the data to 8-bit in ArcSDE, the pyramid layers are built as 8-bit instead of 1-bit, resulting in a proper raster dataset in the display. This is an optional parameter.

Parameters:

onebitToEightbit - String, choose whether the input 1-bit raster dataset will be converted to an 8-bit raster dataset. In this conversion the value 1 in the input raster dataset will be changed to 255 in the output raster dataset. This is useful when importing a 1-bit raster dataset to ArcSDE. One-bit raster dataset have 8-bit pyramid layers when stored in a file system, but in ArcSDE, 1-bit raster datasets can only have 1-bit pyramid layers, which makes the display unpleasant. By converting the data to 8-bit in ArcSDE, the pyramid layers are built as 8-bit instead of 1-bit, resulting in a proper raster dataset in the display.

getColormapToRGB

public String getColormapToRGB()

Returns the Colormap to RGB parameter of this tool . This parameter is String, if the input raster dataset has a colormap, the output raster dataset can be converted to a three-band output raster dataset. This is useful when mosaicking rasters with different colormaps. This is an optional parameter.

Returns:

the Colormap to RGB

setColormapToRGB

public void setColormapToRGB(String colormapToRGB)

Sets the Colormap to RGB parameter of this tool . This parameter is String, if the input raster dataset has a colormap, the output raster dataset can be converted to a three-band output raster dataset. This is useful when mosaicking rasters with different colormaps. This is an optional parameter.

Parameters:

colormapToRGB - String, if the input raster dataset has a colormap, the output raster dataset can be converted to a three-band output raster dataset. This is useful when mosaicking rasters with different colormaps.

getPixelType

public String getPixelType()

Returns the Pixel Type parameter of this tool . This parameter is String, there will be no rescaling of the raster values when a different pixel type is chosen. If the pixel type is demoted (lowered), the raster values outside the valid range for that pixel depth will be truncated and lost. This is an optional parameter.

Returns:

the Pixel Type

setPixelType

public void setPixelType(String pixelType)

Sets the Pixel Type parameter of this tool . This parameter is String, there will be no rescaling of the raster values when a different pixel type is chosen. If the pixel type is demoted (lowered), the raster values outside the valid range for that pixel depth will be truncated and lost. This is an optional parameter.

Parameters:

pixelType - String, there will be no rescaling of the raster values when a different pixel type is chosen. If the pixel type is demoted (lowered), the raster values outside the valid range for that pixel depth will be truncated and lost.

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