Back to Top

Set Mosaic Dataset Properties (Data Management)

In this topic

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

Summary

Defines the defaults for displaying a mosaic dataset and serving it as an image service.

Usage

  • The current mosaic dataset properties are on the Defaults tab of the Mosaic Dataset Properties dialog box.

Parameters

DialogPython

LabelExplanationData Type
Mosaic Dataset

The mosaic dataset with the properties that will be set.

Mosaic Layer
Rows of Maximum Image Size of Requests
(Optional)

The maximum number of rows for the mosaicked image, generated by the mosaic dataset for each request. This can help control how much work the server has to do when clients view the imagery. A higher number will create a larger image but will increase the amount of time to process the mosaic dataset. If the value is too low, the image may not display.

Long
Columns of Maximum Image Size of Requests
(Optional)

The maximum number of columns for the mosaicked image, generated by the mosaic dataset for each request. This can help control how much work the server has to do when clients view the imagery. A higher number will create a larger image but will increase the amount of time to process the mosaic dataset. If the value is too low, the image may not display.

Long
Allowed Transmission Compression
(Optional)

Specifies the compression methods that will be used to transmit the mosaicked image from the computer to the display (or from the server to the client).

  • None—No compression will be used.
  • JPEG— Compression up to 8:1 will be used, which is suitable for backdrops.
  • LZ77— Compression of approximately 2:1 will be used, which is suitable for analysis.
  • LERC—Compression between 10:1 and 20:1 will be used, which is fast and suitable for serving raw imagery with high bit depth (12 bit to 32 bit).
String
Default Compression Type
(Optional)

Specifies the default compression type. The default compression must be in the list of values used for the Allowed Transmission Compression parameter or must be set in the mosaic dataset's Allowed Compression Methods property.

  • None—No compression will be used.
  • JPEG— Compression up to 8:1 will be used, which is suitable for backdrops.
  • LZ77— Compression of approximately 2:1 will be used, which is suitable for analysis.
  • LERC—Compression between 10:1 and 20:1 will be used, which is fast and suitable for serving raw imagery with high bit depth (12 bit to 32 bit).
  • None—No compression will be used.
  • JPEG— Compression up to 8:1 will be used, which is suitable for backdrops.
  • LZ77— Compression of approximately 2:1 will be used, which is suitable for analysis.
  • LERC—Compression between 10:1 and 20:1 will be used, which is fast and suitable for serving raw imagery with high bit depth (12 bit to 32 bit).
String
JPEG Quality
(Optional)

The compression quality when using JPEG. Compression quality ranges from 1 to 100. A higher number means better image quality but less compression.

Long
LERC Tolerance
(Optional)

The maximum per pixel error when using LERC compression. This value is specified in the units of the mosaic dataset. For example, if the error is 10 centimeters and the mosaic dataset is in meters, enter 0.1.

Double
Resampling Technique
(Optional)

Specifies how pixel values will be calculated when the dataset is displayed at small scales. Choose an appropriate technique based on the type of data.

  • Nearest—The value of each pixel will be from the nearest corresponding pixel. This technique is suitable for discrete data, such as land cover.This is the fastest resampling technique. It minimizes the changes to pixel values since it uses the value from the nearest pixel.
  • Bilinear—The value of each pixel will be calculated by averaging the values of the surrounding four pixels (based on distance). This technique is suitable for continuous data.
  • Cubic—The value of each pixel will be calculated by fitting a smooth curve based on the surrounding 16 pixels. This technique produces the smoothest image but can create values outside of the range in the source data. It is suitable for continuous data.
  • Majority—The value of each pixel will be based on the most popular value in a 3 by 3 window. This technique is suitable for discrete data.
String
Clip To Footprints
(Optional)

Specifies whether rasters will be clipped to the footprint. Often the raster dataset and its footprint have the same extent. If they differ, the raster dataset can be clipped to the footprint.

  • Unchecked—The rasters will not be clipped to the footprint. This is the default.
  • Checked—The rasters will be clipped to the footprint.
Boolean
Footprints May Contain NoData
(Optional)

Specifies whether pixels with NoData values will be shown.

  • Checked—Pixels with NoData values will be shown.
  • Unchecked—Pixels with NoData values will not be shown. You may notice an improvement in performance; however, if the imagery does include NoData values, they will appear as holes in the mosaic dataset.
Boolean
Clip To Boundary
(Optional)

Specifies whether the mosaicked image will be clipped to the boundary. Often the mosaic dataset and its boundary have the same extent. If they differ, the mosaic dataset can be clipped to the boundary.

  • Checked—The mosaicked image will be clipped to the boundary. This is the default.
  • Unchecked—The mosaicked image will not be clipped to the boundary.
Boolean
Color Correction
(Optional)

Specifies whether color correction will be used on the mosaic dataset.

  • Unchecked—Color correction will not be used. This is the default.
  • Checked—The color correction that has been set up for the mosaic dataset will be used.
Boolean
Allowed Mensuration Capabilities
(Optional)

Specifies the measurements that will be performed on the mosaic dataset. The ability to perform vertical measurements is dependent on the imagery and may require a DEM.

  • None—No mensuration capabilities will be performed.
  • Basic—Ground measurements such as distance, point, centroid, and area calculations will be performed.
  • Feature base to top of feature—Measurements from the base to the top of features will be performed. Rational polynomial coefficients must be imbedded in the imagery.
  • Feature base to top of shadow—Measurements from the base of a feature to the top of its shadow will be performed. Sun azimuth and sun elevation information is required.
  • Top of feature to top of shadow—Measurements from the top of a feature to the top of its shadow will be performed. Sun azimuth, sun elevation, and rational polynomial coefficients are required.
  • Measure in 3D—Measurements in 3D will be performed if a DEM is available.
String
Default Mensuration
(Optional)

