{
"openapi": "3.0.1",
"info": {
"title": "Elevation Index",
"description": "",
"version": "1.0"
},
"servers": [
{
"url": "https://ag-analytics.azure-api.net/elevation-index"
}
],
"paths": {
"/": {
"post": {
"summary": "Elevation Index POST Request - Prepare TIFF",
"description": "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nThe Elevation Index API offers a means of computing four elevation indices for an elevation raster that is passed to the service. The four indices are relative elevation, slope, topographic position index (TPI), and terrain ruggedness index (TRI). When using the API, the client can specify the particular indices that should be calculated for the elevation raster and there are options for a few tuning parameters relating to TPI and TRI.\nThe intent behind the service is to provide farmers and producers with the ability to extract more information about the elevation of their field and the relationship with parameters such as wetness and yield. The correlation between these indices and yield is most often due to the way water is transported across sections of a farm field (i.e., correlation with chronically dry and wet areas).\n
\n
Parameter | \nData Type | \nRequired? | \nDefault | \nOptions | \nDescription | \n
---|---|---|---|---|---|
Shape | \ngeojson | \nYes | \n-- | \ngeojson | \n Geojson area of interest to return | \n
index_list | \nList of indices as a string | \n Yes | \n-- | \n\"Relative_Elevation\" \"Slope\" \"TPI\" \"TRI\" | \n Indices that should be calculated for the input geojson | \n
Inside_Radius | \nInteger as string | \nNo | \n3 | \n0<Outside_Radius<20 | \nOuter radius of window for computing TPI | \n
Outside_Radius | \nInteger as string | \nNo | \n1 | \n0<=Inside_Radius <Outside_Radius | \n Inner radius of window for computing TPI | \n
Search_Radius | \nInteger as string | \nNo | \n1 | \n0 < Search_Radius | \nRadius of window for computing TRI | \n
Legend_Range | \nInteger as string | \nNo | \n3 | \n0 < Legend_Range | \nNumber of ranges to display in png of output image | \n
Parameter | \nData Type | \nRequired? | \n
---|---|---|
Features | \n List | \n Container for all of the features of the DEM raster. | \n
Features.attributes (F.a) | \n Dictionary | \n Each feature in Features has an associated attributes dictionary. | \n
F.a.CellSize | \n List | \n Resolution as x,y cell size. In units of projection. | \n
F.a.CoordinateSystem | \n String | \n Projection in WKT | \n
F.a.Extent | \n String | \n Extent of result geotiff. | \n
F.a.Legend (F.a.L) | \n List | \n Each range in the output PNG is represented by a separate dictionary. | \n
F.a.L.Area | \n String | \n Percent of total image that the particular range of values covers. | \n
F.a.L.Count | \n Int | \n Number of pixels that a particular range takes up in the png. | \n
F.a.L.CountAllPixels | \n Int | \n Total number of pixels in the png image. | \n
F.a.L.Max | \n Float | \n Maximum value in the range. | \n
F.a.L.Mean | \n Float | \n Mean value of the range. | \n
F.a.L.Min | \n Float | \n Min value of the range. | \n
F.a.L.color | \n String | \n Hex value that is used to display the png image. | \n
F.a.Matrix | \n List | \n Dimensions of output image. | \n
F.a.Max | \n Float | \n Maximum value of entire raster. | \n
F.a.Mean | \n Float | \n Mean value of entire raster. | \n
F.a.Min | \n Float | \n Min value of entire raster. | \n
F.a.OID | \n Int | \n Deprecated | \n
F.a.Percentile5 | \n Float | \n 5th percentile value. | \n
F.a.Percentile95 | \n Float | \n 95th percentile value. | \n
F.a.Std | \n Float | \n Standard deviation of raster values. | \n
F.a.Variet | \n String | \n Either Variety or NoVariety. Flag for category or continuous data. | \n
F.a.pngb64 | \n String | \n The png image returned in base64 encoding. | \n
FileName | \n String | \n Name of result raster that was generated in POST request. Used in GET request to retrieve GeoTiff file. | \n
Index_Files | \n List | \n List of elevation index files that can be used in GET request to return the GeoTiffs. | \n
Parameter | \nDescription | \nExample | \nRequest | \n
---|---|---|---|
filenames | \nFile name to download. From POST request. Only request a single file at a time. | \n raster_Slope_46283.tif | \nhttps://ag-analytics.azure-api.net/elevation-index? filenames=raster_Slope_46283.tif | \n