Changes for page kg-spatial-search

Last modified by oschmid on 2023/08/22 11:23
From version 7.1
edited by oschmid
on 2023/08/18 14:15
Change comment: There is no comment for this version
To version 7.3
edited by oschmid
on 2023/08/22 09:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,9 +2,9 @@
2 2  (((
3 3  (% class="container" %)
4 4  (((
5 -= My Collab's Extended Title =
5 += KG Spatial Search =
6 6  
7 -My collab's subtitle
7 +A how-to guide to use the spatial search extension of the EBRAINS KG
8 8  )))
9 9  )))
10 10  
... ... @@ -12,15 +12,30 @@
12 12  (((
13 13  (% class="col-xs-12 col-sm-8" %)
14 14  (((
15 -= What can I find here? =
15 += What is KG Spatial Search? =
16 16  
17 -* Notice how the table of contents on the right
18 -* is automatically updated
19 -* to hold this page's headers
17 +The Spatial Search extension is an additional index which allows to search for registered datasets in the KG by spatial search - meaning that it is possible to find datasets based on their locality in the 3-dimensional space by geometries.
20 20  
21 -= Who has access? =
19 += Why is there an additional API to the KG Query API? =
22 22  
23 -Describe the audience of this collab.
21 +Although in a first version, it was attempted to directly integrate the spatial search query capabilities into the KG Query API, this approach has turned out to not be ideal. The reasons for this is the increased complexity introduced into the Query API for a very specific use-case covering the needs for a small subset of the standard users who query the KG. This is why it was decided to provide the functionality as an extension instead allowing to query the ids of the datasets through the spatial search and subsequently ask the KG for the semantic meta information.
22 +
23 += What data is registered in the spatial search? =
24 +
25 +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. Please also note that currently only datasets can be registered for which the spatial location information is regarded to be non-sensitive from a GDPR perspective.
26 +
27 += How do I query the KG Spatial Search? =
28 +
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 +
31 +
32 +
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.
35 +
36 +
37 +
38 +
24 24  )))
25 25  
26 26