Build Overviews (Data Management)
Summary
Defines and generates overviews for a mosaic dataset.
Usage
This tool will honor the default mosaic dataset settings, not the properties set on a mosaic dataset layer. For instance, the tool will not accept layer property changes such as band count, mosaic method, extent, or query—these properties will be determined by the mosaic dataset and default properties of the mosaic dataset.
You must check on Define missing overview tiles, Generate overviews, or both.
The first overview level is created on the full resolution of the mosaic dataset. Each subsequent level is built on the last overview level that was generated.
-
If you need more control over the definition of the overviews, use the Define Overviews tool first.
-
By default, the overviews generated for mosaic datasets in a file geodatabase and personal geodatabase are stored in a folder <gdbname>.Overviews in the same location where the geodatabase containing the mosaic dataset exists. The overviews generated for mosaic datasets on the SDE are stored within the geodatabase containing the mosaic dataset. These locations can be changed by first using the Define Overviews tool and specifying a location.
-
You cannot build overviews for a referenced mosaic dataset.
Syntax
Parameter | Explanation | Data Type |
in_mosaic_dataset |
Path and name of the mosaic dataset. | Mosaic Layer |
where_clause (Optional) |
Using SQL, you can define a query or use the Query Builder to build a query. | SQL Expression |
define_missing_tiles (Optional) |
Generates overviews if not enough overviews were defined or if new data was added without defining additional overviews.
| Boolean |
generate_overviews (Optional) |
All overviews that need to be created or re-created will be generated. This includes missing overviews and stale overviews.
| Boolean |
generate_missing_images (Optional) |
Use if overviews have been defined but not 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.
| Boolean |
Code Sample
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")
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", "#", "#")