{"id":6134,"date":"2023-01-01T15:55:30","date_gmt":"2023-01-01T12:25:30","guid":{"rendered":"https:\/\/en.geobox.ir\/developers\/?post_type=docs&p=6134"},"modified":"2023-01-26T13:45:26","modified_gmt":"2023-01-26T10:15:26","slug":"working-with-mosaic","status":"publish","type":"docs","link":"https:\/\/en.geobox.ir\/developers\/docs\/mosaic\/working-with-mosaic\/","title":{"rendered":"Raster mosaic layers"},"content":{"rendered":"

Methods:<\/h2>\n

createMosaic(options)<\/h3>\n

Creates new raster mosaic layer. This function is an asynchronous function.<\/p>\n

Parameters:<\/strong><\/p>\n

options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.name<\/div>\n
String<\/div>\n<\/td>\n
Name of new mosaic.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
Display name of new mosaic. This parameter is helpful in identifying mosaic easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
Description of mosaic.<\/td>\n<\/tr>\n
\n
options.pixel_selection<\/div>\n
String<\/div>\n<\/td>\n
How to select pixel values in overlapping regions.<\/p>\n

Chioces are: ‘FirstMethod’ | ‘LowestMethod’ | ‘HighestMethod’ | ‘MeanMethod’ | ‘MedainMethod’ | ‘StdevMethod’ | ‘LastBandHigh’ | ‘LastBandLow’<\/td>\n<\/tr>\n

\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to create mosaic layer for a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Returns:<\/strong><\/p>\n

Mosaic layer<\/a>: Returns itself to allow for method chaining.<\/p>\n

Example:<\/strong><\/p>\n

const newMosaicLayer = await Server.createMosaic({\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'pixel_selection': 'FirstMethod',\r\n   'user_id': 0\r\n});<\/pre>\n
updateMosaic(mosaic_uuid, options)<\/h3>\n
Updates the existing mosaic layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.name<\/div>\n
String<\/div>\n<\/td>\n
New name of mosaic.<\/td>\n<\/tr>\n
\n
options.display_name<\/div>\n
String?<\/div>\n<\/td>\n
New display name of mosaic. This parameter is helpful in identifying mosaic easily.<\/td>\n<\/tr>\n
\n
options.description<\/code><\/div>\n
String?<\/div>\n<\/td>\n
New description of mosaic.<\/td>\n<\/tr>\n
\n
options.pixel_selection<\/div>\n
String<\/div>\n<\/td>\n
How to select pixel values in overlapping regions.<\/p>\n
Chioces are: ‘FirstMethod’ | ‘LowestMethod’ | ‘HighestMethod’ | ‘MeanMethod’ | ‘MedainMethod’ | ‘StdevMethod’ | ‘LastBandHigh’ | ‘LastBandLow’<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Mosaic layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayer = await Server.updateMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'name': 'string',\r\n   'display_name': 'string',\r\n   'description': 'string',\r\n   'pixel_selection': 'FirstMethod'\r\n});<\/pre>\n
getMosaic(mosaic_uuid)<\/h3>\n
Returns the desired existing mosaic layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Mosaic layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayer = await Server.getMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getMosaicsByIds(options)<\/h3>\n
Returns the desired existing mosaic layers. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.ids<\/div>\n
Number | Array<\/div>\n<\/td>\n
Ids of mosaic layers. If you want a single mosaic layer, insert id as a string.<\/td>\n<\/tr>\n
\n
options.user_id<\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch mosaic layers of a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of mosaic layers.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayers = await Server.getMosaicsByIds({\r\n   'ids': [25,125],\r\n   'user_id' :0\r\n});<\/pre>\n
getMosaicByName(name, user_id)<\/h3>\n
Returns the desired existing mosaic layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
name is the available mosaic name.<\/p>\n
user_id is the id of the user that mosaic belongs to.<\/p>\n
Returns:<\/strong><\/p>\n
Mosaic layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayer = await Server.getMosaicByName('city',2);<\/pre>\n
getMosaics(options)<\/h3>\n
Returns the desired existing mosaic layers. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.f<\/span><\/div>\n
String<\/div>\n
defult: ‘json’<\/div>\n<\/td>\n
Output format. Choices are: \u2018json\u2019 | \u2018html\u2019<\/td>\n<\/tr>\n
\n
options.q<\/span><\/div>\n
String?<\/div>\n<\/td>\n
Query filter based on OGC CQL standard<\/a>.
\ne.g. “field1 LIKE ‘%GIS%’ AND created_at > ‘2021-01-01′”<\/td>\n<\/tr>\n
\n
\n
options.search<\/span><\/div>\n
String?<\/div>\n<\/div>\n<\/td>\n
Search term for keyword-based searching among search_fields or all textual fields if search_fields does not have value.
\nNOTE: if q param is defined this param will be ignored.<\/td>\n<\/tr>\n
\n
options.search_fields<\/div>\n
String?<\/div>\n<\/td>\n
Comma separated list of fields for searching<\/td>\n<\/tr>\n
\n
options.order_by<\/span><\/div>\n
String?<\/div>\n<\/td>\n
Comma seperated list of fields for sorting results [field1 A|D, field2 A|D, \u2026]. e.g. name A, type D
\nNOTE: “A” denotes ascending order and “D” denotes descending order.<\/td>\n<\/tr>\n
\n
options.skip<\/span><\/div>\n
\n
Number?<\/div>\n
Default: 0<\/div>\n<\/div>\n<\/td>\n
Number of skipped mosaic layers.<\/td>\n<\/tr>\n
\n
\n
options.limit<\/span><\/div>\n
\n
Number?<\/div>\n
Default:10<\/div>\n<\/div>\n<\/div>\n<\/td>\n
Maximum number for result mosaic layers.<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to fetch mosaic layers of a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n
\n
options.shared<\/span><\/div>\n
Bolean<\/div>\n
default: false<\/div>\n<\/td>\n
If true, returns only the mosaics that are shared.<\/td>\n<\/tr>\n
\n
options.page<\/span><\/div>\n
Number?<\/div>\n
Default:1<\/div>\n<\/td>\n
The minimum number of pages is 1.<\/td>\n<\/tr>\n
\n
options.page_size<\/span><\/div>\n
\n
Number?<\/div>\n
Default:10<\/div>\n<\/div>\n<\/td>\n
The minimum number of maps on each page is 1.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Array: Returns an array of mosaic layers.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayers = await Server.getMosaics({q:`name = 'string'`,user_id :0});<\/pre>\n
getMosaicRasters(mosaic_uuid)<\/h3>\n
Returns the raster layers which compose the mosaic layer. This function is an asynchronous function.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array that contains constitutive raster layers.<\/p>\n
Example:<\/strong><\/p>\n
const rasterLayers = await Server.getMosaicRasters('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
getMosaicPoint(mosaic_uuid, latitude, longitude)<\/h3>\n
Returns the desired existing mosaic layer information in a point (in a pixel).<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
latitude and longitude are geographic coordinates of the point.<\/p>\n
Returns:<\/strong><\/p>\n
Array: Returns an array that contains pixel information.<\/p>\n
Example:<\/strong><\/p>\n
const pixelInfo = await Server.getMosaicPoint('4f9f3e4b-4dc1-469b-83ab-00ae00f02581', 45, 32);<\/pre>\n
getMosaicSettings(mosaic_uuid)<\/h3>\n
Returns the mosaic layer settings.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains mosaic layer settings.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerSettings = await Server.getMosaicSettings('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
setMosaicSettings(mosaic_uuid, options )<\/h3>\n
Updates the mosaic layer settings.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.visual_settings<\/div>\n
Object<\/div>\n<\/td>\n
An object contains visualization settings. See raster visualization<\/a>\u00a0for more guidance. e.g.:<\/p>\n
{\r\n      'nodata': null,\r\n      'indexes': [1],\r\n      'rescale': [[0,255]],\r\n      'colormap_name': null,\r\n      'colormap': null,\r\n      'color_formula': null,\r\n      'expression': null,\r\n      'exaggeration': 10\r\n}<\/pre>\n<\/td>\n<\/tr>\n
\n
options.tile_settings<\/div>\n
Object<\/div>\n<\/td>\n
An object contains tiles settings. See raster visualization<\/a>\u00a0for more guidance. e.g.:<\/p>\n
{\r\n      'min_zoom': 0,\r\n      'max_zoom': 22,\r\n      'use_cache': true,\r\n      'cache_until_zoom': 17\r\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains mosaic settings.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerSettings = await Server.setMosaicSettings('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'visual_settings': {\r\n      'nodata': null,\r\n      'indexes': [1],\r\n      'rescale': [[0,255]],\r\n      'colormap_name': null,\r\n      'colormap': null,\r\n      'color_formula': null,\r\n      'expression': null,\r\n      'exaggeration': 10\r\n   },\r\n   'tile_settings': {\r\n      'min_zoom': 0,\r\n      'max_zoom': 22,\r\n      'use_cache': true,\r\n      'cache_until_zoom': 17\r\n   }\r\n});<\/pre>\n
getMosaicTilejson(mosaic_uuid)<\/h3>\n
Returns mosaic layer tile information such as tile access address.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Object: Returns an object that contains mosaic layer tiles information.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayerTilejson = await Server.getMosaicTilejson('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
addRasterToMosaic(mosaic_uuid, options)<\/h3>\n
Adds raster layers to the desired existing mosaic layer.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.ids<\/div>\n
Array<\/div>\n<\/td>\n
Array of ids of raster layers.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Mosaic layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayer = await Server.addRasterToMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{ids:[1,10]});<\/pre>\n
removeRasterFromMosaic(mosaic_uuid, options)<\/h3>\n
Removes raster layers from the desired existing mosaic layer.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.ids<\/div>\n
Array<\/div>\n<\/td>\n
Array of Ids of raster layers.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Mosaic layer<\/a>: Returns itself to allow for method chaining.<\/p>\n
Example:<\/strong><\/p>\n
const mosaicLayer = await Server.removeRasterFromMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{ids:[1,10]});<\/pre>\n
deleteMosaic(mosaic_uuid)<\/h3>\n
Deletes the existing mosaic layer.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows deleting was successful or not. Null message means deleting was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await Server.deleteMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
seedCacheMosaic(mosaic_uuid, options)<\/h3>\n
Generates and stores tiles for the existing mosaic layer. See generating and storing tiles<\/a>\u00a0for more guidance.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
options (Object)<\/p>\n\n\n\n\n\n\n\n\n\n
Name<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
\n
options.from_zoom<\/div>\n
Number<\/div>\n<\/td>\n
from_zoom parameter is between 0 and 22.<\/td>\n<\/tr>\n
\n
options.to_zoom<\/div>\n
Number<\/div>\n<\/td>\n
to_zoom parameter is between 0 and 22.<\/td>\n<\/tr>\n
\n
\n
options.extent<\/span><\/div>\n
Array<\/div>\n<\/div>\n<\/td>\n
[southwest x, southwest y,\u00a0 northeast x, northeast y]<\/span><\/td>\n<\/tr>\n
\n
options.workers<\/div>\n
Number<\/div>\n<\/td>\n
Number of cpu cores.<\/td>\n<\/tr>\n
\n
options.user_id<\/span><\/div>\n
Number?<\/div>\n<\/td>\n
If the admin wants to build cache for a mosaic layer of a certain user, this parameter determines which user is the target user.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Returns:<\/strong><\/p>\n
Object: Returns task id to manage task.<\/p>\n
Example:<\/strong><\/p>\n
const taskId = await Server.seedCacheMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581',{\r\n   'from_zoom': 0,\r\n   'to_zoom': 2,\r\n   'extent': [51, 35, 52, 36],\r\n   'workers': 1,\r\n   'user_id': 2\r\n})<\/pre>\n
getCacheSizeMosaic(mosaic_uuid)<\/h3>\n
Returns the size of tiles generated and stored for mosaic layer in bytes.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
Number: Returns tiles size in byte.<\/p>\n
Example:<\/strong><\/p>\n
const tilesSize = await Server.getCacheSizeMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n
clearCacheMosaic(mosaic_uuid)<\/h3>\n
Removes generated tiles for the desired mosaic layer.<\/p>\n
Parameters:<\/strong><\/p>\n
mosaic_uuid is the available mosaic layer uuid.<\/p>\n
Returns:<\/strong><\/p>\n
String: Returns a message that shows clearing was successful or not. Null message means clearing was successful.<\/p>\n
Example:<\/strong><\/p>\n
const result = await Server.clearCacheMosaic('4f9f3e4b-4dc1-469b-83ab-00ae00f02581');<\/pre>\n","protected":false},"excerpt":{"rendered":"
Methods: createMosaic(options) Creates new raster mosaic layer. This function is an asynchronous function. Parameters: options (Object) Name Description options.name String Name of new mosaic. options.display_name String? Display name of new mosaic. This parameter is helpful in identifying mosaic easily. options.description String? Description of mosaic. options.pixel_selection String How to select pixel values in overlapping regions. Chioces […]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[69],"doc_tag":[],"class_list":["post-6134","docs","type-docs","status-publish","hentry","doc_category-mosaic"],"_links":{"self":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6134","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/comments?post=6134"}],"version-history":[{"count":28,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6134\/revisions"}],"predecessor-version":[{"id":6678,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/docs\/6134\/revisions\/6678"}],"wp:attachment":[{"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/media?parent=6134"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_category?post=6134"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/en.geobox.ir\/developers\/wp-json\/wp\/v2\/doc_tag?post=6134"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}