Specifies the default mensuration capability for the mosaic dataset. The default mensuration value must be set in the list of values used for the Allowed Mensuration Capabilities parameter or be set in the mosaic dataset's Mensuration Capabilities property.

  • None—No mensuration capabilities will be performed.
  • Basic— Ground measurements such as distance, point, centroid, and area calculations will be performed.
  • Feature base to top of feature—Measurements from the base to the top of features will be performed. Rational polynomial coefficients must be imbedded in the imagery.
  • Feature base to top of shadow—Measurements from the base of a feature to the top of its shadow will be performed. Sun azimuth and sun elevation information is required.
  • Top of feature to top of shadow—Measurements from the top of a feature to the top of its shadow will be performed. Sun azimuth, sun elevation, and rational polynomial coefficients are required.
  • Measure in 3D—Measurements in 3D will be performed if a DEM is available.
  • None—No mensuration capabilities will be performed.
  • Basic— Ground measurements such as distance, point, centroid, and area calculations will be performed.
  • Feature base to top of feature—Measurements from the base to the top of features will be performed. Rational polynomial coefficients must be imbedded in the imagery.
  • Feature base to top of shadow—Measurements from the base of a feature to the top of its shadow will be performed. Sun azimuth and sun elevation information is required.
  • Top of feature to top of shadow—Measurements from the top of a feature to the top of its shadow will be performed. Sun azimuth, sun elevation, and rational polynomial coefficients are required.
  • Measure in 3D—Measurements in 3D will be performed if a DEM is available.
String
Allowed Mosaic Methods
(Optional)

Specifies the rules for displaying overlapping imagery.

  • None—Rasters will be ordered based on the ObjectID field in the mosaic dataset attribute table.
  • Center—Imagery that is closest to the center of the screen will be displayed.
  • Northwest—Imagery that is closest to the northwest corner of the mosaic dataset boundary will be displayed.
  • Lock raster—Selected raster datasets will be displayed.
  • By attribute—Imagery will be displayed and prioritized based on a field in the attribute table.
  • Nadir—Rasters with viewing angles closest to zero will be displayed.
  • Viewpoint—Imagery that is closest to a selected viewing angle will be displayed.
  • Seamline—Transitions between images will be smoothed using seamlines.
String
Default Mosaic Methods
(Optional)

Specifies the mosaic method that will be used for views. The default mosaic method must be set in the list of values used for the Allowed Mosaic Methods parameter or be set in the mosaic dataset's Allowed Mosaic Methods property.

  • None—Rasters will be ordered based on the ObjectID field in the mosaic dataset attribute table.
  • Center—Imagery that is closest to the center of the screen will be displayed.
  • Northwest—Imagery that is closest to the northwest corner of the mosaic dataset boundary will be displayed.
  • Lock raster—Selected raster datasets will be displayed.
  • By attribute—Imagery will be displayed and prioritized based on a field in the attribute table.
  • Nadir—Rasters with viewing angles closest to zero will be displayed.
  • Viewpoint—Imagery that is closest to a selected viewing angle will be displayed.
  • Seamline—Transitions between images will be smoothed using seamlines.
  • None—Rasters will be ordered based on the ObjectID field in the mosaic dataset attribute table.
  • Center—Imagery that is closest to the center of the screen will be displayed.
  • Northwest—Imagery that is closest to the northwest corner of the mosaic dataset boundary will be displayed.
  • Lock raster—Selected raster datasets will be displayed.
  • By attribute—Imagery will be displayed and prioritized based on a field in the attribute table.
  • Nadir—Rasters with viewing angles closest to zero will be displayed.
  • Viewpoint—Imagery that is closest to a selected viewing angle will be displayed.
  • Seamline—Transitions between images will be smoothed using seamlines.
String
Order Field
(Optional)

The field that will be used when ordering rasters using the By attribute value of the Default Mosaic Methods parameter. The list of available fields are defined as those in the attribute table that are of type metadata and are integer. This list can include, but is not limited to, the following:

  • MinPS
  • MaxPS
  • LowPS
  • HighPS
  • CenterX
  • CenterY
  • ZOrder
  • Shape_Length
  • Shape_Area

If the field is a numeric or date field, the Order Base parameter must be set.

This parameter is not needed if the By attribute value is not part of the Allowed Mosaic Methods list.

String
Order Base
(Optional)

Sorts the rasters based on their difference from this value in the field selected in the Order Field parameter.

If a Date attribute is used, it must be in one of the following formats:

  • YYYY/MM/DD HH:mm:ss.s
  • YYYY/MM/DD HH:mm:ss
  • YYYY/MM/DD HH:mm
  • YYYY/MM/DD HH
  • YYYY/MM/DD
  • YYYY/MM
  • YYYY

This parameter is required only if the By attribute value is specified for the Allowed Mosaic Methods parameter.

String
Sorting Order Ascending
(Optional)

Specifies whether the rasters will be sorted in an ascending or a descending order.

  • Checked—Rasters will be sorted in an ascending order. This is the default.
  • Unchecked—Rasters will be sorted in a descending order.

This parameter is required only if the By attribute value is specified for the Allowed Mosaic Methods parameter.

Boolean
Mosaic Operator
(Optional)

Specifies the rule that will be used for resolving overlapping pixels.

  • First—The first image in the attribute table will be displayed.
  • Last—The last image in the attribute table will be displayed.
  • Minimum—The lowest pixel values will be displayed.
  • Maximum—The highest pixel values will be displayed.
  • Mean—The arithmetic mean will be used to average overlapping pixels.
  • Blend—A distance weighted algorithm will be used to average overlapping pixels.
  • Sum—All of the overlapping pixel values will be added together.
String
Blend Width
(Optional)

The number of pixels to which the Blend value of the Mosaic Operator parameter will be applied.

Long
View Point Spacing X
(Optional)

A numeric value that will be used to horizontally shift the center of the image. The units are the same as the spatial reference system.

This parameter is only applicable if the Allowed Mosaic Methods parameter is set to Viewpoint.

Double
View Point Spacing Y
(Optional)

A numeric value that will be used to vertically shift the center of the image. The units are the same as the spatial reference system.

This parameter is only applicable if the Allowed Mosaic Methods parameter is set to Viewpoint.

Double
Max Number Per Mosaic
(Optional)

