Copy Raster (Data Management)

Summary

Makes a copy of a raster dataset or loads raster datasets into a raster catalog.

Usage

Syntax

CopyRaster_management (in_raster, out_rasterdataset, {config_keyword}, {background_value}, {nodata_value}, {onebit_to_eightbit}, {colormap_to_RGB}, {pixel_type})
ParameterExplanationData Type
in_raster

The name and location of the raster dataset to be copied.

Raster layer
out_rasterdataset

The name and location of the raster dataset to be created.

When storing the raster dataset in a file format, you need to specify the file extension:

  • .bil—ESRI BIL
  • .bip—ESRI BIP
  • .bmp—BMP
  • .bsq—ESRI BSQ
  • .dat—ENVI DAT
  • .gif—GIF
  • .img—ERDAS IMAGINE file
  • .jpg—JPEG
  • .jp2—JPEG 2000
  • .png—PNG
  • .tif—TIFF
  • no extension—ESRI GRID

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.

Raster Dataset ; Raster Catalog
config_keyword
(Optional)

Specifies the storage parameters (configuration) for a file geodatabase and an ArcSDE geodatabase. Personal geodatabases do not use configuration keywords.

ArcSDE configuration keywords are set up by your database administrator.

String
background_value
(Optional)

Use this option to remove the unwanted values created around the raster data. The value specified will be distinguished from other valuable data in the raster dataset. For example, a value of zero along the raster dataset's borders will be distinguished from zero values within the raster dataset.

The pixel value specified will be set to NoData in the output raster dataset.

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. ArcSDE and file geodatabase rasters will work without this extra step.

Double
nodata_value
(Optional)

All the pixels with the specified value will be set to NoData in the output raster dataset.

Double
onebit_to_eightbit
(Optional)

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.

  • NONE —No conversion will be done. This is the default.
  • OneBitTo8Bit —The input raster will be converted.
Boolean
colormap_to_RGB
(Optional)

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.

  • NONE —No conversion will occur. This is the default.
  • ColormapToRGB —The input dataset will be converted.
Boolean
pixel_type
(Optional)

Determines the bit depth of the output raster dataset. If left unspecified, the output bit depth will be the same as the input.

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.

  • 1_BIT —A 1-bit unsigned integer. The values can be 0 or 1.
  • 2_BIT —A 2-bit unsigned integer. The values supported can be from 0 to 3.
  • 4_BIT —A 4-bit unsigned integer. The values supported can be from 0 to 15.
  • 8_BIT_UNSIGNED —An unsigned 8-bit data type. The values supported can be from 0 to 255.
  • 8_BIT_SIGNED —A signed 8-bit data type. The values supported can be from -128 to 127.
  • 16_BIT_UNSIGNED —A 16-bit unsigned data type. The values can range from 0 to 65,535.
  • 16_BIT_SIGNED —A 16-bit signed data type. The values can range from -32,768 to 32,767.
  • 32_BIT_UNSIGNED —A 32-bit unsigned data type. The values can range from 0 to 4,294,967,295.
  • 32_BIT_SIGNED —A 32-bit signed data type. The values can range from -2,147,483,648 to 2,147,483,647.
  • 32_BIT_FLOAT —A 32-bit data type supporting decimals.
  • 64_BIT —A 64-bit data type supporting decimals.
String

Code Sample

CopyRaster example 1 (Python window)

This is a Python sample for the CopyRaster tool.

import arcpy
arcpy.CopyRaster_management("c:/data/background.tif",
                           "c:/fdgb/CpRaster.gdb/fgdbRD","DEFAULTS",
                           "0","9","","","8_BIT_UNSIGNED")
CopyRaster example 2 (stand-alone script)

This is a Python script sample for the CopyRaster tool.

##====================================
##Copy Raster
##Usage: CopyRaster_management in_raster out_rasterdataset {config_keyword} {background_value} {nodata_value} {NONE | OneBitTo8Bit} 
##                             {NONE | ColormapToRGB} {1_BIT | 2_BIT | 4_BIT | 8_BIT_UNSIGNED | 8_BIT_SIGNED | 16_BIT_UNSIGNED 
##                             | 16_BIT_SIGNED | 32_BIT_UNSIGNED | 32_BIT_SIGNED | 32_BIT_FLOAT | 64_BIT}
try:
    import arcpy
    arcpy.env.workspace = r"C:\PrjWorkspace"
    ##Copy File RasterDataset to GDB Dataset with Background and Nodata setting
    arcpy.CopyRaster_management("background.tif","CpRaster.gdb\\background","DEFAULTS","0","9","","","8_BIT_UNSIGNED")
    ##Copy 1 BIT 
    arcpy.CopyRaster_management("1bit.tif","SDE94.sde\\bit8","DEFAULTS","","","OneBitTo8Bit","","")
except:
    print "Copy Raster example failed."
    print arcpy.GetMessages()

Environments

Related Topics

An overview of the Raster toolset
Environment settings for raster data
Supported raster dataset file formats
Technical specifications for raster dataset formats

Licensing Information

ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes

Copyright © 1995-2014 Esri. All rights reserved.
10/27/2014