Build Overviews (Data Management)

License Level:BasicStandardAdvanced

Summary

Defines and generates overviews for a mosaic dataset.

Usage

Syntax

BuildOverviews_management (in_mosaic_dataset, {where_clause}, {define_missing_tiles}, {generate_overviews}, {generate_missing_images}, {regenerate_stale_images})
ParameterExplanationData Type
in_mosaic_dataset

The input mosaic dataset.

Image Service; Mosaic Layer; String
where_clause
(Optional)

Using SQL, you can define a query or use the Query Builder to build a query, if you want to choose which items to build overviews for.

SQL Expression
define_missing_tiles
(Optional)

Generates overviews if not enough overviews were defined or if new data was added without defining additional overviews.

  • DEFINE_MISSING_TILESThis will automatically identify where overviews are needed and define them. This is the default.
  • NO_DEFINE_MISSING_TILES New overviews will not be defined.
Boolean
generate_overviews
(Optional)

All overviews that need to be created or re-created will be generated. This includes missing overviews and stale overviews.

  • GENERATE_OVERVIEWS All types and states of overviews will be generated. This is the default.
  • NO_GENERATE_OVERVIEWS Only the overviews that have been defined and not generated will be built.
Boolean
generate_missing_images
(Optional)

Use if overviews have been defined but not generated.

  • GENERATE_MISSING_IMAGESOverviews that have been defined but not generated will be generated. This is the default.
  • IGNORE_MISSING_IMAGES Overviews that have been defined but not generated will not be generated.
Boolean
regenerate_stale_images
(Optional)

If the underlying raster datasets have changed or had their properties modified, the overviews will be identified as stale.

  • REGENERATE_STALE_IMAGESStale overviews will be updated. This is the default.
  • IGNORE_STALE_IMAGES Stale overviews will not be updated.
Boolean

Code Sample

BuildOverviews example 1 (Python window)

This is a Python sample for BuildOverviews.

import arcpy
arcpy.BuildOverviews_management(
     "C:/Workspace/Overviews.gdb/md", "OBJECTID<5", "DEFINE_MISSING_TILES", 
     "NO_GENERATE_OVERVIEWS", "IGNORE_MISSING_IMAGES", "IGNORE_STALE_IMAGES")
BuildOverviews example 2 (stand-alone script)

This is a Python script sample for BuildOverviews.

# Define Overviews for selected items only

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

    
arcpy.BuildOverviews_management("Overviews.gdb/md", "OBJECTID<5", 
                                "DEFINE_MISSING_TILES",
                                "NO_GENERATE_OVERVIEWS", "#", "#")

Environments

Related Topics

Licensing Information

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