{"_id":"5730ec9eb16ed73200ddd282","parentDoc":null,"user":"55fae9d4825d5f19001fa379","__v":5,"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"},"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,"editedParams":true,"project":"55faeacad0e22017005b8265","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-09T20:01:34.070Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"GET - idaho.geobigdata.io/v1/chip/bbox/{bucket_name}/{idaho_id}?upperLeft={upperLeft_corner}&lowerRight={lowerRight_corner}"}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"The response will be the requested tile and be of Content-Type image/png or image/tif."}]},"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":"A comma separated String of Lon, Lat at the upper left corner of the image","default":"","type":"string","name":"upperLeft"},{"_id":"5730e0410f929f3600841ce7","ref":"","in":"query","required":true,"desc":"A comma separated String of Lon, Lat at the lower right corner of the image.","default":"","type":"string","name":"lowerRight"},{"_id":"5730ee0226bd5a3600d3388e","ref":"","in":"query","required":false,"desc":"Width of the output image in pixels","default":"if not supplied the output width will be calculated using native GSD","type":"string","name":"width"},{"_id":"5730ee6e19c1e00e006d2165","ref":"","in":"query","required":false,"desc":"Height of the output image in pixels","default":"if not supplied the output height will be calculated using native GSD","type":"string","name":"height"},{"_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\". Can be \"png\" or \"tif\". If \"tif\" is specified the output will be a geotif","default":"","type":"string","name":"format"}],"url":"/v1/chip/bbox/{bucket_name}/{idaho_id}?upperLeft={upperLeft_corner}&lowerRight={lowerRight_corner}"},"isReference":false,"order":7,"body":"","excerpt":"Use the BBox  (bounding box) Chip service to retrieve an image by suppling the upper left and lower right corners. The resulting chip will be an image that has been orthorectified.  Optionally, it may have also been pan-sharpened and/or DRA'ed.","slug":"get-a-bbox-chip","type":"endpoint","title":"GET a BBox Chip"}

getGET a BBox Chip

Use the BBox (bounding box) Chip service to retrieve an image by suppling the upper left and lower right corners. The resulting chip will be an image that has been orthorectified. Optionally, it may have also been 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

upperLeft:
required
string
A comma separated String of Lon, Lat at the upper left corner of the image
lowerRight:
required
string
A comma separated String of Lon, Lat at the lower right corner of the image.
width:
stringif not supplied the output width will be calculated using native GSD
Width of the output image in pixels
height:
stringif not supplied the output height will be calculated using native GSD
Height of the output image in pixels
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". Can be "png" or "tif". If "tif" is specified the output will be a geotif

Examples


Result Format