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.
Syntax
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})| Parameter | Explanation | Data 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 also increase the amount of time to process the mosaic dataset. It is possible to set the value too small, in which case 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 also increase the amount of time to process the mosaic dataset. It is possible to set the value too small, in which case 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).
| 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.
| 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.
| 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.
| Boolean |
footprints_may_contain_nodata (Optional) | Specifies whether pixels with NoData values will be shown.
| 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.
| Boolean |
color_correction (Optional) | Specifies whether color correction will be used on the mosaic dataset.
| 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.
| 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.
| String |
allowed_mosaic_methods [allowed_mosaic_methods,...] (Optional) | Specifies the rules for displaying overlapping imagery.
| 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.
| 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:
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:
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.
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.
| 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.
| String |
transmission_fields [transmission_fields,...] (Optional) | The fields in the attribute table that clients can view. By default, the list includes the following:
| 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.
| 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 for the mosaic dataset for parameters such as start_time_field and end_time_field.
| String |
geographic_transform [geographic_transform,...] (Optional) | The geographic transformations to associate with the mosaic dataset. | String |
max_num_of_download_items (Optional) |
The maximum number of raster datasets that can be downloaded per request. | Long |
max_num_of_records_returned (Optional) | The maximum number of records that can be downloaded per request. | Long |
data_source_type (Optional) | Specifies the type of imagery in the mosaic dataset.
| 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. For information on how to work with function chains, see Editing function chain templates. | 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.
| 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: | String |
product_band_definitions [Band Name {Wavelength Minimum} {Wavelength Maximum},...] (Optional) | The wavelength ranges, number of bands, and band order definitions. Edit the product_definition values and add new bands using the CUSTOM product definition. | Value Table |
Derived Output
| Name | Explanation | Data 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.
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes