Summary
The Describe function returns the following properties for Mosaic Datasets. Raster Dataset properties and Dataset properties are also supported. Editor Tracking Properties are supported if editor tracking has been enabled for this mosaic dataset.
A Mosaic Dataset returns a dataType of "MosaicDataset".
Properties
Property | Explanation | Data Type |
allowedCompressionMethods (Read Only) | The methods of compression that can be used to transmit the mosaicked image from the server to the client. This property influences an image service generated from the mosaic dataset.
| String |
allowedFields (Read Only) | The attribute table fields that are visible to the client when the mosaic dataset is served as an image service. | String |
allowedMensurationCapabilities (Read Only) | The mensuration tools that can be used with an image service.
| String |
allowedMosaicMethods (Read Only) | Specifies the order of the rasters mosaicked together to render the mosaicked display.
| String |
applyColorCorrection (Read Only) | If color correction information is available in the mosaic dataset, a value of True means it will be applied. | Boolean |
blendWidth (Read Only) | The distance used by the Blend mosaic operator. | Double |
blendWidthUnits (Read Only) | Specifies the blend width units.
| String |
cellSizeToleranceFactor (Read Only) | The way mosaic dataset items with different pixel sizes are grouped together for some operations, such as mosaicking or seamline generation. | Double |
childrenNames (Read Only) | A list of side-table names that are components of the mosaic dataset. | String |
clipToBoundary (Read Only) | True means the image extent is limited to the geometry of the boundary. False means it is limited to the extent of the boundary. | Boolean |
clipToFootprint (Read Only) | Specifies whether the extent of each raster is limited to its footprint. | Boolean |
defaultCompressionMethod (Read Only) | The default compression method for the image. This value comes from the list of methods returned by the allowedCompressionMethods property. | String |
defaultMensurationCapability (Read Only) | The default mensuration tool that will be used with an image service. This value comes from the list returned by the allowedMensurationCapabilities property. | String |
defaultMosaicMethod (Read Only) | The default mosaic method for the mosaicked image. This value comes from the list returned by the allowedMosaicMethods property. | String |
defaultProcessingTemplate (Read Only) | Returns the name of the current default processing template. | String |
defaultResamplingMethod (Read Only) | Specifies the default sampling method of the pixels.
| String |
dimensionAttributes (Read Only) | Returns a list of variables, its dimension names, and the attributes of every dimension separated by a pipe (|). Dimension attributes include Description, Unit, Count, Minimum, Maximum, Interval, IntervalUnits, HasRegularIntervals, and HasRanges. The format of the returned string is <variable1>|<dimension2>|Description:<description>;Unit:<unit>;Count:<number of dimension values>;Minimum:<min dimension value>;Maximum:<max dimension value>;Interval:<interval>; IntervalUnit:<interval unit>;HasRegularIntervals:<boolean>; HasRanges:<boolean>, <variable1>|<dimension2>|Description:<description>; ... .. | String |
dimensionNames (Read Only) | Returns a list of dimension names associated with every variable in a multidimensional mosaic dataset. The variable name and the dimension name are separated by a pipe (|), and each variable and dimension pair is separated by a comma. The format of the returned string is <variable_name1>|<dimension_name2>, <variable_name2>| dimension_name2>. | String |
dimensionValues (Read Only) | Returns the values for each dimension associated with every variable:
The format of the returned string is <variable1>|<dimension1>|<minDimValue>-<maxDimValue>;<minDimValue>-<maxDimValue>;<minDimValue>-<maxDimValue>;<minDimValue>-<maxDimValue>, <variable1>|<dimension2>|<minDimValue>-<maxDimValue>; ... .. | String |
endTimeField (Read Only) | The field that defines the end time. | String |
footprintMayContainNoData (Read Only) | True if NoData is a valid pixel value. | Boolean |
GCSTransforms (Read Only) | The transformations applied if the spatial references of the source rasters differ from the spatial reference of the mosaic dataset. | String |
isMultidimensional (Read Only) | True if the mosaic dataset has associated multidimensional information. | Boolean |
JPEGQuality (Read Only) | The percentage of image quality retained if JPEG compression is used on this dataset. | Long |
LERCTolerance (Read Only) | The maximum error value applied per pixel if the mosaic dataset uses LERC compression. | Double |
maxDownloadImageCount (Read Only) | The maximum number of rasters that a client can download from an image service. | Long |
maxDownloadSizeLimit (Read Only) | The maximum size, in megabytes, of rasters that a client can download from an image service. | Long |
maxRastersPerMosaic (Read Only) | The maximum number of rasters mosaicked. This property affects an image service generated from the mosaic dataset. | Long |
maxRecordsReturned (Read Only) | The maximum number of records returned by the server when viewing the mosaic dataset as a published image service. | Long |
maxRequestSizeX (Read Only) | The maximum number of columns returned, each time a mosaicked image is generated. | Long |
maxRequestSizeY (Read Only) | The maximum number of rows returned, each time a mosaicked image is generated. | Long |
minimumPixelContribution (Read Only) | The minimum number of pixels needed within the area of interest for a mosaic dataset item to be considered as part of that area. | Long |
mosaicOperator (Read Only) | Specifies the default method for resolving overlapping cells.
| String |
multidimensionalInfo (Read Only) | Returns a JSON object representing the multidimensional information of a mosaic dataset. For more information about the JSON syntax of the object, see REST API Multidimensional Info. | String |
orderBaseValue (Read Only) | The images are sorted based on the difference between this value and the value specified in the orderField property. This is applicable only for the By Attribute mosaic method. | Double |
orderField (Read Only) | The metadata attribute used for raster ordering. This is applicable only for the By Attribute mosaic method. | String |
processingTemplates (Read Only) | Returns a list of processing template names associated with the mosaic dataset. | String |
rasterMetadataLevel (Read Only) | Specifies the metadata that will be transmitted from the server to the client.
| String |
referenced (Read Only) | True if it is a referenced mosaic dataset; False if it is a regular mosaic dataset. | Boolean |
sortAscending (Read Only) | Specifies the default ordering of the images defined by the mosaic methods.
| String |
startTimeField (Read Only) | The field that defines the start time. | String |
timeValueFormat (Read Only) | The format in which the start time and end times are specified. | String |
useTime (Read Only) | True if the mosaic dataset is time aware. | Boolean |
variableAttributes (Read Only) | Returns a list of variables and their attributes. The name of the variable and its attributes are separated by a pipe (|). Each variable and its attributes are separated by a comma. The attributes of a variable are Description and Unit. The format of the returned string is <variable_name1>|Unit:<units>;Description:<Description>, <variable_name2>|Unit:<units>;Description:<Description>. | String |
variableNames (Read Only) | Returns a list of variable names associated with the multidimensional raster. The format of the returned string is <variable_name1>, <variable_name2>, ..., <variable_nameX>. | String |
viewpointSpacingX (Read Only) | The horizontal offset used to calculate where the center of the area of interest (display view) is when you click an arrow button on the Viewpoint dialog box. These values are calculated in the units of the spatial reference system of the mosaic dataset. This is applicable only for the Closest to Viewpoint mosaic method. | Double |
viewpointSpacingY (Read Only) | The vertical offset used to calculate where the center of the area of interest (display view) is when you click an arrow button on the Viewpoint dialog box. These values are calculated in the units of the spatial reference system of the mosaic dataset. This is applicable only for the Closest to Viewpoint mosaic method. | Double |