Summary
Defines the defaults for displaying a mosaic dataset and serving it as an image service.
Usage
The current mosaic dataset properties can be found in under the Defaults tab of the Mosaic Dataset Properties.
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 whose properties need to 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 your server has to do when clients see your 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, and 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 your server has to do when clients see your 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, and the image may not display. | Long |
allowed_compressions [allowed_compressions,...] (Optional) | Define the method of compression for transmitting the mosaicked image from the computer to the display (or from the server to the client).
| String |
default_compression_type (Optional) | Set the default compression type. The default compression must be in the allowed_compressions list or already 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) | Limits the 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) | Determines how pixel values will be calculated when the dataset is displayed at small scales. Choose an appropriate technique based on the type of data you have.
| String |
clip_to_footprints (Optional) | Often the raster dataset and its footprint have the same extent. If they differ, you can clip the raster dataset to the footprint.
| Boolean |
footprints_may_contain_nodata (Optional) | Allow for pixels that have NoData values.
| Boolean |
clip_to_boundary (Optional) | Often the mosaic dataset and its boundary have the same extent. If they differ, you can clip the mosaic dataset to the boundary.
| Boolean |
color_correction (Optional) | Enable color correction on the mosaic dataset.
| Boolean |
allowed_mensuration_capabilities [allowed_mensuration_capability,...] (Optional) | Choose which measurements your viewers can perform on the mosaic dataset. The ability to perform vertical measurements is dependent on your imagery and may require a DEM.
| String |
default_mensuration_capabilities (Optional) | Choose the default mensuration capability for this mosaic dataset. The default must be set in the allowed_mensuration_capabilities parameter list or already set in the mosaic dataset's Mensuration Capabilities property.
| String |
allowed_mosaic_methods [allowed_mosaic_method,...] (Optional) | Define the rules for displaying overlapping imagery.
| String |
default_mosaic_method (Optional) | Choose the default mosaic method for this mosaic dataset. The default must be set in the allowed_mosaic_methods parameter list or already set in the mosaic dataset's Allowed Mosaic Methods property.
| String |
order_field (Optional) | Choose the default field to use when ordering rasters using the ByAttribute mosaic method. 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:
If your field is a numeric or date field, then the order_base parameter needs to be set. This parameter is not needed if ByAttribute is not an allowed mosaic method. | String |
order_base (Optional) | Sort the rasters based on their difference from this value in the field selected in the order_field parameter If you are using a Date attribute, then it needs to be in one of the following formats:
This parameter needs to be specified only if ByAttribute is specified for the allowed_mosaic_method parameter. | String |
sorting_order (Optional) | Choose whether to sort your rasters in an ascending or descending order.
This parameter needs to be specified only if ByAttribute is specified for the allowed_mosaic_method parameter. | Boolean |
mosaic_operator (Optional) | Define rules for resolving overlapping pixels.
| String |
blend_width (Optional) | Set the number of pixels over which to apply the BLEND mosaic_operator. | Long |
view_point_x (Optional) | When using the viewpoint mosaic method, you can horizontally shift the center of the image using this parameter. The units are the same as the spatial reference system. | Double |
view_point_y (Optional) | When using the viewpoint mosaic method, you can vertically shift the center of the image using this parameter. The units are the same as the spatial reference system. | Double |
max_num_per_mosaic (Optional) | Set the maximum number of raster datasets that can be displayed at a given time in a mosaic dataset. | Long |
cell_size_tolerance (Optional) | Consider images of similar spatial resolutions 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 together for tools and operations that use cell sizes. | Double |
cell_size (Optional) | Set the cell size of the mosaic dataset using an existing raster dataset or specify its 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) | Set the level of metadata to expose from the server to a client when publishing the mosaic dataset.
| String |
transmission_fields [transmission_field,...] (Optional) | Limit the fields in the attribute table that clients can view. By default, the list includes:
| String |
use_time (Optional) | Enable animation through time on the mosaic dataset. If time is activated, you need to specify the start and end fields, and the time format.
| Boolean |
start_time_field (Optional) | The field from the attribute table that shows the start time. | String |
end_time_field (Optional) | The field from the attribute table that shows the end time. | String |
time_format (Optional) | Select the format that represents time in the fields chosen above.
| String |
geographic_transform [geographic_transform,...] (Optional) | The geographic transformations to associate with this mosaic dataset. | String |
max_num_of_download_items (Optional) |
Limit the number of raster datasets that can be downloaded per request. | Long |
max_num_of_records_returned (Optional) | Limit the number of records that can be downloaded per request. | Long |
data_source_type (Optional) | Define the type of imagery in the mosaic dataset.
| String |
minimum_pixel_contribution (Optional) |
Set 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, you may have an item that is displaying a small sliver of its overall image. Skipping these mosaic dataset items will help the performance of the mosaic dataset. | Long |
processing_templates [processing_templates,...] (Optional) | Choose the function chains that you want to use 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 need to be unique. For information on how to work with function chains, refer to Raster function template. | File; String |
default_processing_template (Optional) | Define the default function chain. The default function chain will be applied when the mosaic dataset is accessed. | String |
time_interval (Optional) | Specify the duration that represents 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) | Choose the appropriate units for your time interval.
| String |
product_definition (Optional) | Select a template that is either specific to the type of imagery you are working with or is generic. The generic options include the standard supported raster sensor types as follows:
| String |
product_band_definitions [Band Name {Wavelength Minimum} {Wavelength Maximum},...] (Optional) | Edit the product_definition by adjusting the wavelength ranges, changing the number of bands or the band order, and adding new bands when using the CUSTOM product definition. | Value Table |
Derived Output
Name | Explanation | Data Type |
out_mosaic_dataset | The updated mosaic dataset. | Mosaic Layer |
Code sample
This is a Python sample for the SetMosaicDatasetProperties tool.
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")
This is a Python script sample for the SetMosaicDatasetProperties tool.
#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
Licensing information
- Basic: No
- Standard: Yes
- Advanced: Yes