Changes for page kg-spatial-search

Last modified by oschmid on 2023/08/22 11:23

From version 7.3
edited by oschmid
on 2023/08/22 09:01
Change comment: There is no comment for this version
To version 11.1
edited by oschmid
on 2023/08/22 09:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -28,13 +28,45 @@
28 28  
29 29  Simply use the API endpoint at [[https:~~/~~/spatial.kg.ebrains.eu/api/>>https://spatial.kg.ebrains.eu/api/]] by running queries according to the following examples:
30 30  
31 +== Get started: Query by a "bounding box" (hyperrectangle) ==
31 31  
33 +{{code language="bash" layout="LINENUMBERS"}}
34 +curl -X 'POST' \
35 + 'https://spatial.kg.ebrains.eu/spatial-search/cores/ebrains/spatial_objects' \
36 + -H 'accept: application/json' \
37 + -H 'Content-Type: application/json' \
38 + -d '{
39 + "filters": "inside(hyperrectangle{[50.0,146.0,227.0], [51.0, 149.0, 228.0], \"AMB-CCF_v3-RAS\"})"
40 +}'
41 +{{/code}}
32 32  
43 +As you can see, you're sending a POST request to the endpoint at **https:~/~/spatial.kg.ebrains.eu/spatial-search/cores/ebrains/spatial_objects  **with a payload defining a geometry of interest. In this case, we're looking for all objects that are **inside **a **hyperrectangle **defined by its lowest and highest point in the coordinate system of the coordinate space **AMB-CCF_v3-RAS**. This query will return you an array of ids of the objects located within the geometry which you then can use to conveniently query the KG either through the [[Instance API>>https://core.kg.ebrains.eu/swagger-ui/index.html#/2%20Advanced/getInstancesByIds]] or the [[Query API>>https://core.kg.ebrains.eu/swagger-ui/index.html#/1%20Basic/runDynamicQuery]] to access detailed meta information.
33 33  
34 -Theoretically, all data which is anchored in their respective coordinate space can be registered in the KG Spatial Search. We currently provide ingestion pipelines for data annotated with the[[ locareJSON format>>https://github.com/blixilla/LocareJSON]]. Please note that complex, planar and volumetric geometries such as polyhedrons, spheres, etc. are translated into point clouds of a configurable density during the ingestion process to ensure better performance at query time for the cost for potential false-negatives in highly fine-granular queries.
45 +== Query by hypersphere ==
35 35  
47 +Alongside the possibility to use hyperrectangles for querying the spatial search, you can also use hyperspheres:
36 36  
49 +{{code language="javascript" layout="LINENUMBERS"}}
50 +{
51 + "filters": "inside(hypersphere{[50.0,146.0,227.0], 2, \"AMB-CCF_v3-RAS\"})"
52 +}
53 +{{/code}}
37 37  
55 +It is defined by the center of the sphere with its coordinates, the radius in coordinate units and the coordinate space of the given coordinates (in this case again AMB-CCF_v3-RAS)
56 +
57 +== Advanced use: Union geometries for complex queries ==
58 +
59 +To build arbitrarily complex geometries, it is possible to combine hyperrectangles and hyperspheres via (nested) unions:
60 +
61 +{{code language="javascript" layout="LINENUMBERS"}}
62 +{
63 + "filters": "union(union(inside(hyperrectangle{[50.0,146.0,227.0], [51.0, 149.0, 228.0], \"AMB-CCF_v3-RAS\"}), inside(hyperrectangle{[120.0,146.0,227.0], [150.0, 180.0, 300.0], \"AMB-CCF_v3-RAS\"})),inside(hypersphere{[50.0,146.0,227.0], 2, \"AMB-CCF_v3-RAS\"}))"
64 +}
65 +{{/code}}
66 +
67 +
68 +
69 +
38 38  
39 39  )))
40 40