The maximum number of raster datasets that will be displayed at a given time in a mosaic dataset.

Long
Cell Size Tolerance Factor
(Optional)

The maximum pixel size difference that is allowed before images are considered to have a different cell pixel.

This allows images of similar spatial resolutions to be considered as having the same nominal resolution. For example, with a factor of 0.1, all images with cell sizes within 10 percent of each other will be grouped for tools and operations that use cell sizes.

Double
Output Cell Size
(Optional)

The cell size of the mosaic dataset using an existing raster dataset or its specified width (x) and height (y).

Cell Size XY
Metadata Level
(Optional)

Specifies the level of metadata that will be exposed from the server to a client when publishing the mosaic dataset.

  • Full metadata—Metadata regarding the processing applied at the mosaic dataset level as well as metadata related to the individual raster datasets will be exposed.
  • No metadata—No metadata will be exposed to the client.
  • Basic metadata—Metadata related to individual raster datasets, such as the number of columns and rows, cell size, and spatial reference information, will be exposed.
String
Allowed Transmission Field
(Optional)

The fields in the attribute table that clients can view. By default, the list includes the following:

  • Name
  • MinPS
  • MaxPS
  • LowPS
  • HighPS
  • Tag
  • GroupName
  • ProductName
  • CenterX
  • CenterY
  • ZOrder
  • Shape_Length
  • Shape_Area

String
Use Time
(Optional)

Specifies whether the mosaic dataset will be time aware. If time is activated, the start and end fields and the time format must be specified.

  • Unchecked—The mosaic dataset will not be time aware. This is the default.
  • Checked—The mosaic dataset will be time aware. This allows the client to use the Time Slider.
Boolean
Start Time Field
(Optional)

The field in the attribute table that shows the start time.

String
End Time Field
(Optional)

The field in the attribute table that shows the end time.

String
Time Format
(Optional)

Specifies the time format that will be used for the mosaic dataset for parameters such as Start Time Field and End Time Field.

  • YYYY (Year)—The time format will be year.
  • YYYYMM (Year and month)—The time format will be year and month.
  • YYYY/MM (Year and month)—The time format will be year and month.
  • YYYY-MM (Year and month)—The time format will be year and month.
  • YYYYMMDD (Year, month, and day)—The time format will be year, month, and day.
  • YYYY/MM/DD (Year, month, and day)—The time format will be year, month, and day.
  • YYYY-MM-DD (Year, month, and day)—The time format will be year, month, and day.
  • YYYYMMDDhhmmss (Year, month, day, hour, minute, and seconds)—The time format will be year, month, day, hour, minute, and seconds.
  • YYYY/MM/DD hh:mm:ss (Year, month, day, hour, minute, and seconds)—The time format will be year, month, day, hour, minute, and seconds.
  • YYYY-MM-DD hh:mm:ss (Year, month, day, hour, minute, and seconds)—The time format will be year, month, day, hour, minute, and seconds.
  • YYYYMMDDhhmmss.s (Year, month, day, hour, minute, seconds, and fraction of seconds)—The time format will be year, month, day, hour, minute, seconds, and fraction of seconds.
  • YYYY/MM/DD hh:mm:ss.s (Year, month, day, hour, minute, seconds, and fraction of seconds)—The time format will be year, month, day, hour, minute, seconds, and fraction of seconds.
  • YYYY-MM-DD hh:mm:ss.s (Year, month, day, hour, minute, seconds, and fraction of seconds)—The time format will be year, month, day, hour, minute, seconds, and fraction of seconds.
String
Geographic Transformation
(Optional)

The geographic transformations that will be associated with the mosaic dataset.

String
Max Number of Download Items
(Optional)

The maximum number of raster datasets that will be downloaded per request.

Long
Max Number of Records Returned
(Optional)

The maximum number of records that will be downloaded per request.

Long
Data Source Type
(Optional)

Specifies the type of imagery in the mosaic dataset.

  • Generic—The mosaic dataset contains no specified data type.
  • Thematic—The mosaic dataset contains thematic data with discrete values, such as land cover.
  • Processed—The mosaic dataset has been color adjusted.
  • Elevation—The mosaic dataset contains elevation data.
  • Scientific—The mosaic dataset contains scientific data.
  • Two variable vector—The mosaic dataset has two variables.
  • Magnitude and direction—The mosaic dataset has magnitude and direction.
String
Minimum Pixel Contribution
(Optional)

The minimum number of pixels required for a mosaic dataset item to be considered significant enough to be used in the mosaic dataset. Because of overlapping imagery, an item may display only a small sliver of its overall image. Skipping these mosaic dataset items will improve performance of the mosaic dataset.

Long
Processing Templates
(Optional)

The function chains that will be used to process a mosaic dataset or the mosaic dataset items on the fly. You can add, remove, or reorder the function chains.

All the template names that are added must be unique.

File; String
Default Processing Template
(Optional)

The default function chain. The default function chain will be applied when the mosaic dataset is accessed.

String
Time Interval
(Optional)

The duration of each time step interval. The time step interval defines the granularity of the temporal data. The unit of time is specified in the Time Interval Units parameter.

Double
Time Interval Units
(Optional)

Specifies the measurement unit that will be used for the time interval.

  • None—No time unit exists or it is unknown.
  • Milliseconds—The time unit will be milliseconds.
  • Seconds—The time unit will be seconds.
  • Minutes—The time unit will be minutes.
  • Hours—The time unit will be hours.
  • Days—The time unit will be days.
  • Weeks—The time unit will be weeks.
  • Months—The time unit will be months.
  • Years—The time unit will be years.
  • Decades—The time unit will be decades.
  • Centuries—The time unit will be centuries.
String
Product Definition
(Optional)

