Skip to main content

Mosaic Dataset properties

Resumen

The Describe function returns the following properties for mosaic datasets. The Raster Dataset and Dataset property groups are also supported. The Editor Tracking property group is supported if editor tracking has been enabled for this mosaic dataset.

For a mosaic dataset, the Describe dataType property returns a value of "MosaicDataset".

Propiedades

Propiedad Explicación Tipo de datos

allowedCompressionMethods

(Solo lectura)

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.

  • None—No compression

  • LZ77—LZ77 compression

  • JPEG—JPEG compression

  • LERC—LERC compression

String

allowedFields

(Solo lectura)

The attribute table fields that are visible to the client when the mosaic dataset is served as an image service.

String

allowedMensurationCapabilities

(Solo lectura)

The mensuration tools that can be used with an image service.

  • None—No mensuration tools can be used.

  • Basic—The Distance, Area, Point Location, and Centroid Location mensuration tools can be used.

  • Base-Top Height—The height of a structure is calculated by measuring from the base of the structure to the top of the structure.

  • Top-Top Shadow Height—The height of a structure is calculated by measuring from the top of the structure to the top of the structure's shadow on the ground.

  • Base-Top Shadow Height—The height of a structure is calculated by measuring from the base of the structure to the top of the structure's shadow on the ground.

  • 3D—Used to determine the heights of your 3D features, such as buildings, when a DEM is available.

String

allowedMosaicMethods

(Solo lectura)

Specifies the order of the rasters mosaicked together to render the mosaicked display.

  • None—Orders rasters based on the order (ObjectID) in the mosaic dataset attribute table.

  • Closest to Center—Enables rasters to be sorted based on a default order in which rasters that have their centers closest to the view center are placed on top.

  • Closest to Nadir—Enables rasters to be sorted by the distance between the nadir position and view center. This is similar to the Closest to Center method but uses the nadir point to a raster, which may be different than the center, especially for oblique imagery.

  • Closest to Viewpoint—Orders rasters based on a user-defined location and nadir location for the rasters using the Viewpoint tool.

  • By Attribute—Enables raster ordering based on a defined metadata attribute and its difference from a base value.

  • North-West—Enables raster ordering in a view-independent way in which rasters with their centers to the northwest appear on top.

  • Seamline—Cuts the raster using the predefined seamline shape for each raster using optional feathering along the seams and orders images based on the SOrder field in the attribute table.

  • Lock Raster—Allows a user to lock the display of single or multiple rasters based on the ObjectID.

String

applyColorCorrection

(Solo lectura)

If color correction information is available in the mosaic dataset, a value of True means it will be applied.

Boolean

blendWidth

(Solo lectura)

The distance used by the Blend mosaic operator.

Double

blendWidthUnits

(Solo lectura)

Specifies the blend width units.

  • Pixels—The blend width is measured in pixels.

  • Mosaic Dataset Unit—The unit for the blend width will be in the same unit as the mosaic dataset.

String

cellSizeToleranceFactor

(Solo lectura)

The way mosaic dataset items with different pixel sizes are grouped together for some operations, such as mosaicking or seamline generation.

Double

childrenNames

(Solo lectura)

A list of side-table names that are components of the mosaic dataset.

String

clipToBoundary

(Solo lectura)

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

(Solo lectura)

Specifies whether the extent of each raster is limited to its footprint.

Boolean

ConnectionFiles

(Solo lectura)

The paths to Cloud Storage Connection (.acs) files, if any of the mosaic dataset items were added from an .acs file.

String

defaultCompressionMethod

(Solo lectura)

The default compression method for the image. This value comes from the list of methods returned by the allowedCompressionMethods property.

String

defaultMensurationCapability

(Solo lectura)

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

(Solo lectura)

The default mosaic method for the mosaicked image. This value comes from the list returned by the allowedMosaicMethods property.

String

defaultProcessingTemplate

(Solo lectura)

Returns the name of the current default processing template.

String

defaultResamplingMethod

(Solo lectura)

Specifies the default sampling method of the pixels.

  • NEAREST—The nearest neighbor resampling method will be used.

  • BILINEAR—The bilinear interpolation resampling method will be used.

  • CUBIC—The cubic convolution resampling method will be used.

  • MAJORITY—The majority resampling method will be used.

String

dimensionAttributes

(Solo lectura)

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

(Solo lectura)

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

(Solo lectura)

