Spatial REST API

Get Virtual Mosaic Data in Image Format

post

{server}/georaster/v1/{datasource}/vm/{virtualMosaicName}/rasterImage

Get a subset of the specified virtual mosaic in image format.

Request

Path Parameters

virtualMosaicName(required): string

The name of the virtual mosaic

Query Parameters

format: string
the format of the image, JPEG, GIF, PNG, BMP

Allowed Values: [ "JPEG", "GIF", "PNG", "BMP" ]
Example:
```
JPEG
```

Supported Media Types

application/json

Root Schema : schema

Type: object

parameters for returning the mosaic subset in an image

Show Source

renderOps: object rendering_param

client side rendering options
vm_param: object vm_param

virtual mosaic retrieval parameter. Some parameters are part of the virtual mosaic definition too. If these parameters are specified, they will overwrite the parameters specified at virutal mosaic definition.

{
    "type":"object",
    "description":"parameters for returning the mosaic subset in an image",
    "properties":{
        "renderOps":{
            "$ref":"#/components/schemas/rendering_param"
        },
        "vm_param":{
            "$ref":"#/components/schemas/vm_param"
        }
    }
}

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

{
    "type":"object",
    "description":"client side rendering options",
    "properties":{
        "IPMethod":{
            "description":"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.",
            "type":"string",
            "enum":[
                "none",
                "stretch",
                "piecewisestretch",
                "normalize",
                "equalize"
            ]
        },
        "colorMap":{
            "$ref":"#/components/schemas/colormap"
        },
        "grayScale":{
            "$ref":"#/components/schemas/grayscale"
        },
        "nodataMapping":{
            "$ref":"#/components/schemas/nodataMapping"
        },
        "mask":{
            "$ref":"#/components/schemas/mask"
        }
    }
}

Nested Schema : vm_param

Type: object

virtual mosaic retrieval parameter. Some parameters are part of the virtual mosaic definition too. If these parameters are specified, they will overwrite the parameters specified at virutal mosaic definition.

Show Source

bandNumbers: string
bgValues: array sdo_number_array
colorBalance: object colorBalance
commonPointRule: string

Allowed Values: [ "start", "end", "latest", "oldest", "ctc", "high", "low", "average", "highres" ]
considerNodata: boolean

Default Value: false
cropArea: cropArea
fillGap: boolean

Default Value: false
memoryParam: object memoryParam

the memory usage parameter
pyramidLevel: integer
resamplingMethod: string
resamplingTolerance: number

Minimum Value: 0

Maximum Value: 0.5
resFilter: boolean

Default Value: false

{
    "type":"object",
    "description":"virtual mosaic retrieval parameter. Some parameters are part of the virtual mosaic definition too. If these parameters are specified, they will overwrite the parameters specified at virutal mosaic definition.",
    "properties":{
        "pyramidLevel":{
            "type":"integer"
        },
        "bandNumbers":{
            "type":"string"
        },
        "cropArea":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                {
                    "$ref":"#/components/schemas/sdo_geometry"
                }
            ],
            "nullable":true
        },
        "resamplingMethod":{
            "type":"string"
        },
        "resamplingTolerance":{
            "type":"number",
            "minimum":0,
            "maximum":0.5
        },
        "commonPointRule":{
            "type":"string",
            "enum":[
                "start",
                "end",
                "latest",
                "oldest",
                "ctc",
                "high",
                "low",
                "average",
                "highres"
            ]
        },
        "considerNodata":{
            "type":"boolean",
            "default":false
        },
        "fillGap":{
            "type":"boolean",
            "default":false
        },
        "resFilter":{
            "type":"boolean",
            "default":false
        },
        "colorBalance":{
            "type":"object",
            "required":[
                "balanceMethod"
            ],
            "properties":{
                "balanceMethod":{
                    "type":"string",
                    "enum":[
                        "none",
                        "linearstretching",
                        "statisticdmatching",
                        "histogrammatching"
                    ],
                    "default":"none"
                },
                "referenceMethod":{
                    "type":"string",
                    "enum":[
                        "value",
                        "image",
                        "overlap"
                    ]
                },
                "reference":{
                    "oneOf":[
                        {
                            "$ref":"#/components/schemas/sdo_georaster"
                        },
                        {
                            "type":"object",
                            "properties":{
                                "value1":{
                                    "$ref":"#/components/schemas/sdo_number_array"
                                },
                                "value2":{
                                    "$ref":"#/components/schemas/sdo_number_array"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/sdo_geor_histogram"
                        }
                    ]
                }
            }
        },
        "bgValues":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "memoryParam":{
            "$ref":"#/components/schemas/memoryParam"
        }
    }
}

