{"_id":"582373d38e8224190004275b","parentDoc":null,"__v":0,"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"},"project":"55faeacad0e22017005b8265","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":20,"slug":"imagery","title":"IDAHO Guide"},"user":"55fae9d4825d5f19001fa379","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-09T19:06:59.856Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET - http:idaho.geobigdata.io/v1/chip/centroid/{bucket_name}/{idaho_id}?lat={center_latitude}&long={center_longitude&resolution={pixel_resolution_in_meters}"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"The response will the requested tile and be of Content-Type image/png or image/tif.","name":""}]},"settings":"57335608af2a74190094037b","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":"","default":"","type":"string","name":"idaho_id"},{"_id":"5730e0410f929f3600841ce8","ref":"","in":"query","required":true,"desc":"Latitude at the center of the image.","default":"","type":"string","name":"latitude"},{"_id":"5730e0410f929f3600841ce7","ref":"","in":"query","required":true,"desc":"","default":"","type":"string","name":"longitude"},{"_id":"5730f25d6b55e93400b32ad0","ref":"","in":"query","required":false,"desc":"Width of the output image in pixels","default":"256","type":"string","name":"width"},{"_id":"5730f2aa0f929f3600841d22","ref":"","in":"query","required":false,"desc":"Height of the output image in pixels","default":"256","type":"string","name":"height"},{"_id":"5730e0ceb16ed73200ddd26e","ref":"","in":"query","required":true,"desc":"The bearer token for authentication","default":"","type":"string","name":"token"},{"_id":"5730f15226bd5a3600d33898","ref":"","in":"query","required":false,"desc":"Pixel resolution (a.k.a ground-sample-distance or GSD) in meters.","default":"native image resolution","type":"string","name":"resolution"},{"_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\". Can be \"png\" or \"tif\". If \"tif\" is specified the output will be a geotif","default":"","type":"string","name":"format"}],"url":"/v1/chip/centroid/{bucket_name}/{idaho_id}?lat={center_latitude}&long={center_longitude&resolution={pixel_resolution_in_meters}"},"isReference":false,"order":8,"body":"#Authentication\n\nFor the TMS Tile Service, the user token must be passed as a URL parameter. See the example URL above for formatting.\n\n\n# Parameter Details\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]\n# Examples\nTo see the images in these examples, append your GBDX token to the end of the url in place of the word \"TOKEN.\". \n\n\n### Image with all defaults\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&token=TOKEN\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same image, but larger\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&height=512&width=512&token=TOKEN\\n\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same image, but 16-bit, 8-band tif (note DRA is turned off by default when a tif is requested)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&format=tif&token=TOKEN\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same image, but zoomed out so that each pixel measures 10 meters on the ground\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&resolution=10.0&token=TOKEN\\n\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same image, but zoomed in and pan-sharpened\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"ttp://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&resolution=0.5&panId=694a66b9-92f6-49e0-847f-3675fcc901c8&token=TOKEN\\n\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n### Same image, but zoomed in and pan-sharpened with band 6,4, and 2.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&resolution=0.5&panId=694a66b9-92f6-49e0-847f-3675fcc901c8&bands=6,4,2&token=TOKEN\\n\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","excerpt":"Use the Centroid Chip service to retrieve an image by specifying the center and a width and height. The resulting chip will be an image that has been orthorectified. Optionally, it may also be pan-sharpened and/or DRA'ed.","slug":"get-centroid-chip","type":"endpoint","title":"GET a Centroid Chip"}

getGET a Centroid Chip

Use the Centroid Chip service to retrieve an image by specifying the center and a width and height. The resulting chip will be an image that has been orthorectified. Optionally, it may also be pan-sharpened and/or DRA'ed.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

bucket_name:
required
string
bucket location for the tile image
idaho_id:
required
string

Query Params

latitude:
required
string
Latitude at the center of the image.
longitude:
required
string
width:
string256
Width of the output image in pixels
height:
string256
Height of the output image in pixels
token:
required
string
The bearer token for authentication
resolution:
stringnative image resolution
Pixel resolution (a.k.a ground-sample-distance or GSD) in meters.
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". Can be "png" or "tif". If "tif" is specified the output will be a geotif

Examples


Result Format


Documentation

#Authentication For the TMS Tile Service, the user token must be passed as a URL parameter. See the example URL above for formatting. # Parameter Details ## 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] # Examples To see the images in these examples, append your GBDX token to the end of the url in place of the word "TOKEN.". ### Image with all defaults [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&token=TOKEN", "language": "text" } ] } [/block] ### Same image, but larger [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&height=512&width=512&token=TOKEN\n", "language": "text" } ] } [/block] ### Same image, but 16-bit, 8-band tif (note DRA is turned off by default when a tif is requested) [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&format=tif&token=TOKEN", "language": "text" } ] } [/block] ### Same image, but zoomed out so that each pixel measures 10 meters on the ground [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&resolution=10.0&token=TOKEN\n", "language": "text" } ] } [/block] ### Same image, but zoomed in and pan-sharpened [block:code] { "codes": [ { "code": "ttp://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&resolution=0.5&panId=694a66b9-92f6-49e0-847f-3675fcc901c8&token=TOKEN\n", "language": "text" } ] } [/block] ### Same image, but zoomed in and pan-sharpened with band 6,4, and 2. [block:code] { "codes": [ { "code": "http://idaho.geobigdata.io/v1/chip/centroid/idaho-images-oregon/aa63fcd1-83e9-444f-a652-126cb17351ba?lat=-20.311627&long=118.575258&resolution=0.5&panId=694a66b9-92f6-49e0-847f-3675fcc901c8&bands=6,4,2&token=TOKEN\n", "language": "text" } ] } [/block]