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.

• 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

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

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. DEFINE_MISSING_TILES —This 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_IMAGES —Overviews 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_IMAGES —Stale 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/fgdb.gdb/md", "OBJECTID<5",\
                                "DEFINE_MISSING_TILES", "NO_GENERATE_OVERVIEWS",\
                                "#", "#")

BuildOverviews example 2 (stand-alone script)

This is a Python script sample for BuildOverviews.

##===========================
##Build Overviews
##Usage: BuildOverviews_management in_mosaic_dataset {where_clause} 
##                                 {DEFINE_MISSING_TILES | NO_DEFINE_MISSING_TILES}
##                                 {GENERATE_OVERVIEWS | NO_GENERATE_OVERVIEWS}
##                                 {GENERATE_MISSING_IMAGES | IGNORE_MISSING_IMAGES}
##                                 {REGENERATE_STALE_IMAGES | IGNORE_STALE_IMAGES}

try:
    import arcpy
    arcpy.env.workspace = "C:/Workspace"
    # Define Overviews for selected items only
    arcpy.BuildOverviews_management("Overviews.gdb/md", "OBJECTID<5", "DEFINE_MISSING_TILES",\
                                    "NO_GENERATE_OVERVIEWS", "#", "#")
    
    # Define and Build Overviews for all
    arcpy.BuildOverviews_management("Overviews.gdb/md", "#", "DEFINE_MISSING_TILES",\
                                    "GENERATE_OVERVIEWS", "GENERATE_MISSING_IMAGES",\
                                    "REGENERATE_STALE_IMAGES")
    
except:
    print "Build Overviews example failed."
    print arcpy.GetMessages()

Environments

Extent

Licensing Information

ArcView: No

ArcEditor: Yes

ArcInfo: Yes