Nested Schema : colormap

Type: array

an array of colormap entries

Show Source

Array of: object items

colormap entry

{
    "type":"array",
    "description":"an array of colormap entries",
    "items":{
        "type":"object",
        "description":"colormap entry",
        "properties":{
            "value":{
                "type":"number"
            },
            "red":{
                "type":"integer"
            },
            "green":{
                "type":"integer"
            },
            "blue":{
                "type":"integer"
            },
            "alpha":{
                "type":"number"
            }
        }
    }
}

Nested Schema : grayscale

Type: array

an array of grayscale entries

Show Source

Array of: object items

grayscale entry

{
    "type":"array",
    "description":"an array of grayscale entries",
    "items":{
        "type":"object",
        "description":"grayscale entry",
        "properties":{
            "value":{
                "type":"number"
            },
            "gray":{
                "type":"integer"
            }
        }
    }
}

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

{
    "type":"array",
    "description":"an array specifying the layers to apply the mask, if there is no mask in that layer, it is ignored.",
    "items":{
        "type":"object",
        "description":"Define the mask mapping",
        "properties":{
            "layerNumber":{
                "type":"number"
            },
            "zeroMapping":{
                "type":"number"
            },
            "oneMapping":{
                "type":"number"
            }
        }
    }
}

Nested Schema : nodataMapping

Type: array

an array of nodata mapping entries

Show Source

Array of: object items

nodata mapping entry