Returns the values for each dimension associated with every variable:

  • The variable name, dimension name, and dimension values are separated by a pipe (|).

  • Each <variable>|dimension|dimensionValue tuple is separated by a comma.

  • The minimum and maximum values of the dimensions are separated by a dash.

  • The dimension values are separated by a semicolon.

The format of the returned string is <variable1>|<dimension1>|<minDimValue>-<maxDimValue>;<minDimValue>-<maxDimValue>;<minDimValue>-<maxDimValue>;<minDimValue>-<maxDimValue>, <variable1>|<dimension2>|<minDimValue>-<maxDimValue>; ... ..

String

endTimeField

(Solo lectura)

The field that defines the end time.

String

footprintMayContainNoData

(Solo lectura)

True if NoData is a valid pixel value.

Boolean

GCSTransforms

(Solo lectura)

The transformations applied if the spatial references of the source rasters differ from the spatial reference of the mosaic dataset.

String

isMultidimensional

(Solo lectura)

True if the mosaic dataset has associated multidimensional information.

Boolean

JPEGQuality

(Solo lectura)

The percentage of image quality retained if JPEG compression is used on this dataset.

Long

LERCTolerance

(Solo lectura)

The maximum error value applied per pixel if the mosaic dataset uses LERC compression.

Double

maxDownloadImageCount

(Solo lectura)

The maximum number of rasters that a client can download from an image service.

Long

maxDownloadSizeLimit

(Solo lectura)

The maximum size, in megabytes, of rasters that a client can download from an image service.

Long

maxRastersPerMosaic

(Solo lectura)

The maximum number of rasters mosaicked. This property affects an image service generated from the mosaic dataset.

Long

maxRecordsReturned

(Solo lectura)

The maximum number of records returned by the server when viewing the mosaic dataset as a published image service.

Long

maxRequestSizeX

(Solo lectura)

The maximum number of columns returned each time a mosaicked image is generated.

Long

maxRequestSizeY

(Solo lectura)

The maximum number of rows returned each time a mosaicked image is generated.

Long

minimumPixelContribution

(Solo lectura)

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

(Solo lectura)

Specifies the default method for resolving overlapping cells.

  • FIRST—The output cell value of the overlapping areas will be the value from the first raster dataset mosaicked into that location.

  • LAST—The output cell value of the overlapping areas will be the value from the last raster dataset mosaicked into that location. This is the default.

  • BLEND—The output cell value of the overlapping areas will be a horizontally weighted calculation of the values of the cells in the overlapping area.

  • MEAN—The output cell value of the overlapping areas will be the average value of the overlapping cells.

  • MINIMUM—The output cell value of the overlapping areas will be the minimum value of the overlapping cells.

  • MAXIMUM—The output cell value of the overlapping areas will be the maximum value of the overlapping cells.

  • SUM—The output cell value of the overlapping areas will be the total sum of the overlapping cells.

String

multidimensionalInfo

(Solo lectura)

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

(Solo lectura)

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. If the orderBaseValue is a time-related value, the time string is returned in the following format: YYYY/DD/MM HH:MM:SS.

Double

orderField

(Solo lectura)

The metadata attribute used for raster ordering. This is applicable only for the By Attribute mosaic method.

String

processingTemplates

(Solo lectura)

Returns a list of processing template names associated with the mosaic dataset.

String

rasterMetadataLevel

(Solo lectura)

Specifies the metadata that will be transmitted from the server to the client.

  • None—No metadata will be transmitted.

  • Full—The basic raster dataset information and the function chain's details will be transmitted.

  • Basic—The raster dataset level of information, such as the columns and rows, cell size, and spatial reference information, will be transmitted.

String

referenced

(Solo lectura)

True if it is a referenced mosaic dataset; False if it is a regular mosaic dataset.

Boolean

sortAscending

(Solo lectura)

Specifies the default ordering of the images defined by the mosaic methods.

  • ASCENDING—Rasters will be sorted in ascending order.

  • DESCENDING—Rasters will be sorted in descending order.

String

startTimeField

(Solo lectura)

The field that defines the start time.

String

timeValueFormat

(Solo lectura)

The format in which the start time and end time values are specified.

String

useTime

(Solo lectura)

True if the mosaic dataset is time aware.

Boolean

variableAttributes

(Solo lectura)

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

(Solo lectura)

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

(Solo lectura)

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

(Solo lectura)

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