Get Raster Data in Image Format 2
post
{server}/georaster/v1/{datasource}/{tableName}/{georasterColumnName}/{rdt}/{rid}/rasterImage
Query and/or process the raster data of the specified GeoRaster Object and return the results in a standard web image format for display. Additional processing can be specified in the rendering options to get the best rendering image.
Only the "format" and "thumbnail" parameter are allowed in the query parameter, all the rendering or operation parameters should be specified in the request body.
Request
Path Parameters
-
georasterColumnName(required): string
The name of the GeoRaster ColumnExamples
-
rdt(required): string
The Raster Data Table (RDT) Name.Examples
-
rid(required): integer
The Raster ID (RID) of the GeoRaster Object.Examples
-
tableName(required): string
The name of the table, could be prefixed with a schema nameExamples
Query Parameters
-
format: string
Specify the format of the returned image: JPEG, GIF, PNG, or BMP. For the truecolor and grayscale images, it defaults to JPEG. For the pseudocolor images, it defaults to PNG.Allowed Values:
[ "JPEG", "GIF", "PNG", "BMP" ]
Example:JPEG
-
thumbnail: boolean
Boolean value to specify whether return a thumbnail image.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
parameters for returning an image
Show Source
-
rasterOps: object
get_data_param
operations that return data on the fly
-
renderOps: object
rendering_param
client side rendering options
Nested Schema : get_data_param
Type:
object
operations that return data on the fly
Show Source
-
memoryParam: object
memoryParam
the memory usage parameter
-
opName: string
Allowed Values:
[ "affinetransform", "getbitmapmasksubset", "getrasterdata", "getrastersubset", "rectify", "reproject", "warp", "equalize", "filter", "normalize", "piecewisestretch", "stretch", "classify", "diff", "findcells", "normalize", "picewisestretch", "stretch", "classify", "diff", "findcells", "over", "rastermathop", "getmosaicsubset" ]
the operation name -
opParam:
opParam
Nested Schema : rendering_param
Type:
object
client side rendering options
Show Source
-
colorMap: array
colormap
an array of colormap entries
-
grayScale: array
grayscale
an array of grayscale entries
-
IPMethod: string
Allowed Values:
[ "none", "stretch", "piecewisestretch", "normalize", "equalize" ]
the Rendering Image Processing Method. Note that for the data that is returned from the server-side raster operations such as affinetransform, getrasterdata, getrastersubset, rectify, reproject and warp, the image rendering process should use the statistics stored in the GeoRaster Object. If there is no statistics set in the GeoRaster Object metadata, the statistics of the returned data is used in the image processing. When IPMethod is not specified but the data is not in the rendering range (for example, not 8bit), normalization is applied to the rendered image. -
mask: array
mask
an array specifying the layers to apply the mask, if there is no mask in that layer, it is ignored.
-
nodataMapping: array
nodataMapping
an array of nodata mapping entries
Nested Schema : op_rectify_param
Type:
Show Source
object
-
bgvalues: array
sdo_number_array
-
croparea: object
sdo_geometry
-
dem: object
sdo_georaster
-
elevationparam: string
-
layernumbers: string
-
outmodelcoordloc: number
-
outresolutions: array
sdo_number_array
-
outsrid(required): number
-
polygonclip: string
-
pyramidlevel: number
-
referencepoint: object
sdo_geometry
-
resampleparam: string
-
resolutionunit: string
-
storageparam: string
Nested Schema : sdo_geor_srs
Type:
Show Source
object
-
columndenominator: array
sdo_number_array
-
columnnumerator: array
sdo_number_array
-
columnoff: number
-
columnrms: number
-
columnscale: number
-
coordlocation: number
-
gcpgeoreferencemodel: object
sdo_geor_gcpgeoreftype
-
isorthorectified: string
-
isrectified: string
-
isreferenced: string
-
modeltotalrms: number
-
rowdenominator: array
sdo_number_array
-
rownumerator: array
sdo_number_array
-
rowoff: number
-
rowrms: number
-
rowscale: number
-
spatialresolution: array
sdo_number_array
-
spatialtolerance: number
-
srid: number
-
totalrms: number
-
xoff: number
-
xrms: number
-
xscale: number
-
yoff: number
-
yrms: number
-
yscale: number
-
zoff: number
-
zrms: number
-
zscale: number
Nested Schema : op_getmosaicsubset_param_1
Type:
Show Source
object
-
bgvalues: array
sdo_number_array
-
boundaryclip: string
-
croparea: object
sdo_geometry
-
georastercolumnnames(required): string
-
georastertablenames(required): string
-
layernumbers: string
-
mosaicparam: string
-
outmodelcoordloc: number
-
outresolutions: array
sdo_number_array
-
outsrid: number
-
polygonclip: string
-
pyramidlevel: number
-
referencepoint: object
sdo_geometry
-
resolutionunit: string
-
storageparam: string
Nested Schema : op_getmosaicsubset_param_2
Type:
Show Source
object
-
bgvalues: array
sdo_number_array
-
boundaryclip: string
-
croparea: object
sdo_geometry
-
elevationparam: string
-
georastercolumnnames(required): string
-
georastertablenames(required): string
-
layernumbers: string
-
mosaicparam: string
-
outmodelcoordloc: number
-
outresolutions: array
sdo_number_array
-
outsrid: number
-
polygonclip: string
-
pyramidlevel: number
-
referenceimage: object
sdo_georaster
-
referencepoint: object
sdo_geometry
-
referencevalue1: array
sdo_number_array
-
referencevalue2: array
sdo_number_array
-
refhistograms: array
sdo_geor_histogram_array
-
resolutionunit: string
-
storageparam: string
Nested Schema : colormap
Type:
array
an array of colormap entries
Show Source
-
Array of:
object items
colormap entry
Nested Schema : grayscale
Type:
array
an array of grayscale entries
Show Source
-
Array of:
object items
grayscale entry
Nested Schema : mask
Type:
array
an array specifying the layers to apply the mask, if there is no mask in that layer, it is ignored.
Show Source
-
Array of:
object items
Define the mask mapping
Nested Schema : nodataMapping
Type:
array
an array of nodata mapping entries
Show Source
-
Array of:
object items
nodata mapping entry
Examples
Back to Top
Response
Supported Media Types
- image/png
- image/jpeg
- image/bmp
- image/gif
200 Response
Return the output raster image in binary stream
Root Schema : schema
Type:
string(binary)
401 Response
Examples
The following is an example on how to request a thumbnail image from a GeoRaster Object by submitting a POST request using cURL.
curl -X POST -d @request.json http://localhost:8080/oraclespatial/georaster/v1/datasource1/raster_image/image/rasterImage?format=JPEG" -H "Cookie: JSESSIONID=<jsessionid_value>"
The following is an example of request.json for the request body:
{ "renderOps": { "IPMethod": "normalize" }, "rasterOps": { "opName": "reproject", "opParam": { "outSRID": 4326, "resampleParam": "resampling=bilinear", "pyramidLevel": 1, "cropArea": [ 100, 100, 200, 200 ], "bandNumber": "0-2", "storageParam": "celldepth=16bit_u" } } }