Specifies a template that is either specific to the type of imagery you are working with or generic. The generic options include the standard supported raster sensor types as follows:

  • None—No band ordering is specified for the mosaic dataset. This is the default.
  • Natural color—A 3-band mosaic dataset, with red, green, and blue wavelength ranges will be created. This is designed for natural color imagery.
  • Natural color and infrared—A 4-band mosaic dataset, with red, green, blue, and near infrared wavelength ranges will be created.
  • U and V—A mosaic dataset displaying two variables will be created.
  • Magnitude and Direction—A mosaic dataset displaying magnitude and direction will be created.
  • Color infrared—A 3-band mosaic dataset, with near infrared, red, and green wavelength ranges will be created.
  • BlackSky—A 3-band mosaic dataset using the BlackSky wavelength ranges will be created
  • DMCii—A 3-band mosaic dataset using the DMCii wavelength ranges will be created.
  • Deimos-2—A 4-band mosaic dataset using the Deimos-2 wavelength ranges will be created.
  • DubaiSat-2—A 4-band mosaic dataset using the DubaiSat-2 wavelength ranges will be created.
  • FORMOSAT-2—A 4-band mosaic dataset using the FORMOSAT-2 wavelength ranges will be created.
  • GeoEye-1—A 4-band mosaic dataset using the GeoEye-1 wavelength ranges will be created.
  • GF-1 Panchromatic/Multispectral (PMS)—A 4-band mosaic dataset using the Gaofen-1 Panchromatic Multispectral Sensor wavelength ranges will be created.
  • GF-1 Wide Field of View (WFV)—A 4-band mosaic dataset using the Gaofen-1 Wide Field of View Sensor wavelength ranges will be created.
  • GF-2 Panchromatic/Multispectral (PMS)—A 4-band mosaic dataset using the Gaofen-2 Panchromatic Multispectral Sensor wavelength ranges will be created.
  • GF-4 Panchromatic/Multispectral Imagery (PMI)—A 4-band mosaic dataset using the Gaofen-4 panchromatic and multispectral wavelength ranges will be created.
  • HJ 1A/1B Multispectral/Hyperspectral—A 4-band mosaic dataset using the Huan Jing-1 CCD Multispectral or Hyperspectral Sensor wavelength ranges will be created.
  • IKONOS—A 4-band mosaic dataset using the IKONOS wavelength ranges will be created.
  • Jilin-1—A 3-band mosaic dataset using the Jilin-1 wavelength ranges will be created.
  • KOMPSAT-2—A 4-band mosaic dataset using the KOMPSAT-2 wavelength ranges will be created.
  • KOMPSAT-3—A 4-band mosaic dataset using the KOMPSAT-3 wavelength ranges will be created.
  • Landsat TM and ETM+—A 6-band mosaic dataset using the Landsat 5 and 7 wavelength ranges from the TM and ETM+ sensors will be created.
  • Landsat OLI—An 8-band mosaic dataset using the Landsat 8 wavelength ranges will be created.
  • Landsat 9—An 8-band mosaic dataset using the Landsat 9 wavelength ranges will be created.
  • Landsat MSS—A 4-band mosaic dataset using the Landsat wavelength ranges from the MSS sensor will be created.
  • PlanetScope—A 5-band mosaic dataset using the PlanetScope wavelength ranges will be created.
  • Pleiades 1—A 4-band mosaic dataset using the Pleiades 1 wavelength ranges will be created.
  • Pleiades Neo—A 6-band mosaic dataset using the Pleiades Neo wavelength ranges will be created.
  • QuickBird—A 4-band mosaic dataset using the QuickBird wavelength ranges will be created.
  • RapidEye—A 5-band mosaic dataset using the RapidEye wavelength ranges will be created.
  • Sentinel 2 MSI—A 13-band mosaic dataset using the Sentinel 2 MSI wavelength ranges will be created.
  • SkySat-C—A 4-band mosaic dataset using the SkySat-C MSI wavelength ranges will be created.
  • SPOT-5—A 4-band mosaic dataset using the SPOT-5 wavelength ranges will be created.
  • SPOT-6—A 4-band mosaic dataset using the SPOT-6 wavelength ranges will be created.
  • SPOT-7—A 4-band mosaic dataset using the SPOT-7 wavelength ranges will be created.
  • SuperView-1—A 4-band mosaic dataset using the SuperView-1 wavelength ranges will be created.
  • TH-01—A 4-band mosaic dataset using the Tian Hui-1 wavelength ranges will be created.
  • Vision-1—A 4-band mosaic dataset using the Vision-1 wavelength ranges will be created.
  • WorldView-2—An 8-band mosaic dataset using the WorldView-2 wavelength ranges will be created.
  • WorldView-3—An 8-band mosaic dataset using the WorldView-3 wavelength ranges will be created.
  • WorldView-4—A 4-band mosaic dataset using the WorldView-4 wavelength ranges will be created.
  • ZY-1 Panchromatic/Multispectral—A 3-band mosaic dataset using the ZiYuan-1 panchromatic/multispectral wavelength ranges will be created.
  • ZY-3 CRESDA—A 4-band mosaic dataset using the ZiYuan-3 CRESDA wavelength ranges will be created.
  • ZY3 SASMAC—A 4-band mosaic dataset using the ZiYuan-3 SASMAC wavelength ranges will be created.
  • Custom—The number of bands and the average wavelength for each band are defined using the Product Band Definitions parameter (product_band_definitions in Python).
String
Product Band Definitions
(Optional)

The wavelength ranges, number of bands, and band order definitions. To edit the number of bands, use the Add another and Remove controls. To rearrange the band order, right-click a band definition and move the band up or down in the list.

Value Table

Derived Output

LabelExplanationData Type
Updated Mosaic Dataset

The updated mosaic dataset.

Mosaic Layer

arcpy.management.SetMosaicDatasetProperties(in_mosaic_dataset, {rows_maximum_imagesize}, {columns_maximum_imagesize}, {allowed_compressions}, {default_compression_type}, {JPEG_quality}, {LERC_Tolerance}, {resampling_type}, {clip_to_footprints}, {footprints_may_contain_nodata}, {clip_to_boundary}, {color_correction}, {allowed_mensuration_capabilities}, {default_mensuration_capabilities}, {allowed_mosaic_methods}, {default_mosaic_method}, {order_field}, {order_base}, {sorting_order}, {mosaic_operator}, {blend_width}, {view_point_x}, {view_point_y}, {max_num_per_mosaic}, {cell_size_tolerance}, {cell_size}, {metadata_level}, {transmission_fields}, {use_time}, {start_time_field}, {end_time_field}, {time_format}, {geographic_transform}, {max_num_of_download_items}, {max_num_of_records_returned}, {data_source_type}, {minimum_pixel_contribution}, {processing_templates}, {default_processing_template}, {time_interval}, {time_interval_units}, {product_definition}, {product_band_definitions})
NameExplanationData Type
in_mosaic_dataset

