Summary
Adds raster datasets to a mosaic dataset from many sources, including a file, folder, table, or web service.
Usage
Raster data that is added is not managed; if the raster data is deleted or moved, the mosaic dataset will be affected.
You can only add rasters to a mosaic dataset contained in a geodatabase. Those created outside a geodatabase can only contain the contents of a previously created mosaic dataset.
The Raster Type parameter identifies metadata required for loading data into the mosaic dataset.
The raster type is specific to imagery products. It identifies metadata, such as georeferencing, acquisition date, and sensor type, along with a raster format.
The Processing Templates options include functions that will be applied to items that will be added to your mosaic dataset and how, or in what order, they will be applied.
For faster display and processing, the pixel cache for a mosaic dataset can be generated when the Enable Pixel Cache option is selected.
Syntax
arcpy.management.AddRastersToMosaicDataset(in_mosaic_dataset, raster_type, input_path, {update_cellsize_ranges}, {update_boundary}, {update_overviews}, {maximum_pyramid_levels}, {maximum_cell_size}, {minimum_dimension}, {spatial_reference}, {filter}, {sub_folder}, {duplicate_items_action}, {build_pyramids}, {calculate_statistics}, {build_thumbnails}, {operation_description}, {force_spatial_reference}, {estimate_statistics}, {aux_inputs}, {enable_pixel_cache}, {cache_location})| Parameter | Explanation | Data Type |
in_mosaic_dataset | The path and name of the mosaic dataset to which the raster data will be added. | Mosaic Layer |
raster_type | The raster type is specific to imagery products. It identifies metadata, such as georeferencing, acquisition date, and sensor type, along with a raster format. For a list of supported sensors and raster types, see the list of supported sensors. If you are using a LAS, LAS Dataset, or Terrain raster type, an .art file must be used when the cell size is specified. | Raster Type |
input_path [input_path,...] | Specifies the path and name of the input file, folder, raster dataset, mosaic dataset, table, or service. Not all input options will be available. The selected raster type determines the available options.
| File; Image Service; LAS Dataset Layer; Layer File; MapServer; Mosaic Layer; Raster Layer; Table View; Terrain Layer; WCS Coverage; WMS Map; Workspace |
update_cellsize_ranges (Optional) | Specifies whether the cell size ranges of each raster in the mosaic dataset will be calculated. These values are written to the attribute table in the minPS and maxPS fields.
| Boolean |
update_boundary (Optional) | Specifies whether the boundary polygon of a mosaic dataset will be generated or updated. By default, the boundary merges all the footprint polygons to create a single boundary representing the extent of the valid pixels.
| Boolean |
update_overviews (Optional) | Specifies whether overviews for a mosaic dataset will be defined and generated.
| Boolean |
maximum_pyramid_levels (Optional) | The maximum number of pyramid levels that will be used in the mosaic dataset. For example, a value of 2 will use only the first two pyramid levels from the source raster. Leaving this parameter blank or typing a value of -1 will build pyramids for all levels. This value can affect the display and number of overviews that will be generated. | Long |
maximum_cell_size (Optional) | The maximum pyramid cell size that will be used in the mosaic dataset. | Double |
minimum_dimension (Optional) | The minimum dimensions of a raster pyramid that will be used in the mosaic dataset. | Long |
spatial_reference (Optional) | The spatial reference system of the input data. This should be specified if the data does not have a coordinate system; otherwise, the coordinate system of the mosaic dataset will be used. This can also be used to override the coordinate system of the input data. | Spatial Reference |
filter (Optional) | A filter for the data being added to the mosaic dataset. You can use SQL expressions to create the data filter. The wildcards for the filter work on the full path to the input data. The following SQL statement will select the rows in which the following object IDs match:
If you want to add only a TIFF image, add an asterisk before a file extension.
If you want to add any image with the word sensor in the file path or file name, add an asterisk before and after the word sensor.
Or you can use PERL syntax to create a data filter.
The following PERL syntax with multiple lexical groupings as part of the expression is not supported:
Alternatively, you can use the following syntax:
| String |
sub_folder (Optional) | Specifies whether subfolders will be recursively explored.
| Boolean |
duplicate_items_action (Optional) | Specifies how duplicate rasters will be handled. A check will be performed to determine whether each raster has already been added, using the original path and file name. Choose the action to be performed when a duplicate path and file name are found.
| String |
build_pyramids (Optional) | Builds pyramids for each source raster.
| Boolean |
calculate_statistics (Optional) | Specifies whether statistics will be calculated for each source raster.
| Boolean |
build_thumbnails (Optional) | Specifies whether thumbnails will be built for each source raster.
| Boolean |
operation_description (Optional) | The description used to represent the operation of adding raster data. It will be added to the raster type table, which can be used as part of a search or as a reference at another time. | String |
force_spatial_reference (Optional) | Specifies the coordinate system. Use the coordinate system specified in the spatial_reference parameter for all the rasters when loading data into the mosaic dataset.
| Boolean |
estimate_statistics (Optional) | Specifies whether statistics will be estimated on the mosaic dataset for faster rendering and processing at the mosaic dataset level.
| Boolean |
aux_inputs [aux_inputs,...] (Optional) | The raster type settings that will be defined on the Raster Type Properties page. The settings in this parameter will override the settings defined on the Raster Type Properties page. | Value Table |
enable_pixel_cache (Optional) | Specifies whether the pixel cache will be generated for faster display and processing of the mosaic dataset.
| Boolean |
cache_location (Optional) | The location of the pixel cache. If no location is defined, the cache is written to C:\Users\<Username>\AppData\Local\ESRI\rasterproxies\. Once the location is defined, you do not need to redefine the path when adding new rasters to the mosaic dataset. You only need to check the Enable Pixel Cache parameter (enable_pixel_cache = "USE_PIXEL_CACHE" in Python) when adding the new data. | Folder; String |
Derived Output
| Name | Explanation | Data Type |
| out_mosaic_dataset | The updated mosaic dataset. | Mosaic Layer |
Code sample
This is a Python sample for the AddRastersToMosaicDataset tool.
import arcpy
arcpy.AddRastersToMosaicDataset_management(
"c:/data/AddMD.gdb/md_landsat", "Landsat 7 ETM+",
"c:/data/landsat7etm", "UPDATE_CELL_SIZES", "UPDATE_BOUNDARY",
"UPDATE_OVERVIEWS", "2", "#", "#", "GCS_WGS_1984.prj",
"*.tif", "SUBFOLDERS", "EXCLUDE_DUPLICATES",
"NO_PYRAMIDS", "NO_STATISTICS", "BUILD_THUMBNAILS",
"Add Landsat L1G", "FORCE_SPATIAL_REFERENCE",
"NO_STATISTICS", "", "USE_PIXEL_CACHE",
r"C:\test\cachelocation")This is a Python script sample for the AddRastersToMosaicDataset tool.
#Add Raster Dataset type Raster to FGDB Mosaic Dataset
#Calculate Cell Size Ranges and Build Boundary
#Build Overviews for Mosaic Dataset upon the 3rd level Raster Dataset pyramid
#Apply TIFF file filter
#Build Pyramids for the source datasets
import arcpy
arcpy.env.workspace = "C:/Workspace"
mdname = "AddMD.gdb/md_rasds"
rastype = "Raster Dataset"
inpath = "c:/data/rasds"
updatecs = "UPDATE_CELL_SIZES"
updatebnd = "UPDATE_BOUNDARY"
updateovr = "UPDATE_OVERVIEWS"
maxlevel = "2"
maxcs = "#"
maxdim = "#"
spatialref = "#"
inputdatafilter = "*.tif"
subfolder = "NO_SUBFOLDERS"
duplicate = "EXCLUDE_DUPLICATES"
buildpy = "BUILD_PYRAMIDS"
calcstats = "CALCULATE_STATISTICS"
buildthumb = "NO_THUMBNAILS"
comments = "Add Raster Datasets"
forcesr = "#"
estimatestats = "ESTIMATE_STATISTICS"
auxilaryinput = ""
enablepixcache = "USE_PIXEL_CACHE"
cachelocation = "c:\\test\\cachelocation"
arcpy.AddRastersToMosaicDataset_management(
mdname, rastype, inpath, updatecs, updatebnd, updateovr,
maxlevel, maxcs, maxdim, spatialref, inputdatafilter,
subfolder, duplicate, buildpy, calcstats,
buildthumb, comments, forcesr, estimatestats
auxilaryinput, enablepixcache, cachelocation)Environments
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes