Build Pyramids (Data Management)

License Level:BasicStandardAdvanced

Summary

Builds raster pyramids for a raster dataset.

This tool can also be used to delete pyramids. To delete pyramids, set the Pyramids Levels parameter to 0.

Illustration

Build Pyramids

Usage

Syntax

BuildPyramids_management (in_raster_dataset, {pyramid_level}, {SKIP_FIRST}, {resample_technique}, {compression_type}, {compression_quality}, {skip_existing})
ParameterExplanationData Type
in_raster_dataset

The input raster dataset.

The input should have more than 1024 rows and 1024 columns.

Raster Dataset; Raster Layer
pyramid_level
(Optional)

Choose the number of reduced-resolution dataset layers that will be built. The default value is -1, which will build full pyramids. A value of 0 will result in no pyramid levels.

To delete pyramids, set the number of levels to 0.

The maximum number of pyramid levels you can specify is 29. Any value that is 30 or higher will revert to a value of -1, which will create a full set of pyramids.

Long
SKIP_FIRST
(Optional)

Choose whether to skip the first pyramid level. Skipping the first level will take up slightly less disk space, but it will slow down performance at these scales.

  • NONEThe first pyramid level will be built. This is the default.
  • SKIP_FIRSTThe first pyramid level will not be built.
Boolean
resample_technique
(Optional)

The resampling technique used to build your pyramids.

  • NEARESTThe nearest neighbor resampling method uses the value of the closest cell to assign a value to the output cell when resampling. This is the default.
  • BILINEARThe bilinear interpolation resampling method determines the new value of a cell based on a weighted distance average of the four nearest input cell centers.
  • CUBICThe Cubic convolution resampling method determines the new value of a cell based on fitting a smooth curve through the 16 nearest input cell centers.
String
compression_type
(Optional)

The compression type to use when building the raster pyramids.

  • DEFAULTIf the source data is compressed using a wavelet compression, it will build pyramids with the JPEG compression type; otherwise, LZ77 will be used. This is the default compression method.
  • LZ77The LZ77 compression algorithm will be used to build the pyramids. LZ77 can be used for any data type.
  • JPEGThe JPEG compression algorithm to build pyramids. Only data that adheres to the JPEG compression specification can use this compression type. If JPEG is chosen, you can then set the compression quality.
  • JPEG_YCbCrA lossy compression using the luma (Y) and chroma (Cb and Cr) color space components.
  • NONENo compression will be used when building pyramids.
String
compression_quality
(Optional)

The compression quality to use when pyramids are built with the JPEG compression method. The value must be between 0 and 100. The values closer to 100 would produce a higher-quality image, but the compression ratio would be lower.

Long
skip_existing
(Optional)

Specify whether to build pyramids only when they are missing or regenerate them even if they exist.

  • OVERWRITEPyramids will be built even if they already exist; therefore, existing pyramids will be overwritten. This is the default.
  • SKIP_EXISTINGPyramids will only be built if they do not already exist.
Boolean

Code Sample

BuildPyramids example 1 (Python window)

This is a Python sample for BuildPyramids.

import arcpy
arcpy.BuildPyramids_management(
     "C:/data/image.tif", "3", "NONE", 
     "BILINEAR", "JPEG", "50", "SKIP_EXISTING")
BuildPyramids example 2 (stand-alone window)

This is a Python script sample for BuildPyramids.

#Build Pyramids for single Raster Dataset
#Define the type and compression of pyramids in the tool
#Skip if dataset already has pyramids

import arcpy
arcpy.env.workspace = "C:/Workspace"

inras = "image.tif"
pylevel = "3"
skipfirst = "NONE"
resample = "BILINEAR"
compress = "JPEG"
quality = "80"
skipexist = "SKIP_EXISTING"

arcpy.BuildPyramids_management(inras, pylevel, skipfirst, resample, 
                               compress, quality, skipexist)

Environments

Pyramid

The pyramid level, pyramid compression, and resampling method does not apply to the IMG format.

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Yes
ArcGIS for Desktop Standard: Yes
ArcGIS for Desktop Advanced: Yes
5/7/2015