The mosaic dataset with the properties that will be set.

Mosaic Layer
rows_maximum_imagesize
(Optional)

The maximum number of rows for the mosaicked image, generated by the mosaic dataset for each request. This can help control how much work the server has to do when clients view the imagery. A higher number will create a larger image but will increase the amount of time to process the mosaic dataset. If the value is too low, the image may not display.

Long
columns_maximum_imagesize
(Optional)

The maximum number of columns for the mosaicked image, generated by the mosaic dataset for each request. This can help control how much work the server has to do when clients view the imagery. A higher number will create a larger image but will increase the amount of time to process the mosaic dataset. If the value is too low, the image may not display.

Long
allowed_compressions
[allowed_compressions,...]
(Optional)

Specifies the compression methods that will be used to transmit the mosaicked image from the computer to the display (or from the server to the client).

  • None—No compression will be used.
  • JPEG— Compression up to 8:1 will be used, which is suitable for backdrops.
  • LZ77— Compression of approximately 2:1 will be used, which is suitable for analysis.
  • LERC—Compression between 10:1 and 20:1 will be used, which is fast and suitable for serving raw imagery with high bit depth (12 bit to 32 bit).
String
default_compression_type
(Optional)

Specifies the default compression type. The default compression must be in the list of values used for the allowed_compressions parameter or must be set in the mosaic dataset's Allowed Compression Methods property.

  • None—No compression will be used.
  • JPEG— Compression up to 8:1 will be used, which is suitable for backdrops.
  • LZ77— Compression of approximately 2:1 will be used, which is suitable for analysis.
  • LERC—Compression between 10:1 and 20:1 will be used, which is fast and suitable for serving raw imagery with high bit depth (12 bit to 32 bit).
String
JPEG_quality
(Optional)

The compression quality when using JPEG. Compression quality ranges from 1 to 100. A higher number means better image quality but less compression.

Long
LERC_Tolerance
(Optional)

The maximum per pixel error when using LERC compression. This value is specified in the units of the mosaic dataset. For example, if the error is 10 centimeters and the mosaic dataset is in meters, enter 0.1.

Double
resampling_type
(Optional)

Specifies how pixel values will be calculated when the dataset is displayed at small scales. Choose an appropriate technique based on the type of data.

  • NEAREST—The value of each pixel will be from the nearest corresponding pixel. This technique is suitable for discrete data, such as land cover.This is the fastest resampling technique. It minimizes the changes to pixel values since it uses the value from the nearest pixel.
  • BILINEAR—The value of each pixel will be calculated by averaging the values of the surrounding four pixels (based on distance). This technique is suitable for continuous data.
  • CUBIC—The value of each pixel will be calculated by fitting a smooth curve based on the surrounding 16 pixels. This technique produces the smoothest image but can create values outside of the range in the source data. It is suitable for continuous data.
  • MAJORITY—The value of each pixel will be based on the most popular value in a 3 by 3 window. This technique is suitable for discrete data.
String
clip_to_footprints
(Optional)

Specifies whether rasters will be clipped to the footprint. Often the raster dataset and its footprint have the same extent. If they differ, the raster dataset can be clipped to the footprint.

  • NOT_CLIP—The rasters will not be clipped to the footprint. This is the default.
  • CLIP—The rasters will be clipped to the footprint.
Boolean
footprints_may_contain_nodata
(Optional)

Specifies whether pixels with NoData values will be shown.

  • FOOTPRINTS_MAY_CONTAIN_NODATA—Pixels with NoData values will be shown. This is the default.
  • FOOTPRINTS_DO_NOT_CONTAIN_NODATA—Pixels with NoData values will not be shown. You may notice an improvement in performance; however, if the imagery does include NoData values, they will appear as holes in the mosaic dataset.
Boolean
clip_to_boundary
(Optional)

Specifies whether the mosaicked image will be clipped to the boundary. Often the mosaic dataset and its boundary have the same extent. If they differ, the mosaic dataset can be clipped to the boundary.

  • CLIP— The mosaicked image will be clipped to the boundary. This is the default.
  • NOT_CLIP—The mosaicked image will not be clipped to the boundary.
Boolean
color_correction
(Optional)

Specifies whether color correction will be used on the mosaic dataset.

  • NOT_APPLY—Color correction will not be used. This is the default.
  • APPLY—The color correction that has been set up for the mosaic dataset will be used.
Boolean
allowed_mensuration_capabilities
[allowed_mensuration_capabilities,...]
(Optional)

Specifies the measurements that will be performed on the mosaic dataset. The ability to perform vertical measurements is dependent on the imagery and may require a DEM.

  • None—No mensuration capabilities will be performed.
  • Basic—Ground measurements such as distance, point, centroid, and area calculations will be performed.
  • Base-Top Height—Measurements from the base to the top of features will be performed. Rational polynomial coefficients must be imbedded in the imagery.
  • Base-Top Shadow Height—Measurements from the base of a feature to the top of its shadow will be performed. Sun azimuth and sun elevation information is required.
  • Top-Top Shadow Height—Measurements from the top of a feature to the top of its shadow will be performed. Sun azimuth, sun elevation, and rational polynomial coefficients are required.
  • 3D—Measurements in 3D will be performed if a DEM is available.
String
default_mensuration_capabilities
(Optional)

