Back to Top

Create Referenced Mosaic Dataset (Data Management)

In this topic

  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information

Summary

Creates a separate mosaic dataset from items in an existing mosaic dataset.

Usage

  • A referenced mosaic dataset can be created in a geodatabase or a folder. When the mosaic dataset is created in a folder, it will not include a boundary.

  • Overviews cannot be created for a referenced mosaic dataset.

  • You can use this tool to create a mosaic dataset from another mosaic dataset when you want to create a mosaic dataset with a different output. For example, you can create one mosaic dataset with elevation data and create another that will be used to produce a derived product, such as slope or hillshade.

Parameters

DialogPython

LabelExplanationData Type
Mosaic Dataset

The mosaic dataset from which items will be selected.

Mosaic Layer; Mosaic Dataset
Output Mosaic Dataset

The referenced mosaic dataset to be created.

Mosaic Dataset
Coordinate System
(Optional)

The projection for the output mosaic dataset.

Coordinate System
Number of Bands
(Optional)

The number of bands that the referenced mosaic dataset will have.

Long
Pixel Type
(Optional)

The bit depth, or radiometric resolution, of the mosaic dataset. If this is not defined, it will be taken from the first raster dataset.

  • 1-bit—The pixel type will be a 1-bit unsigned integer. The values can be 0 or 1.
  • 2-bit—The pixel type will be a 2-bit unsigned integer. The values supported can range from 0 to 3.
  • 4-bit—The pixel type will be a 4-bit unsigned integer. The values supported can range from 0 to 15.
  • 8-bit unsigned—The pixel type will be an unsigned 8-bit data type. The values supported can range from 0 to 255.
  • 8-bit signed—The pixel type will be a signed 8-bit data type. The values supported can range from -128 to 127.
  • 16-bit unsigned—The pixel type will be a 16-bit unsigned data type. The values can range from 0 to 65,535.
  • 16-bit signed—The pixel type will be a 16-bit signed data type. The values can range from -32,768 to 32,767.
  • 32-bit unsigned—The pixel type will be a 32-bit unsigned data type. The values can range from 0 to 4,294,967,295.
  • 32-bit signed—The pixel type will be a 32-bit signed data type. The values can range from -2,147,483,648 to 2,147,483,647.
  • 32-bit floating point—The pixel type will be a 32-bit data type supporting decimals.
  • 64-bit—The pixel type will be a 64-bit data type supporting decimals.
String
Query Definition
(Optional)

An SQL expression to select raster datasets that will be included in the output mosaic dataset.

SQL Expression
Extent from Dataset
(Optional)

Select raster datasets based on the extent of another image or feature class. Raster datasets that lay along the defined extent will be included in the mosaic dataset. To manually input the minimum and maximum coordinates for the extent, use the Extent parameter.

Feature Layer; Raster Layer
Extent
(Optional)

The minimum and maximum coordinates for the extent. If a dataset is selected in Extent from Dataset, those coordinates will automatically appear here.

Envelope
Using Input Geometry for Selection
(Optional)

Limit the extent to the shape or envelope when a feature class is selected in the Extent from Dataset parameter.

  • Checked—Select based on the shape of the feature. This is the default.
  • Unchecked—Select based on the extent of the feature class.
Boolean
Scale Field
(Optional)
Legacy:

This parameter has been deprecated and is ignored in tool execution. It remains for backward compatibility reasons.

Field
Minimum Cell Size Field
(Optional)

Specify a field from the footprint attribute table that defines the minimum cell size for displaying the mosaic dataset; otherwise, only a footprint will be displayed.

Field
Maximum Cell Size Field
(Optional)

Specify a field from the footprint attribute table that defines the maximum cell size for displaying the mosaic dataset; otherwise, only a footprint will be displayed.

Field
Maximum Visible Cell Size
(Optional)

Set a maximum cell size to display the mosaic instead of specifying a field. If you zoom out beyond this cell size, only the footprint will be displayed.

Double
Build Boundary
(Optional)

Rebuild the boundary. If the selection covers a smaller area than the source mosaic dataset, this is recommended.

This is only available if the mosaic dataset is created in a geodatabase.

  • Checked—Generate the boundary. This is the default.
  • Unchecked—Do not generate the boundary.
Boolean

arcpy.management.CreateReferencedMosaicDataset(in_dataset, out_mosaic_dataset, {coordinate_system}, {number_of_bands}, {pixel_type}, {where_clause}, {in_template_dataset}, {extent}, {select_using_features}, {lod_field}, {minPS_field}, {maxPS_field}, {pixelSize}, {build_boundary})
NameExplanationData Type
in_dataset

The mosaic dataset from which items will be selected.

Mosaic Layer; Mosaic Dataset
out_mosaic_dataset

The referenced mosaic dataset to be created.

