Indicates if the algorithm to process multiple files will be apply in ascedent or descendent order. If you specify another value different to true it will take the value of false by default.
HDFS block size in megabytes, determines the size of the tiles created when loading a raster in HDFS. It is only required when you choose output to HDFS. This value will only be read when you choose the hadoop implementation, when the selected format allows the output to HDFS and if you choose HDFS as the output file system.
Hexadecimal value to fill the pixels with no data, # will be add in the server if not provided. Also this value must be accord to the selected pixel type of the output. If you do not provide this value a value with 0's will be used. If you do not provide the full value the value will be fill with 0's. The value have relation with the data type, value length must be two.
"Output folder of the result. It could be a HDFS path or a normal filesystem path. If you choose output to HDFS you can not use ':' due a HDFS filesystem restrictions, all the invalid chars for paths apply for this value. The server could add the NFS mount point to save the result in HDFS."
Indicates that the output will be HDFS or not. If you indicate another value different from true, default value will be used. By default is false. This value only works for hadoop implementation, it will produce a raster load to load the outcome to HDFS.
Data type of the pixels of the output. Valid values are: 1 - Byte, 2 - Unsigned Int 16 Bits, 3 - Int 16 Bits, 4 - Unsigned Int 32 Bits, 5 - Int 32 Bits, 6 - Float 32 Bits, 7 - Float 64 Bits.
A string with an array of entry objects with that have the full name of the class as key and parameters as value (separated by commas). The full class names of the custom user implementations could be from the custom jar upload by the user or available in the Oracle raster api.
{
"type":"object",
"properties":{
"srid":{
"type":"number",
"description":"Output SRID of the raster process. Must be a number.",
"example":26904
},
"outputSystem":{
"type":"boolean",
"description":"Indicates that the output will be HDFS or not. If you indicate another value different from true, default value will be used. By default is false. This value only works for hadoop implementation, it will produce a raster load to load the outcome to HDFS.",
"example":false
},
"outputFolder":{
"type":"string",
"description":"\"Output folder of the result. It could be a HDFS path or a normal filesystem path. If you choose output to HDFS you can not use ':' due a HDFS filesystem restrictions, all the invalid chars for paths apply for this value. The server could add the NFS mount point to save the result in HDFS.\"",
"example":"/scratch/swap"
},
"filename":{
"type":"string",
"description":"Output file name. You must avoid invalid filenames following normal the rules that apply to file names in all systems.",
"example":"defaultMosaic"
},
"outputFormat":{
"type":"string",
"description":"Supported output format. You could check the supported formats using the gdal formats service including the format restrictions.",
"example":"GTIFF"
},
"pixelType":{
"type":"number",
"description":"Data type of the pixels of the output. Valid values are: 1 - Byte, 2 - Unsigned Int 16 Bits, 3 - Int 16 Bits, 4 - Unsigned Int 32 Bits, 5 - Int 32 Bits, 6 - Float 32 Bits, 7 - Float 64 Bits.",
"example":1
},
"bands":{
"type":"number",
"description":"Bands number of the output. Some formats only admit certain bands number.",
"example":3
},
"width":{
"type":"number",
"description":"Width of the result.",
"example":3200
},
"height":{
"type":"number",
"description":"Height of the result.",
"example":2068
},
"algorithm":{
"type":"number",
"description":"Algorithm used to process multiple files to produce a result: 1 - Last Modified, 2 - Size, 3 - Resolution. Default value is 1.",
"example":1
},
"algorithmDescendent":{
"type":"boolean",
"description":"Indicates if the algorithm to process multiple files will be apply in ascedent or descendent order. If you specify another value different to true it will take the value of false by default.",
"example":true
},
"geoX":{
"type":"number",
"description":"This is the upper left X point in the MBR defined for raster output.",
"example":735199.991159022
},
"geoWidth":{
"type":"number",
"description":"Pixel Width for raster output (Pixel X size).",
"example":26.018635967483096
},
"geoRotationX":{
"type":"number",
"description":"Geo rotation x. Not supported yet.",
"example":0
},
"geoY":{
"type":"number",
"description":"This is the upper left Y point in the MBR defined for raster output.",
"example":2329795.373044142
},
"geoHeight":{
"type":"number",
"description":"Pixel Height for raster output (Pixel Y size).",
"example":-26.018635967483096
},
"geoRotationY":{
"type":"number",
"description":"Geo rotation y. Not supported yet.",
"example":0
},
"processType":{
"type":"number",
"description":"Raster process type value, could be 0 for single raster processing, 1 for multiple rasters with same mbr or 2 for a normal mosaic.",
"example":0
},
"catalog":{
"type":"string",
"description":"XML value string with the details of the source files involved in the process.",
"example":"<?xml version='1.0'?><catalog type='HDFS'><image><source>Hadoop File System</source><type>HDFS</type><raster>/user/hdfs/upload/maui.tif.ohif</raster><url>http://system3.example.com:8080/spatialviewer/files/spatialworkspace/raster/thumbs/88f1f12fff7316308d22d69b8a7102f7217d3a28_thumb.jpg?time=1532973102684</url><bands datatype='1' config='1,2,3'>3</bands></image></catalog>"
},
"dfsBlockSize":{
"type":"number",
"description":"HDFS block size in megabytes, determines the size of the tiles created when loading a raster in HDFS. It is only required when you choose output to HDFS. This value will only be read when you choose the hadoop implementation, when the selected format allows the output to HDFS and if you choose HDFS as the output file system.",
"example":128
},
"noData":{
"type":"string",
"description":"Hexadecimal value to fill the pixels with no data, # will be add in the server if not provided. Also this value must be accord to the selected pixel type of the output. If you do not provide this value a value with 0's will be used. If you do not provide the full value the value will be fill with 0's. The value have relation with the data type, value length must be two.",
"example":0
},
"customJarName":{
"type":"string",
"description":"Name of the jar used to include custom user processing during the raster process operation.",
"example":"external-analysis.jar"
},
"processClasses":{
"type":"string",
"description":"A string with an array of entry objects with that have the full name of the class as key and parameters as value (separated by commas). The full class names of the custom user implementations could be from the custom jar upload by the user or available in the Oracle raster api.",
"example":"[{\"oracle.spatial.raster.HillShade\": \"1,2,3\"}]"
},
"driverMemoryMB":{
"type":"number",
"description":"Value used to reserve memory for the driver in megabytes. If you send this value for a hadoop process it will be ignored.",
"example":2048
},
"executorsMemoryMB":{
"type":"number",
"description":"Value used to reserve memory for the executors in megabytes. If you send this value for a hadoop process it will be ignored.",
"example":1024
},
"multipleOperations":{
"type":"string",
"description":"String that contains an array with the objects that describe the details of the operations to add to the raster.",
"example":"[{\"name\":\"Local Not\",\"id\":\"localNot\",\"params\":null}]"
}
},
"required":[
"srid",
"outputFolder",
"filename",
"pixelType",
"bands",
"outputSystem",
"width",
"height",
"algorithm",
"algorithmDescendent",
"geoX",
"geoWidth",
"geoY",
"geoHeight",
"processType",
"catalog"
]
}
{
"type":"object",
"properties":{
"status":{
"type":"string",
"description":"success or error",
"example":"sucess"
},
"title":{
"type":"string",
"description":"Response description",
"example":"Succcess Response."
},
"o:successCode":{
"type":"string",
"description":"Success code.",
"example":"SVR-00210"
},
"response":{
"type":"object",
"description":"Object with the result details",
"properties":{
"url_thumbnail":{
"type":"string",
"description":"URL of the generated thumbnail file which can be used to visualize the result in a web browser.",
"example":"http://system3.example.com:8080/spatialviewer/files/spatialworkspace/raster/thumbs/41ae77fe360a3d5f4c418a9a21c678e22635f110_thumb.jpg"
},
"url_original":{
"type":"string",
"description":"URL of the original result.",
"example":"http://system3.example.com:8080/spatialviewer/files/spatialworkspace/raster/temp/defaultMosaic.tif"
},
"message":{
"type":"string",
"description":"Informative message about the success response.",
"example":"Raster process finished succesfully"
}
}
}
}
}
{
"type":"object",
"description":"Object with the result details",
"properties":{
"url_thumbnail":{
"type":"string",
"description":"URL of the generated thumbnail file which can be used to visualize the result in a web browser.",
"example":"http://system3.example.com:8080/spatialviewer/files/spatialworkspace/raster/thumbs/41ae77fe360a3d5f4c418a9a21c678e22635f110_thumb.jpg"
},
"url_original":{
"type":"string",
"description":"URL of the original result.",
"example":"http://system3.example.com:8080/spatialviewer/files/spatialworkspace/raster/temp/defaultMosaic.tif"
},
"message":{
"type":"string",
"description":"Informative message about the success response.",
"example":"Raster process finished succesfully"
}
}
}
{
"type":"object",
"properties":{
"status":{
"type":"string",
"description":"success or error",
"example":"error"
},
"title":{
"type":"string",
"description":"Response description",
"example":"Invalid parameters."
},
"o:errorCode":{
"type":"string",
"description":"Error code.",
"example":"SVR-E0010"
},
"detail":{
"type":"string",
"description":"Response details information message about the bad parameters",
"example":"newDiretory: New Directory name can not be null, overlap: Overlap value can not be null"
}
}
}
{
"type":"object",
"properties":{
"status":{
"type":"string",
"description":"success or error",
"example":"error"
},
"title":{
"type":"string",
"description":"Response description",
"example":"GDAL library is not correctly set up."
},
"o:errorCode":{
"type":"string",
"description":"Error code.",
"example":"SVR-E0012"
},
"detail":{
"type":"string",
"description":"Informative message",
"example":"GDAL library is not correctly set up. Check the admin settings or your GDAL installation"
}
}
}
Schedules a raster process job using hadoop to process the raster(s) files into hdfs and produce an output.
The following example shows how to submit a raster process using hadoop as implementation by submitting a POST request on the REST resource using cURL.