Created directories for new SLAM schema

hed-standard · Jul 29, 2024 · f69e254 · f69e254
1 parent 27acfc1
commit f69e254
Show file tree

Hide file tree

Showing 10 changed files with 569 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -29,12 +29,13 @@ All released and prereleased versions of the HED schemas can be viewed the [**HE
 
 The following table summarizes the current versions of the HED schemas.
 
-| Schema                                 | Latest<br/>version | Description                                                                                                                                                         | Prerelease<br/>version | DOI  |
-|----------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| ---- |
-| [**standard**](./standard_schema)      | 8.3.0              | Basic vocabulary for annotating data.                                                                                                                               | 8.4.0                  | 10.5281/zenodo.7876037 |
-| [**score**](library_schemas/score)     | 1.2.0              | SCORE standard vocabulary for <br/>clinical neurological annotation<br/>(See [**Score docs**](https://hed-schemas.readthedocs.io/en/latest/hed_score_schema.html).) | 2.0.0                  | 10.5281/zenodo.7897596  |
-| [**lang**](library_schemas/lang)       |                    | LANG linguistic stimuli annotation vocabulary.                                                                                                                      | 1.0.0                  |  |
-| [**testlib**](library_schemas/testlib) | 3.0.0              | A copy of the HED standard vocabulary<br/> for testing. <br/> (May not be stable.)                                                                                  | 4.0.0                  |  |
+| Schema                                 | Latest<br/>version | Description       | Prerelease<br/>version | DOI  |
+|----------------------------------------|--------------------|------|------------------------| ---- |
+| [**standard**](./standard_schema)      | 8.3.0              | Basic vocabulary for annotating data.       | 8.4.0                  | 10.5281/zenodo.7876037 |
+| [**score**](library_schemas/score)     | 1.2.0              | SCORE standard vocabulary for <br/>clinical neurological annotation<br/>(See [**Score docs**](https://hed-schemas.readthedocs.io/en/latest/hed_score_schema.html).) | 2.0.0     | 10.5281/zenodo.7897596  |
+| [**lang**](library_schemas/lang)       |                    | LANG linguistic stimuli annotation vocabulary.                                               | 1.0.0                  |  |
+| [**slam**](library_schemas/slam) |  | SLAM (Sensor Location and Motion) | 1.0.0 | |  
+| [**testlib**](library_schemas/testlib) | 3.0.0              | A copy of the HED standard vocabulary<br/> for testing. <br/> (May not be stable.)    | 4.0.0                  |  |
 
 ## HED formats
 HED schemas are stored in three different formats:

diff --git a/library_data.json b/library_data.json
@@ -7,5 +7,8 @@
     },
     "lang": {
       "id_range":[60000, 79999]
+    },
+    "slam": {
+      "id_range":[80000, 99999]
     }
 }
diff --git a/library_schemas/slam/CONTRIBUTORS.md b/library_schemas/slam/CONTRIBUTORS.md
@@ -0,0 +1,19 @@
+# Contributors to the HED-SLAM effort:
+
+Sein Jeung (@sjeung)
+Scott Makeig (@smakieg)
+Kay Robbins (@VisLab)
+Seyed (Yahya) Shirazi (@neuromechanist)
+Julius Welzel (@jwelzel)
+
+# Contact person
+Seyed (Yahya) Shirazi (@neuromechanist)
+
+**If you have contributed** to the HED SLAM schema effort please submit PR from a
+branch called `contributing-slam` in your forked repository adding your name to this list in alphabetical order.
+Alternatively, post an issue to this repository with the tag `[CONTRIBUTOR-SLAM]`.
+
+
+
+
+
diff --git a/library_schemas/slam/LICENSE b/library_schemas/slam/LICENSE
diff --git a/library_schemas/slam/README.md b/library_schemas/slam/README.md
@@ -0,0 +1,12 @@
+# HED SLAM Schema
+
+The SLAM (Sensor Location and Motion) schema is an extension of the Hierarchical Event Descriptors (HED) base schema,
+designed to standardize the annotation of sensor locations and human motion across recording modalities
+and diverse fields such as biomechanics, kinesiology, human-machine interaction, physical therapy,
+and mobile brain/body imaging. By providing a unified vocabulary for describing anatomical landmarks,
+sensor placements, and movement-related metrics, SLAM aims to facilitate data sharing,
+improve cross-study comparability, and enhance result interpretation across different experimental
+setups and research domains.
+
+This standardization will foster interdisciplinary collaboration and advance our understanding of
+human motion and its measurement.
diff --git a/library_schemas/slam/hedxml/HED8.0.0.xsd b/library_schemas/slam/hedxml/HED8.0.0.xsd
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="HED" type="HEDType"/>
+  <xs:complexType name="attributeType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="value" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="nodeType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="attributeType" name="attribute" maxOccurs="unbounded" minOccurs="0"/>
+      <xs:element type="nodeType" name="node" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="schemaType">
+    <xs:sequence>
+      <xs:element type="nodeType" name="node" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="unitType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="attributeType" name="attribute" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="unitClassDefinitionType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="attributeType" name="attribute" maxOccurs="unbounded" minOccurs="0"/>
+      <xs:element type="unitType" name="unit" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="unitClassDefinitionsType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="unitClassDefinitionType" name="unitClassDefinition" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="unitModifierDefinitionType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="attributeType" name="attribute" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="unitModifierDefinitionsType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="unitModifierDefinitionType" name="unitModifierDefinition" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+    <xs:complexType name="valueClassDefinitionType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="attributeType" name="attribute" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="valueClassDefinitionsType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="valueClassDefinitionType" name="valueClassDefinition" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="propertyType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="schemaAttributeDefinitionType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+      <xs:element type="propertyType" name="property" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="schemaAttributeDefinitionsType">
+    <xs:sequence>
+      <xs:element type="schemaAttributeDefinitionType" name="schemaAttributeDefinition" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="propertyDefinitionType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="name"/>
+      <xs:element type="xs:string" name="description" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="propertyDefinitionsType">
+    <xs:sequence>
+      <xs:element type="propertyDefinitionType" name="propertyDefinition" maxOccurs="unbounded" minOccurs="0"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:complexType name="HEDType">
+    <xs:sequence>
+      <xs:element type="xs:string" name="prologue" maxOccurs="1" minOccurs="0"/>
+      <xs:element type="schemaType" name="schema" maxOccurs="1" minOccurs="1"/>
+      <xs:element type="unitClassDefinitionsType" name="unitClassDefinitions" maxOccurs="1" minOccurs="1" />
+      <xs:element type="unitModifierDefinitionsType" name="unitModifierDefinitions" maxOccurs="1" minOccurs="1" />
+	  <xs:element type="valueClassDefinitionsType" name="valueClassDefinitions" maxOccurs="1" minOccurs="1" />
+      <xs:element type="schemaAttributeDefinitionsType" name="schemaAttributeDefinitions" maxOccurs="1" minOccurs="1" />
+      <xs:element type="propertyDefinitionsType" name="propertyDefinitions" maxOccurs="1" minOccurs="1"/>
+      <xs:element type="xs:string" name="epilogue" maxOccurs="1" minOccurs="0"/>
+    </xs:sequence>
+    <xs:attribute type="xs:string" name="version"/>
+  </xs:complexType>
+</xs:schema>
diff --git a/...hemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_AnnotationPropertyExternal.tsv b/...hemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_AnnotationPropertyExternal.tsv
@@ -0,0 +1,16 @@
+Prefix	ID
+dc:	contributor
+dc:	creator
+dc:	date
+dc:	description
+dc:	format
+dc:	identifier
+dc:	language
+dc:	publisher
+dc:	relation
+dc:	source
+dc:	subject
+dc:	title
+dc:	type
+foaf:	homepage
+terms:	license
diff --git a/library_schemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_Prefixes.tsv b/library_schemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_Prefixes.tsv
@@ -0,0 +1,10 @@
+prefix	namespace IRI	definition
+rdf:	http://www.w3.org/1999/02/22-rdf-syntax-ns#	The RDF namespace [RDF-CONCEPTS]
+rdfs:	http://www.w3.org/2000/01/rdf-schema#	
+xsd:	http://www.w3.org/2000/10/XMLSchema#	XML Schema Namespace [XMLSCHEMA11-2]
+xml:	http://www.w3.org/XML/1998/namespace	
+owl:	http://www.w3.org/2002/07/owl#	The OWL namespace [OWL2-OVERVIEW]
+prov:	http://www.w3.org/ns/prov#	The PROV namespace [PROV-DM]
+dc:	http://purl.org/dc/elements/1.1/	The Dublin Core elements
+terms:	http://purl.org/dc/terms/	The Dublin Core terms
+foaf:	http://xmlns.com/foaf/0.1/	Friend-of-a-Friend http://xmlns.com/foaf/spec/
diff --git a/library_schemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_Structure.tsv b/library_schemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_Structure.tsv
@@ -0,0 +1,4 @@
+hedId	rdfs:label	Attributes	omn:SubClassOf	dc:description	omn:EquivalentTo
+HED_0080010	SlamHeader	version="1.0.0", library="slam", withStandard="8.3.0", unmerged="True"	HedHeader		HedHeader and (inHedSchema some SlamSchema) and (version value "1.0.0") and (library value "slam") and (withStandard value "8.3.0") and (unmerged value "True")
+HED_0080011	SlamPrologue		HedPrologue	The HED SLAM(Sensor Location and Motion) HED library schema is designed to standardize the annotation of sensor locations and human motion across recording modalities and diverse fields. 	HedPrologue and (inHedSchema some ScoreSchema)
+HED_0080012	SlamEpilogue		HedEpilogue SLAM epilogue is here. 	HedEpilogue and (inHedSchema some ScoreSchema)
diff --git a/library_schemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_Tag.tsv b/library_schemas/slam/prerelease/hedtsv/HED_slam_1.0.0/HED_slam_1.0.0_Tag.tsv
@@ -0,0 +1,2 @@
+hedId	rdfs:label	Level	omn:SubClassOf	Attributes	dc:description	omn:EquivalentTo	Annotations
+	Body-landmark	0	Anatomical-item	rooted=Anatomical-item	A place on a body.		dc:source "Original", rdfs:comment "Body landmarks are used to standardize sensor placement."