{"_id":"5730de42053a062b00cf4747","category":{"_id":"56ddf6df8a5ae10e008e3926","project":"55faeacad0e22017005b8265","pages":["56ddf8a4a6eb5c170042d72f"],"__v":1,"version":"55faeacad0e22017005b8268","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-07T21:47:11.224Z","from_sync":false,"order":18,"slug":"imagery","title":"IDAHO Guide"},"__v":6,"parentDoc":null,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"editedParams2":true,"project":"55faeacad0e22017005b8265","user":"55fae9d4825d5f19001fa379","editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-09T19:00:18.401Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"The response will be the requested tile and be of Content-Type image/png or image/tif.","language":"json","status":200}]},"settings":"57335608af2a74190094037b","examples":{"codes":[{"language":"json","code":"http://idaho.geobigdata.io/v1/tile/idaho-images/61119e3e-af0e-4230-8c24-c232203dfcbf/11/428/776?bands=6,4,2&format=png&gamma=1.3&highCutoff=0.98&lowCutoff=0.02&brightness=1.0&contrast=1.0&token=<your gbdx bearer token>"}]},"auth":"required","params":[{"_id":"5730e0410f929f3600841cea","ref":"","in":"path","required":true,"desc":"bucket location for the tile image","default":"","type":"string","name":"bucket_name"},{"_id":"5730e0410f929f3600841ce9","ref":"","in":"path","required":true,"desc":"The identifier for the IDAHO image. In the GBDX catalog, this is the catalog ID or image ID.","default":"","type":"string","name":"idaho_id"},{"_id":"5730e0410f929f3600841ce8","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"tileZ"},{"_id":"5730e0410f929f3600841ce7","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"tileX"},{"_id":"5730e0410f929f3600841ce6","ref":"","in":"query","required":true,"desc":"","default":"","type":"int","name":"tileY"},{"_id":"5730e0ceb16ed73200ddd26e","ref":"","in":"query","required":true,"desc":"The bearer token for authentication","default":"","type":"string","name":"token"},{"_id":"5730e0ceb16ed73200ddd26d","ref":"","in":"query","required":false,"desc":"comma delimited list of bands to display. The band indexing is \"0\" based, i.e. the first band is 0. Examples \"2,1,0\", \"0\"","default":"","type":"string","name":"bands"},{"_id":"5730e0ceb16ed73200ddd26c","ref":"","in":"query","required":false,"desc":"(true/false) Perform a Dynamic Range Adjustment on the output tile","default":"","type":"boolean","name":"doDRA"},{"_id":"5730e30c053a062b00cf479a","ref":"","in":"query","required":false,"desc":"The low threshold cutoff for the DRA operation","default":"0.02","type":"double","name":"lowCutoff"},{"_id":"5730e30c053a062b00cf4799","ref":"","in":"query","required":false,"desc":"The high threshold cutoff for the DRA operation","default":"0.98","type":"double","name":"highCutoff"},{"_id":"5730e30c053a062b00cf4798","ref":"","in":"query","required":false,"desc":"The gamma parameter for the DRA operation","default":"1.3","type":"double","name":"gamma"},{"_id":"5730e30c053a062b00cf4797","ref":"","in":"query","required":false,"desc":"The brightness parameter for the DRA operation","default":"1.0","type":"double","name":"brightness"},{"_id":"5730e77f26bd5a3600d3387b","ref":"","in":"query","required":false,"desc":"The contrast parameter for the DRA operation","default":"1.0","type":"double","name":"contrast"},{"_id":"5730e30c053a062b00cf4796","ref":"","in":"query","required":false,"desc":"array of n floats, The balance parameter for the DRA operation","default":"0.0, 0.0, 0.0","type":"string","name":"balance"},{"_id":"5730e30c053a062b00cf4795","ref":"","in":"query","required":false,"desc":"Type = FLOAT; If supplied tile will be sharpened using this parameter.","default":"","type":"string","name":"sharpening"},{"_id":"5730e30c053a062b00cf4794","ref":"","in":"query","required":false,"desc":"if supplied A pan sharpening will be performed using the given Pan IDAHO Image ID","default":"","type":"string","name":"panId"},{"_id":"5730e30c053a062b00cf4793","ref":"","in":"query","required":false,"desc":"the output tile image format. Can be \"png\" or \"tif\"","default":"","type":"string","name":"format"}],"url":"/v1/tile/:bucket_name/:idaho_id/:tileZ/:tileX/:TileY"},"isReference":false,"order":5,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"The request url can take a variety of optional parameters. See the list above.\"\n}\n[/block]\n\n# More Examples\n\nUse your GBDX token in place of <your gbdx bearer token>.\n\n\n### Get a Panchromatic TMS tile (processed on-the-fly from source IDAHO data):\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/tile/idaho-images/ba228aaf-76f2-41d1-b4e9-9b6c08068067/19/8327/202844?token=<your gbdx bearer token>&bands=0\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Get an MS TMS tile:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/tile/idaho-images/5cda7cc9-93a0-48f4-bccb-1ee26f5cf6aa/19/83827/202844?token=<your gbdx bearer token>&bands=4,2,1\\n\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same MS TMS tile, different band combination:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/tile/idaho-images/5cda7cc9-93a0-48f4-bccb-1ee26f5cf6aa/19/83827/202844?token=<your gbdx bearer token>&bands=6,4,2\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same MS TMS tile, pan-sharpened:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/tile/idaho-images/5cda7cc9-93a0-48f4-bccb-1ee26f5cf6aa/19/83827/202844?token=<your gbdx bearer token>&bands=6,4,2&panId=ba228aaf-76f2-41d1-b4e9-9b6c08068067\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n#Authentication\n\nFor the TMS Tile Service, the bearer token must be passed as a URL parameter. See the example URL above for formatting.\n\n\n# Parameter Details\n\nThese optional parameters can be appended to the GET url to control the output tile you receive.\n\n## Dynamic Range Adjustment (DRA) Parameters\n\nThe following DRA parameters are intended for visual use only. They are not recommended for use in image processing.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"DRA Parameter\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Default\",\n    \"h-3\": \"Range\",\n    \"0-0\": \"lowCutoff\",\n    \"0-1\": \"The percentage at which the histogram's distribution will be removed from the bottom of the stretch\",\n    \"0-2\": \"0.02\",\n    \"0-3\": \"0.0 to 1.0\",\n    \"1-0\": \"highCutoff\",\n    \"1-2\": \"0.98\",\n    \"1-1\": \"The percentage at which the histogram's distribution will be removed top of the stretch\",\n    \"1-3\": \"0.0 to 1.0\",\n    \"2-0\": \"gamma\",\n    \"2-2\": \"1.3\",\n    \"2-1\": \"The gamma adjustment parameter\",\n    \"2-3\": \"Usually set to a range of 1 to 2\",\n    \"3-0\": \"brightness\",\n    \"3-2\": \"1.0\",\n    \"3-1\": \"Multiplier for overall image brightness\",\n    \"3-3\": \"0.0 to n\",\n    \"4-0\": \"contrast\",\n    \"4-2\": \"1.0\",\n    \"4-1\": \"Multiplier for overall image contrast\",\n    \"4-3\": \"0.0 to n\",\n    \"5-0\": \"balance\",\n    \"5-2\": \"0.0, 0.0, 0.0\",\n    \"5-1\": \"Adjustment added to the color components to adjust color balance\",\n    \"5-3\": \"-n to n\"\n  },\n  \"cols\": 4,\n  \"rows\": 6\n}\n[/block]\n## Sharpening Parameter\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"sharpening\",\n    \"0-1\": \"If supplied an unsharp mask will be applied to the output tile. The parameter adjusts the gain of the unsharp mask.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Using the sharpening parameter will significantly affect the performance of the service\",\n  \"body\": \"Response times will be significantly increased.\"\n}\n[/block]\n## Pan Sharpening Parameter\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"panId\",\n    \"0-1\": \"assumes the input IDAHO id is for a multispectral image, and that the supplied panId is for the pan image for the same product. Note, pan sharpening will only occur when the requested tile's ground sampling distance (gsd) is less then the gsd of the input multispectral image (i.e. only when the pan sharpening makes sense).\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\nTo learn more about  TMS, see  <a href=\"http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification\" target=\"_blank\">OSGEO TileMapService Specification</a>","excerpt":"Get a specific TMS tile.","slug":"get-a-tms-tile","type":"endpoint","title":"GET a TMS Tile"}

getGET a TMS Tile

Get a specific TMS tile.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

bucket_name:
required
string
bucket location for the tile image
idaho_id:
required
string
The identifier for the IDAHO image. In the GBDX catalog, this is the catalog ID or image ID.
tileZ:
required
integer
tileX:
required
integer

Query Params

tileY:
required
integer
token:
required
string
The bearer token for authentication
bands:
string
comma delimited list of bands to display. The band indexing is "0" based, i.e. the first band is 0. Examples "2,1,0", "0"
doDRA:
boolean
(true/false) Perform a Dynamic Range Adjustment on the output tile
lowCutoff:
double0.02
The low threshold cutoff for the DRA operation
highCutoff:
double0.98
The high threshold cutoff for the DRA operation
gamma:
double1.3
The gamma parameter for the DRA operation
brightness:
double1.0
The brightness parameter for the DRA operation
contrast:
double1.0
The contrast parameter for the DRA operation
balance:
string0.0, 0.0, 0.0
array of n floats, The balance parameter for the DRA operation
sharpening:
string
Type = FLOAT; If supplied tile will be sharpened using this parameter.
panId:
string
if supplied A pan sharpening will be performed using the given Pan IDAHO Image ID
format:
string
the output tile image format. Can be "png" or "tif"

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "The request url can take a variety of optional parameters. See the list above." } [/block] # More Examples Use your GBDX token in place of <your gbdx bearer token>. ### Get a Panchromatic TMS tile (processed on-the-fly from source IDAHO data): [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/tile/idaho-images/ba228aaf-76f2-41d1-b4e9-9b6c08068067/19/8327/202844?token=<your gbdx bearer token>&bands=0", "language": "text" } ] } [/block] ### Get an MS TMS tile: [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/tile/idaho-images/5cda7cc9-93a0-48f4-bccb-1ee26f5cf6aa/19/83827/202844?token=<your gbdx bearer token>&bands=4,2,1\n", "language": "text" } ] } [/block] ### Same MS TMS tile, different band combination: [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/tile/idaho-images/5cda7cc9-93a0-48f4-bccb-1ee26f5cf6aa/19/83827/202844?token=<your gbdx bearer token>&bands=6,4,2", "language": "text" } ] } [/block] ### Same MS TMS tile, pan-sharpened: [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/tile/idaho-images/5cda7cc9-93a0-48f4-bccb-1ee26f5cf6aa/19/83827/202844?token=<your gbdx bearer token>&bands=6,4,2&panId=ba228aaf-76f2-41d1-b4e9-9b6c08068067", "language": "text" } ] } [/block] #Authentication For the TMS Tile Service, the bearer token must be passed as a URL parameter. See the example URL above for formatting. # Parameter Details These optional parameters can be appended to the GET url to control the output tile you receive. ## Dynamic Range Adjustment (DRA) Parameters The following DRA parameters are intended for visual use only. They are not recommended for use in image processing. [block:parameters] { "data": { "h-0": "DRA Parameter", "h-1": "Description", "h-2": "Default", "h-3": "Range", "0-0": "lowCutoff", "0-1": "The percentage at which the histogram's distribution will be removed from the bottom of the stretch", "0-2": "0.02", "0-3": "0.0 to 1.0", "1-0": "highCutoff", "1-2": "0.98", "1-1": "The percentage at which the histogram's distribution will be removed top of the stretch", "1-3": "0.0 to 1.0", "2-0": "gamma", "2-2": "1.3", "2-1": "The gamma adjustment parameter", "2-3": "Usually set to a range of 1 to 2", "3-0": "brightness", "3-2": "1.0", "3-1": "Multiplier for overall image brightness", "3-3": "0.0 to n", "4-0": "contrast", "4-2": "1.0", "4-1": "Multiplier for overall image contrast", "4-3": "0.0 to n", "5-0": "balance", "5-2": "0.0, 0.0, 0.0", "5-1": "Adjustment added to the color components to adjust color balance", "5-3": "-n to n" }, "cols": 4, "rows": 6 } [/block] ## Sharpening Parameter [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "sharpening", "0-1": "If supplied an unsharp mask will be applied to the output tile. The parameter adjusts the gain of the unsharp mask." }, "cols": 2, "rows": 1 } [/block] [block:callout] { "type": "warning", "title": "Using the sharpening parameter will significantly affect the performance of the service", "body": "Response times will be significantly increased." } [/block] ## Pan Sharpening Parameter [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "panId", "0-1": "assumes the input IDAHO id is for a multispectral image, and that the supplied panId is for the pan image for the same product. Note, pan sharpening will only occur when the requested tile's ground sampling distance (gsd) is less then the gsd of the input multispectral image (i.e. only when the pan sharpening makes sense)." }, "cols": 2, "rows": 1 } [/block] To learn more about TMS, see <a href="http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification" target="_blank">OSGEO TileMapService Specification</a>