Merge pull request #253 from thewtex/axis-anatomical-orientation

RFC-4: Axis Anatomical Orientation

rfc/4/.gitattributes

@@ -0,0 +1,2 @@
+# GitHub syntax highlighting
+pixi.lock linguist-language=YAML linguist-generated=true

rfc/4/.gitignore

@@ -0,0 +1,7 @@
+# pixi environments
+.pixi
+*.egg-info
+
+markdown/types
+markdown/index.md
+orientation.py

rfc/4/comments/index.md

@@ -0,0 +1,9 @@
+# Comments
+
+Additional comments of RFC-4:
+
+```{toctree}
+:maxdepth: 1
+:glob:
+*/index
+```

rfc/4/markdown/Orientation.md

@@ -0,0 +1,26 @@
+---
+orphan: true
+---
+
+# Enum: Orientation
+
+Anatomical orientation refers to the specific arrangement and directional alignment of anatomical structures within an imaging dataset. It is crucial for ensuring accurate alignment and comparison of images to anatomical atlases, facilitating consistent analysis and interpretation of biological data.
+
+URI: [ngff:Orientation](https://w3id.org/ome/ngff/Orientation)
+
+
+## Permissible Values
+
+| Text | Description | Meaning | Other Information |
+| :--- | :---: | :---: | ---: |
+| left-to-right | Describes the directional orientation from the left side to the right side of an anatomical structure or body. |  |  |
+| right-to-left | Describes the directional orientation from the right side to the left side of an anatomical structure or body. |  |  |
+| anterior-to-posterior | Describes the directional orientation from the front (anterior) to the back (posterior) of an anatomical structure or body. |  |  |
+| posterior-to-anterior | Describes the directional orientation from the back (posterior) to the front (anterior) of an anatomical structure or body. |  |  |
+| inferior-to-superior | Describes the directional orientation from the lower (inferior) to the upper (superior) part of an anatomical structure or body. |  |  |
+| superior-to-inferior | Describes the directional orientation from the upper (superior) to the lower (inferior) part of an anatomical structure or body. |  |  |
+| dorsal-to-ventral | Describes the directional orientation from the back (dorsal) to the front (ventral) of an anatomical structure or body. |  |  |
+| ventral-to-dorsal | Describes the directional orientation from the front (ventral) to the back (dorsal) of an anatomical structure or body. |  |  |
+| rostral-to-caudal | Describes the directional orientation from the front (rostral) to the back (caudal) end of an anatomical structure, typically used in reference to the central nervous system. |  |  |
+| caudal-to-rostral | Describes the directional orientation from the back (caudal) to the front (rostral) end of an anatomical structure, typically used in reference to the central nervous system. |  |  |
+

rfc/4/orientation.schema.json

@@ -0,0 +1,28 @@
+{
+    "$defs": {
+        "Orientation": {
+            "description": "Anatomical orientation refers to the specific arrangement and directional alignment of anatomical structures within an imaging dataset. It is crucial for ensuring accurate alignment and comparison of images to anatomical atlases, facilitating consistent analysis and interpretation of biological data.",
+            "enum": [
+                "left-to-right",
+                "right-to-left",
+                "anterior-to-posterior",
+                "posterior-to-anterior",
+                "inferior-to-superior",
+                "superior-to-inferior",
+                "dorsal-to-ventral",
+                "ventral-to-dorsal",
+                "rostral-to-caudal",
+                "caudal-to-rostral"
+            ],
+            "title": "Orientation",
+            "type": "string"
+        }
+    },
+    "$id": "https://w3id.org/ome/ngff",
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "additionalProperties": true,
+    "metamodel_version": "1.7.0",
+    "title": "orientation",
+    "type": "object",
+    "version": "0.1.0"
+}

rfc/4/orientation.ts

@@ -0,0 +1,29 @@
+/**
+* Anatomical orientation refers to the specific arrangement and directional alignment of anatomical structures within an imaging dataset. It is crucial for ensuring accurate alignment and comparison of images to anatomical atlases, facilitating consistent analysis and interpretation of biological data.
+*/
+export enum Orientation {
+
+    /** Describes the directional orientation from the left side to the right side of an anatomical structure or body. */
+    left_to_right = "left-to-right",
+    /** Describes the directional orientation from the right side to the left side of an anatomical structure or body. */
+    right_to_left = "right-to-left",
+    /** Describes the directional orientation from the front (anterior) to the back (posterior) of an anatomical structure or body. */
+    anterior_to_posterior = "anterior-to-posterior",
+    /** Describes the directional orientation from the back (posterior) to the front (anterior) of an anatomical structure or body. */
+    posterior_to_anterior = "posterior-to-anterior",
+    /** Describes the directional orientation from the lower (inferior) to the upper (superior) part of an anatomical structure or body. */
+    inferior_to_superior = "inferior-to-superior",
+    /** Describes the directional orientation from the upper (superior) to the lower (inferior) part of an anatomical structure or body. */
+    superior_to_inferior = "superior-to-inferior",
+    /** Describes the directional orientation from the back (dorsal) to the front (ventral) of an anatomical structure or body. */
+    dorsal_to_ventral = "dorsal-to-ventral",
+    /** Describes the directional orientation from the front (ventral) to the back (dorsal) of an anatomical structure or body. */
+    ventral_to_dorsal = "ventral-to-dorsal",
+    /** Describes the directional orientation from the front (rostral) to the back (caudal) end of an anatomical structure, typically used in reference to the central nervous system. */
+    rostral_to_caudal = "rostral-to-caudal",
+    /** Describes the directional orientation from the back (caudal) to the front (rostral) end of an anatomical structure, typically used in reference to the central nervous system. */
+    caudal_to_rostral = "caudal-to-rostral",
+};
+
+
+

rfc/4/orientation.yml

@@ -0,0 +1,31 @@
+id: https://w3id.org/ome/ngff
+name: orientation
+version: 0.1.0
+description: >-
+  The orientation field provides explicit metadata about the anatomical orientation in an image using a
+  controlled vocabulary. The goal is to preserve essential biological information and eliminate assumptions
+  about orientation which can lead to errors in downstream analysis and alignment to anatomical atlases.
+prefixes:
+  ome: https://w3id.org/ome/
+  ngff: https://w3id.org/ome/ngff/
+  linkml: https://w3id.org/linkml/
+imports:
+  - linkml:types
+default_range: string
+default_prefix: ngff
+
+enums:
+  Orientation:
+    description: >-
+      Anatomical orientation refers to the specific arrangement and directional alignment of anatomical structures within an imaging dataset. It is crucial for ensuring accurate alignment and comparison of images to anatomical atlases, facilitating consistent analysis and interpretation of biological data.
+    permissible_values:
+      left-to-right: Describes the directional orientation from the left side to the right side of an anatomical structure or body.
+      right-to-left: Describes the directional orientation from the right side to the left side of an anatomical structure or body.
+      anterior-to-posterior: Describes the directional orientation from the front (anterior) to the back (posterior) of an anatomical structure or body.
+      posterior-to-anterior: Describes the directional orientation from the back (posterior) to the front (anterior) of an anatomical structure or body.
+      inferior-to-superior: Describes the directional orientation from the lower (inferior) to the upper (superior) part of an anatomical structure or body.
+      superior-to-inferior: Describes the directional orientation from the upper (superior) to the lower (inferior) part of an anatomical structure or body.
+      dorsal-to-ventral: Describes the directional orientation from the back (dorsal) to the front (ventral) of an anatomical structure or body.
+      ventral-to-dorsal: Describes the directional orientation from the front (ventral) to the back (dorsal) of an anatomical structure or body.
+      rostral-to-caudal: Describes the directional orientation from the front (rostral) to the back (caudal) end of an anatomical structure, typically used in reference to the central nervous system.
+      caudal-to-rostral: Describes the directional orientation from the back (caudal) to the front (rostral) end of an anatomical structure, typically used in reference to the central nervous system.