Specifies the default mensuration capability for the mosaic dataset. The default mensuration value must be set in the list of values used for the allowed_mensuration_capabilities parameter or be set in the mosaic dataset's Mensuration Capabilities property.

  • None—No mensuration capabilities will be performed.
  • Basic— Ground measurements such as distance, point, centroid, and area calculations will be performed.
  • Base-Top Height—Measurements from the base to the top of features will be performed. Rational polynomial coefficients must be imbedded in the imagery.
  • Base-Top Shadow Height—Measurements from the base of a feature to the top of its shadow will be performed. Sun azimuth and sun elevation information is required.
  • Top-Top Shadow Height—Measurements from the top of a feature to the top of its shadow will be performed. Sun azimuth, sun elevation, and rational polynomial coefficients are required.
  • 3D—Measurements in 3D will be performed if a DEM is available.
String
allowed_mosaic_methods
[allowed_mosaic_methods,...]
(Optional)

Specifies the rules for displaying overlapping imagery.

  • None—Rasters will be ordered based on the ObjectID field in the mosaic dataset attribute table.
  • Center—Imagery that is closest to the center of the screen will be displayed.
  • NorthWest—Imagery that is closest to the northwest corner of the mosaic dataset boundary will be displayed.
  • LockRaster—Selected raster datasets will be displayed.
  • ByAttribute—Imagery will be displayed and prioritized based on a field in the attribute table.
  • Nadir—Rasters with viewing angles closest to zero will be displayed.
  • Viewpoint—Imagery that is closest to a selected viewing angle will be displayed.
  • Seamline—Transitions between images will be smoothed using seamlines.
String
default_mosaic_method
(Optional)

Specifies the default mosaic method that will be used for the mosaic dataset. The default mosaic method must be set in the list of values used for the allowed_mosaic_methods parameter or be set in the mosaic dataset's Allowed Mosaic Methods property.

  • None—Rasters will be ordered based on the ObjectID field in the mosaic dataset attribute table.
  • Center—Imagery that is closest to the center of the screen will be displayed.
  • NorthWest—Imagery that is closest to the northwest corner of the mosaic dataset boundary will be displayed.
  • LockRaster—Selected raster datasets will be displayed.
  • ByAttribute—Imagery will be displayed and prioritized based on a field in the attribute table.
  • Nadir—Rasters with viewing angles closest to zero will be displayed.
  • Viewpoint—Imagery that is closest to a selected viewing angle will be displayed.
  • Seamline—Transitions between images will be smoothed using seamlines.
String
order_field
(Optional)

The field that will be used when ordering rasters using the ByAttribute value of the default_mosaic_method parameter. The list of fields is defined as those in the attribute table that are of type metadata and are integer. This list can include, but is not limited to, the following:

  • MinPS
  • MaxPS
  • LowPS
  • HighPS
  • CenterX
  • CenterY
  • ZOrder
  • Shape_Length
  • Shape_Area

If the field is a numeric or date field, the order_base parameter must be set.

This parameter is not needed if the ByAttribute value is not in the allowed_mosaic_methods list.

String
order_base
(Optional)

Sorts the rasters based on their difference from this value in the field selected in the order_field parameter

If a Date attribute is used, it must be in one of the following formats:

  • YYYY/MM/DD HH:mm:ss.s
  • YYYY/MM/DD HH:mm:ss
  • YYYY/MM/DD HH:mm
  • YYYY/MM/DD HH
  • YYYY/MM/DD
  • YYYY/MM
  • YYYY

This parameter is required only if the ByAttribute value is specified for the allowed_mosaic_methods parameter.

String
sorting_order
(Optional)

Specifies whether the rasters will be sorted in an ascending or a descending order.

  • ASCENDING—Rasters will be sorted in an ascending order. This is the default.
  • DESCENDING—Rasters will be sorted in a descending order.

This parameter is required only if the ByAttribute value is specified for the allowed_mosaic_methods parameter.

Boolean
mosaic_operator
(Optional)

Specifies the rule that will be used for resolving overlapping pixels.

  • FIRST—The first image in the attribute table will be displayed.
  • LAST—The last image in the attribute table will be displayed.
  • MIN—The lowest pixel values will be displayed.
  • MAX—The highest pixel values will be displayed.
  • MEAN—The arithmetic mean will be used to average overlapping pixels.
  • BLEND—A distance weighted algorithm will be used to average overlapping pixels.
  • SUM—All of the overlapping pixel values will be added together.
String
blend_width
(Optional)

The number of pixels to which the BLEND value of the mosaic_operator parameter will be applied.

Long
view_point_x
(Optional)

A numeric value that will be used to horizontally shift the center of the image. The units are the same as the spatial reference system.

This parameter is only applicable if the allowed_mosaic_methods parameter is set to Viewpoint.

Double
view_point_y
(Optional)

A numeric value that will be used to vertically shift the center of the image. The units are the same as the spatial reference system.

This parameter is only applicable if the allowed_mosaic_methods parameter is set to Viewpoint.

Double
max_num_per_mosaic
(Optional)

The maximum number of raster datasets that will be displayed at a given time in a mosaic dataset.

Long
cell_size_tolerance
(Optional)

The maximum pixel size difference that is allowed before images are considered to have a different cell pixel.

This allows images of similar spatial resolutions to be considered as having the same nominal resolution. For example, with a factor of 0.1, all images with cell sizes within 10 percent of each other will be grouped for tools and operations that use cell sizes.

Double
cell_size
(Optional)

The cell size of the mosaic dataset using an existing raster dataset or its specified width (x) and height (y). If you specify the cell size, you can use a single value for a square cell size, or x and y values for a rectangular cell size.

Cell Size XY
metadata_level
(Optional)

Specifies the level of metadata that will be exposed from the server to a client when publishing the mosaic dataset.

  • FULL—Metadata regarding the processing applied at the mosaic dataset level as well as metadata related to the individual raster datasets will be exposed.
  • NONE—No metadata will be exposed to the client.
  • BASIC—Metadata related to individual raster datasets, such as the number of columns and rows, cell size, and spatial reference information, will be exposed.
String
transmission_fields
[transmission_fields,...]
(Optional)