Mosaic Dataset
coordinate_system
(Optional)

The projection for the output mosaic dataset.

Coordinate System
number_of_bands
(Optional)

The number of bands that the referenced mosaic dataset will have.

Long
pixel_type
(Optional)

The bit depth, or radiometric resolution, of the mosaic dataset. If this is not defined, it will be taken from the first raster dataset.

  • 1_BIT—The pixel type will be a 1-bit unsigned integer. The values can be 0 or 1.
  • 2_BIT—The pixel type will be a 2-bit unsigned integer. The values supported can range from 0 to 3.
  • 4_BIT—The pixel type will be a 4-bit unsigned integer. The values supported can range from 0 to 15.
  • 8_BIT_UNSIGNED—The pixel type will be an unsigned 8-bit data type. The values supported can range from 0 to 255.
  • 8_BIT_SIGNED—The pixel type will be a signed 8-bit data type. The values supported can range from -128 to 127.
  • 16_BIT_UNSIGNED—The pixel type will be a 16-bit unsigned data type. The values can range from 0 to 65,535.
  • 16_BIT_SIGNED—The pixel type will be a 16-bit signed data type. The values can range from -32,768 to 32,767.
  • 32_BIT_UNSIGNED—The pixel type will be a 32-bit unsigned data type. The values can range from 0 to 4,294,967,295.
  • 32_BIT_SIGNED—The pixel type will be a 32-bit signed data type. The values can range from -2,147,483,648 to 2,147,483,647.
  • 32_BIT_FLOAT—The pixel type will be a 32-bit data type supporting decimals.
  • 64_BIT—The pixel type will be a 64-bit data type supporting decimals.
String
where_clause
(Optional)

An SQL expression to select raster datasets that will be included in the output mosaic dataset.

SQL Expression
in_template_dataset
(Optional)

Select raster datasets based on the extent of another image or feature class. Raster datasets that lay along the defined extent will be included in the mosaic dataset. To manually input the minimum and maximum coordinates for the extent, use the Extent parameter.

Feature Layer; Raster Layer
extent
(Optional)

The minimum and maximum coordinates for the extent.

Envelope
select_using_features
(Optional)

Limit the extent to the shape or envelope when a feature class is specified in the in_template_dataset parameter.

  • SELECT_USING_FEATURES—Select using the shape of the feature. This is the default.
  • NO_SELECT_USING_FEATURES—Select using the extent of the data in the feature class.
Boolean
lod_field
(Optional)
Legacy:

This parameter has been deprecated and is ignored in tool execution. It remains for backward compatibility reasons.

Field
minPS_field
(Optional)

Specify a field from the footprint attribute table that defines the minimum cell size for displaying the mosaic dataset; otherwise, only a footprint will be displayed.

Field
maxPS_field
(Optional)

Specify a field from the footprint attribute table that defines the maximum cell size for displaying the mosaic dataset; otherwise, only a footprint will be displayed.

Field
pixelSize
(Optional)

Set a maximum cell size to display the mosaic instead of specifying a field. If you zoom out beyond this cell size, only the footprint will be displayed.

Double
build_boundary
(Optional)

Rebuild the boundary. If the selection covers a smaller area than the source mosaic dataset, this is recommended.

This is only available if the mosaic dataset is created in a geodatabase.

  • BUILD_BOUNDARY—The boundary will be generated or updated. This is the default.
  • NO_BOUNDARY— The boundary will not be generated.
Boolean

Code sample

CreateReferencedMosaicDataset example 1 (Python window)

This is a Python sample for the CreateReferencedMosaicDataset tool.

import arcpy
arcpy.CreateReferencedMosaicDataset_management(
     "C:/workspace/RefMD.gdb/md", "ref_md.amd", "GCS_WGS_1984.prj",
     "1", "#", "#", "ref_md.shp", "#", "SELECT_USING_FEATURES", "#", 
     "#", "#", "#", "NO_BOUNDARY")
CreateReferencedMosaicDataset example 2 (stand-alone script)

This is a Python script sample for the CreateReferencedMosaicDataset tool.

# Create Referenced Mosaic Dataset from existing Mosaic Dataset
# Use shape file to clip the source mosaic dataset


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

arcpy.CreateReferencedMosaicDataset_management(
     "RefMD.gdb/md", "ref_md.amd", "GCS_WGS_1984.prj", "1", "#", "#", 
     "ref_md.shp", "#", "SELECT_USING_FEATURES", "#", "#", "#", "#", 
     "NO_BOUNDARY")

Environments

Current Workspace, Extent, Output CONFIG Keyword, Scratch Workspace

Licensing information

  • Basic: No
  • Standard: Yes
  • Advanced: Yes

Related topics

  • An overview of the Raster toolset
  • Find a geoprocessing tool

Feedback on this topic?

In this topic
  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information