{
    "type":"array",
    "description":"an array of nodata mapping entries",
    "items":{
        "type":"object",
        "description":"nodata mapping entry",
        "properties":{
            "startValue":{
                "type":"number"
            },
            "endValue":{
                "type":"number"
            },
            "newValue":{
                "type":"number"
            },
            "isTransparent":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

colormap entry

Show Source

alpha: number
blue: integer
green: integer
red: integer
value: number

{
    "type":"object",
    "description":"colormap entry",
    "properties":{
        "value":{
            "type":"number"
        },
        "red":{
            "type":"integer"
        },
        "green":{
            "type":"integer"
        },
        "blue":{
            "type":"integer"
        },
        "alpha":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: object

grayscale entry

Show Source

gray: integer
value: number

{
    "type":"object",
    "description":"grayscale entry",
    "properties":{
        "value":{
            "type":"number"
        },
        "gray":{
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: object

Define the mask mapping

Show Source

layerNumber: number
oneMapping: number
zeroMapping: number

{
    "type":"object",
    "description":"Define the mask mapping",
    "properties":{
        "layerNumber":{
            "type":"number"
        },
        "zeroMapping":{
            "type":"number"
        },
        "oneMapping":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: object

nodata mapping entry

Show Source

endValue: number
isTransparent: boolean
newValue: number
startValue: number

{
    "type":"object",
    "description":"nodata mapping entry",
    "properties":{
        "startValue":{
            "type":"number"
        },
        "endValue":{
            "type":"number"
        },
        "newValue":{
            "type":"number"
        },
        "isTransparent":{
            "type":"boolean"
        }
    }
}

Nested Schema : sdo_number_array

Type: array

Show Source

Array of: number

{
    "type":"array",
    "items":{
        "type":"number"
    }
}

Nested Schema : colorBalance

Type: object

Show Source

balanceMethod(required): string

Default Value: none

Allowed Values: [ "none", "linearstretching", "statisticdmatching", "histogrammatching" ]
reference: reference
referenceMethod: string

Allowed Values: [ "value", "image", "overlap" ]

{
    "type":"object",
    "required":[
        "balanceMethod"
    ],
    "properties":{
        "balanceMethod":{
            "type":"string",
            "enum":[
                "none",
                "linearstretching",
                "statisticdmatching",
                "histogrammatching"
            ],
            "default":"none"
        },
        "referenceMethod":{
            "type":"string",
            "enum":[
                "value",
                "image",
                "overlap"
            ]
        },
        "reference":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/sdo_georaster"
                },
                {
                    "type":"object",
                    "properties":{
                        "value1":{
                            "$ref":"#/components/schemas/sdo_number_array"
                        },
                        "value2":{
                            "$ref":"#/components/schemas/sdo_number_array"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/sdo_geor_histogram"
                }
            ]
        }
    }
}

Nested Schema : cropArea

Match One Schema

Show Source

array sdo_number_array
object sdo_geometry

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/sdo_number_array"
        },
        {
            "$ref":"#/components/schemas/sdo_geometry"
        }
    ],
    "nullable":true
}

Nested Schema : memoryParam

Type: object

the memory usage parameter

Show Source

maxMemSize: integer (int64)
readBlockMemSize: integer
writeBlockMemSize: integer

{
    "type":"object",
    "description":"the memory usage parameter",
    "properties":{
        "maxMemSize":{
            "type":"integer",
            "format":"int64"
        },
        "readBlockMemSize":{
            "type":"integer"
        },
        "writeBlockMemSize":{
            "type":"integer"
        }
    }
}

Nested Schema : reference

Match One Schema

Show Source

object sdo_georaster
object reference-oneOf[1]
object sdo_geor_histogram

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/sdo_georaster"
        },
        {
            "type":"object",
            "properties":{
                "value1":{
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                "value2":{
                    "$ref":"#/components/schemas/sdo_number_array"
                }
            }
        },
        {
            "$ref":"#/components/schemas/sdo_geor_histogram"
        }
    ]
}

Nested Schema : sdo_georaster

Type: object

Show Source

rasterDataTable: string
rasterID: integer

{
    "type":"object",
    "properties":{
        "rasterDataTable":{
            "type":"string"
        },
        "rasterID":{
            "type":"integer"
        }
    }
}

Nested Schema : reference-oneOf[1]

Type: object

Show Source

value1: array sdo_number_array
value2: array sdo_number_array

{
    "type":"object",
    "properties":{
        "value1":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "value2":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    }
}

Nested Schema : sdo_geor_histogram

Type: object

Show Source

cellvalue: array sdo_number_array
count: array sdo_number_array

{
    "type":"object",
    "properties":{
        "cellvalue":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "count":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    }
}

Nested Schema : sdo_geometry

Type: object

Show Source

attr: string

{
    "type":"object",
    "properties":{
        "attr":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

image/png
image/jpeg
image/bmp
image/gif

200 Response

Return the virtual mosaic subset in an image.

Root Schema : schema

Type: string(binary)

401 Response

Authentication information is missing or invalid

Headers

WWW_Authenticate:

Examples

The following is an example on how to request a subset of the virtual mosaic "landsatMosaic" in JPEG format by submitting a POST request using cURL.

curl -X POST -d @request.json "https://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic/rasterImage?format=JPEG" -H "Cookie: JSESSIONID=<jsessionid_value>"

The following is an example of request.json for the request body:

{
  "bandNumbers": "0",
  "cropArea": [
    0,
    0,
    100,
    100
  ],
  "resamplingMethod": "bilinear",
  "considerNodata": true,
  "fillGap": true,
  "commonPointRule": "low"
}