The fields in the attribute table that clients can view. By default, the list includes the following:

  • Name
  • MinPS
  • MaxPS
  • LowPS
  • HighPS
  • Tag
  • GroupName
  • ProductName
  • CenterX
  • CenterY
  • ZOrder
  • Shape_Length
  • Shape_Area

String
use_time
(Optional)

Specifies whether the mosaic dataset will be time aware. If time is activated, the start and end fields and the time format must be specified.

  • DISABLED—The mosaic dataset will not be time aware. This is the default.
  • ENABLED—The mosaic dataset will be time aware. This allows the client to use the Time Slider.
Boolean
start_time_field
(Optional)

The field in the attribute table that shows the start time.

String
end_time_field
(Optional)

The field in the attribute table that shows the end time.

String
time_format
(Optional)

Specifies the time format that will be used for the mosaic dataset for parameters such as start_time_field and end_time_field.

  • YYYY—The time format will be year.
  • YYYYMM—The time format will be year and month.
  • YYYY/MM—The time format will be year and month.
  • YYYY-MM—The time format will be year and month.
  • YYYYMMDD—The time format will be year, month, and day.
  • YYYY/MM/DD—The time format will be year, month, and day.
  • YYYY-MM-DD—The time format will be year, month, and day.
  • YYYYMMDDhhmmss—The time format will be year, month, day, hour, minute, and seconds.
  • YYYY/MM/DD hh:mm:ss—The time format will be year, month, day, hour, minute, and seconds.
  • YYYY-MM-DD hh:mm:ss—The time format will be year, month, day, hour, minute, and seconds.
  • YYYYMMDDhhmmss.s—The time format will be year, month, day, hour, minute, seconds, and fraction of seconds.
  • YYYY/MM/DD hh:mm:ss.s—The time format will be year, month, day, hour, minute, seconds, and fraction of seconds.
  • YYYY-MM-DD hh:mm:ss.s—The time format will be year, month, day, hour, minute, seconds, and fraction of seconds.
String
geographic_transform
[geographic_transform,...]
(Optional)

The geographic transformations that will be associated with the mosaic dataset.

String
max_num_of_download_items
(Optional)

The maximum number of raster datasets that will be downloaded per request.

Long
max_num_of_records_returned
(Optional)

The maximum number of records that will be downloaded per request.

Long
data_source_type
(Optional)

Specifies the type of imagery in the mosaic dataset.

  • GENERIC—The mosaic dataset contains no specified data type.
  • THEMATIC—The mosaic dataset contains thematic data with discrete values, such as land cover.
  • PROCESSED—The mosaic dataset has been color adjusted.
  • ELEVATION—The mosaic dataset contains elevation data.
  • SCIENTIFIC—The mosaic dataset contains scientific data.
  • VECTOR_UV—The mosaic dataset has two variables.
  • VECTOR_MAGDIR—The mosaic dataset has magnitude and direction.
String
minimum_pixel_contribution
(Optional)

The minimum number of pixels required for a mosaic dataset item to be considered significant enough to be used in the mosaic dataset. Because of overlapping imagery, an item may display only a small sliver of its overall image. Skipping these mosaic dataset items will improve performance of the mosaic dataset.

Long
processing_templates
[processing_templates,...]
(Optional)

The function chains that will be used to process a mosaic dataset or the mosaic dataset items on the fly. You can add, remove, or reorder the function chains.

All the template names that are added must be unique.

File; String
default_processing_template
(Optional)

The default function chain. The default function chain will be applied when the mosaic dataset is accessed.

String
time_interval
(Optional)

The duration of each time step interval. The time step interval defines the granularity of the temporal data. The unit of time is specified in the time_interval_units parameter.

Double
time_interval_units
(Optional)

Specifies the measurement unit that will be used for the time interval.

  • None—No time unit exists or it is unknown.
  • Milliseconds—The time unit will be milliseconds.
  • Seconds—The time unit will be seconds.
  • Minutes—The time unit will be minutes.
  • Hours—The time unit will be hours.
  • Days—The time unit will be days.
  • Weeks—The time unit will be weeks.
  • Months—The time unit will be months.
  • Years—The time unit will be years.
  • Decades—The time unit will be decades.
  • Centuries—The time unit will be centuries.
String
product_definition
(Optional)

Specifies a template that is either specific to the type of imagery you are working with or generic. The generic options include the standard supported raster sensor types as follows:

  • NONE—No band ordering is specified for the mosaic dataset. This is the default.
  • NATURAL_COLOR_RGB—A 3-band mosaic dataset, with red, green, and blue wavelength ranges will be created. This is designed for natural color imagery.
  • NATURAL_COLOR_RGBI—A 4-band mosaic dataset, with red, green, blue, and near infrared wavelength ranges will be created.
  • VECTOR_FIELD_UV—A mosaic dataset displaying two variables will be created.
  • VECTOR_FIELD_MAGNITUDE_DIRECTION—A mosaic dataset displaying magnitude and direction will be created.
  • FALSE_COLOR_IRG—A 3-band mosaic dataset, with near infrared, red, and green wavelength ranges will be created.
  • BLACKSKY—A 3-band mosaic dataset using the BlackSky wavelength ranges will be created
  • DMCII_3BANDS—A 3-band mosaic dataset using the DMCii wavelength ranges will be created.
  • DEIMOS2_4BANDS—A 4-band mosaic dataset using the Deimos-2 wavelength ranges will be created.
  • DUBAISAT-2_4BANDS—A 4-band mosaic dataset using the DubaiSat-2 wavelength ranges will be created.
  • FORMOSAT-2_4BANDS—A 4-band mosaic dataset using the FORMOSAT-2 wavelength ranges will be created.
  • GEOEYE-1_4BANDS—A 4-band mosaic dataset using the GeoEye-1 wavelength ranges will be created.
  • GF-1 PMS_4BANDS—A 4-band mosaic dataset using the Gaofen-1 Panchromatic Multispectral Sensor wavelength ranges will be created.
  • GF-1 WFV_4BANDS—A 4-band mosaic dataset using the Gaofen-1 Wide Field of View Sensor wavelength ranges will be created.
  • GF-2 PMS_4BANDS—A 4-band mosaic dataset using the Gaofen-2 Panchromatic Multispectral Sensor wavelength ranges will be created.
  • GF-4 PMI_4BANDS—A 4-band mosaic dataset using the Gaofen-4 panchromatic and multispectral wavelength ranges will be created.
  • HJ 1A/1B CCD_4BANDS—A 4-band mosaic dataset using the Huan Jing-1 CCD Multispectral or Hyperspectral Sensor wavelength ranges will be created.
  • IKONOS_4BANDS—A 4-band mosaic dataset using the IKONOS wavelength ranges will be created.
  • JILIN-1_3BANDS—A 3-band mosaic dataset using the Jilin-1 wavelength ranges will be created.
  • KOMPSAT-2_4BANDS—A 4-band mosaic dataset using the KOMPSAT-2 wavelength ranges will be created.
  • KOMPSAT-3_4BANDS—A 4-band mosaic dataset using the KOMPSAT-3 wavelength ranges will be created.
  • LANDSAT_6BANDS—A 6-band mosaic dataset using the Landsat 5 and 7 wavelength ranges from the TM and ETM+ sensors will be created.
  • LANDSAT_8BANDS—An 8-band mosaic dataset using the Landsat 8 wavelength ranges will be created.
  • LANDSAT_9BANDS—An 8-band mosaic dataset using the Landsat 9 wavelength ranges will be created.
  • LANDSAT_MSS_4BANDS—A 4-band mosaic dataset using the Landsat wavelength ranges from the MSS sensor will be created.
  • PLANETSCOPE—A 5-band mosaic dataset using the PlanetScope wavelength ranges will be created.
  • PLEIADES-1_4BANDS—A 4-band mosaic dataset using the Pleiades 1 wavelength ranges will be created.
  • PLEIADES_NEO_6BANDS—A 6-band mosaic dataset using the Pleiades Neo wavelength ranges will be created.
  • QUICKBIRD_4BANDS—A 4-band mosaic dataset using the QuickBird wavelength ranges will be created.
  • RAPIDEYE_5BANDS—A 5-band mosaic dataset using the RapidEye wavelength ranges will be created.
  • SENTINEL2_13BANDS—A 13-band mosaic dataset using the Sentinel 2 MSI wavelength ranges will be created.
  • SKYSAT_4BANDS—A 4-band mosaic dataset using the SkySat-C MSI wavelength ranges will be created.
  • SPOT-5_4BANDS—A 4-band mosaic dataset using the SPOT-5 wavelength ranges will be created.
  • SPOT-6_4BANDS—A 4-band mosaic dataset using the SPOT-6 wavelength ranges will be created.
  • SPOT-7_4BANDS—A 4-band mosaic dataset using the SPOT-7 wavelength ranges will be created.
  • SUPERVIEW-1_4BANDS—A 4-band mosaic dataset using the SuperView-1 wavelength ranges will be created.
  • TH-01_4BANDS—A 4-band mosaic dataset using the Tian Hui-1 wavelength ranges will be created.
  • WORLDVIEW-2_8BANDS—An 8-band mosaic dataset using the WorldView-2 wavelength ranges will be created.
  • WORLDVIEW-3_8BANDS—An 8-band mosaic dataset using the WorldView-3 wavelength ranges will be created.
  • WORLDVIEW-4_4BANDS—A 4-band mosaic dataset using the WorldView-4 wavelength ranges will be created.
  • VISION-1_4BANDS—A 4-band mosaic dataset using the Vision-1 wavelength ranges will be created.
  • ZY1-02C PMS_3BANDS—A 3-band mosaic dataset using the ZiYuan-1 panchromatic/multispectral wavelength ranges will be created.
  • ZY3-CRESDA_4BANDS—A 4-band mosaic dataset using the ZiYuan-3 CRESDA wavelength ranges will be created.
  • ZY3-SASMAC_4BANDS—A 4-band mosaic dataset using the ZiYuan-3 SASMAC wavelength ranges will be created.
  • CUSTOM—The number of bands and the average wavelength for each band are defined using the Product Band Definitions parameter (product_band_definitions in Python).
String
product_band_definitions
[Band Name {Wavelength Minimum} {Wavelength Maximum},...]
(Optional)

The wavelength ranges, number of bands, and band order definitions. You can edit the product_definition values and add new bands using the CUSTOM product definition.

Value Table

Derived Output

NameExplanationData Type
out_mosaic_dataset

The updated mosaic dataset.

Mosaic Layer

Code sample

SetMosaicDatasetProperties example 1 (Python window)

This is a Python sample for the SetMosaicDatasetProperties function.

import arcpy
arcpy.SetMosaicDatasetProperties_management(
    "c:/workspace/mdproperties.gdb/md", cell_size="0.2", metadata_level="BASIC", 
    transmission_fields="NAME;MINPS;MAXPS;GROUPNAME;PRODUCTNAME;ZORDER;YEARS;YEARE", 
    use_time="ENABLED", start_time_field="YEARS", end_time_field="YEARE", 
    time_format="YYYYMM", geographic_transform=
    "NAD_1983_HARN_To_WGS_1984_2", max_num_of_download_items="10", 
    max_num_of_records_returned="500", source_type="GENERIC", 
    minimum_pixel_contribution="50", processing_templates="None;C:/Test/NewRFTs/Aspect.rft.xml", 
    default_processing_template="None")
SetMosaicDatasetProperties example 2 (stand-alone script)

This is a Python script sample for the SetMosaicDatasetProperties function.

#Set mosaic dataset imagery properties group

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

arcpy.SetMosaicDatasetProperties_management(
    "mdproperties.gdb/md", "525340", "3909809", "None;JPEG", "JPEG",
    "85", "0.5", "CUBIC", "CLIP", "FOOTPRINTS_MAY_CONTAIN_NODATA",
    "NOT_CLIP", "APPLY", "Base-Top Height;Top-Top Shadow Height",
    "Base-Top Height")

Environments

This tool does not use any geoprocessing environments.

Feedback on this topic?

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