Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
540009c
RFC-4: Bump linkml to 1.9.2
thewtex Jul 8, 2025
b9a7cb3
RFC 4: Models updates based on feedback
melonora Jul 8, 2025
24f3052
RFC-4: Fix LinkML errors
thewtex Jul 8, 2025
82e239c
RFC-4: LinkML gen updates
thewtex Jul 8, 2025
b00b62d
RFC-4: Add back dropped orientation values
thewtex Jul 16, 2025
6ec5e36
RFC-4: Add David Feng's ORCID
thewtex Jul 16, 2025
23a8fc4
RFC-4: orientation.yml dos2unix
thewtex Jul 16, 2025
183ab43
RFC-4: Add Orientation base class
melonora Jul 16, 2025
535e661
RFC-4: Remove constraints on orientation name, type slots
melonora Jul 16, 2025
9ceadb8
RFC-4: Add Wouter-Michiel Vierdag to authors
thewtex Jul 17, 2025
1a95957
RFC-4: Add changelog entry
thewtex Jul 17, 2025
5306806
RFC-4: Clarify that anatomical orientation only applies to spatial axes
thewtex Jul 17, 2025
8bdae91
RFC-4: anatomicalOrientation -> orientation, remove default, RFC-5 re…
thewtex Jul 17, 2025
18dd65e
RFC-4: Add initial response documentation
thewtex Jul 17, 2025
c4c8a31
RFC-4: Use RAS in example
thewtex Jul 28, 2025
6c4112f
RFC-4: Note possibly future type constraints on Axis
thewtex Jul 28, 2025
b6fd98a
RFC-4: Remove trailing whitespace from orientation.yml
thewtex Jul 28, 2025
381733f
RFC-4: Add Pydantic orientation.py
thewtex Jul 29, 2025
3315074
RFC-4: Add markdown orientation type and value
thewtex Jul 29, 2025
c3883c5
RFC-4: Note discussion at the 2024 Zurich hackathon
thewtex Jul 30, 2025
847e6e7
RFC-4: Provide guidance on terms for bipeds and quadrupeds
thewtex Jul 31, 2025
a5947e6
Fix minor cross-links
joshmoore Aug 5, 2025
60be816
Update validation jobs
joshmoore Aug 5, 2025
cb14fb9
Small other warnings
joshmoore Aug 5, 2025
07ae70b
Merge branch 'main' into rfc-4-updates
thewtex Aug 5, 2025
0d68c8b
List all markdowns in RFC-4 as orphan
joshmoore Aug 6, 2025
4d43dd5
Remove unused markdown/index
joshmoore Aug 6, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion rfc/4/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@

markdown/types
markdown/index.md
orientation.py
218 changes: 147 additions & 71 deletions rfc/4/index.md

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions rfc/4/markdown/AnatomicalOrientation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
orphan: true
---

# Class: AnatomicalOrientation

URI: [ngff:AnatomicalOrientation](https://w3id.org/ome/ngff/AnatomicalOrientation)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Orientation],[Orientation]^-[AnatomicalOrientation|type(i):string;value(i):string])](https://yuml.me/diagram/nofunky;dir:TB/class/[Orientation],[Orientation]^-[AnatomicalOrientation|type(i):string;value(i):string])

## Parents

* is_a: [Orientation](Orientation.md)

## Attributes


### Inherited from Orientation:

* [➞type](orientation__type.md) <sub>1..1</sub>
* Range: [String](types/String.md)
* [➞value](orientation__value.md) <sub>1..1</sub>
* Range: [String](types/String.md)
34 changes: 34 additions & 0 deletions rfc/4/markdown/AnatomicalOrientationValues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
orphan: true
---

# Enum: AnatomicalOrientationValues

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:AnatomicalOrientationValues](https://w3id.org/ome/ngff/AnatomicalOrientationValues)


## Permissible Values

| Text | Description | Meaning | Other Information |
| :--- | :---: | :---: | ---: |
| left-to-right | Describes the directional orientation from the left side to the right lateral side of an anatomical structure or body. | | |
| right-to-left | Describes the directional orientation from the right side to the left lateral 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 below (inferior) to above (superior) in an anatomical structure or body. | | |
| superior-to-inferior | Describes the directional orientation from above (superior) to below (inferior) in an anatomical structure or body. | | |
| dorsal-to-ventral | Describes the directional orientation from the top/upper (dorsal) to the belly/lower (ventral) in an anatomical structure or body. | | |
| ventral-to-dorsal | Describes the directional orientation from the belly/lower (ventral) to the top/upper (dorsal) in an anatomical structure or body. | | |
| dorsal-to-palmar | Describes the directional orientation from the top/upper (dorsal) to the palm of the hand (palmar) in a body. | | |
| palmar-to-dorsal | Describes the directional orientation from the palm of the hand (palmar) to the top/upper (dorsal) in a body. | | |
| dorsal-to-plantar | Describes the directional orientation from the top/upper (dorsal) to the sole of the foot (plantar) in a body. | | |
| plantar-to-dorsal | Describes the directional orientation from the sole of the foot (plantar) to the top/upper (dorsal) in a body. | | |
| rostral-to-caudal | Describes the directional orientation from the nasal (rostral) to the tail (caudal) end of an anatomical structure, typically used in reference to the central nervous system. | | |
| caudal-to-rostral | Describes the directional orientation from the tail (caudal) to the nasal (rostral) end of an anatomical structure, typically used in reference to the central nervous system. | | |
| cranial-to-caudal | Describes the directional orientation from the head (cranial) to the tail (caudal) end of an anatomical structure or body. | | |
| caudal-to-cranial | Describes the directional orientation from the tail (caudal) to the head (cranial) end of an anatomical structure or body. | | |
| proximal-to-distal | Describes the directional orientation from the center of the body to the periphery of an anatomical structure or limb. | | |
| distal-to-proximal | Describes the directional orientation from the periphery of an anatomical structure or limb to the center of the body. | | |

22 changes: 22 additions & 0 deletions rfc/4/markdown/Axes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
orphan: true
---

# Class: Axes



URI: [ngff:Axes](https://w3id.org/ome/ngff/Axes)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Axes&#124;axes:string%20*])](https://yuml.me/diagram/nofunky;dir:TB/class/[Axes&#124;axes:string%20*])

## Attributes


### Own

* [➞axes](axes__axes.md) <sub>0..\*</sub>
* Description: A list of axes. Although serialized as list, it MUST be dealt with as being a set as in the name of each axis MUST be unique. Furthermore, if the attribute orientation is defined for one axis of type space, it MUST be defined for all the axes of type space. In this case, the type of each orientation MUST be the same and the value MUST be unique.

* Range: [String](types/String.md)
21 changes: 21 additions & 0 deletions rfc/4/markdown/AxesNames.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
orphan: true
---

# Enum: AxesNames



URI: [ngff:AxesNames](https://w3id.org/ome/ngff/AxesNames)


## Permissible Values

| Text | Description | Meaning | Other Information |
| :--- | :---: | :---: | ---: |
| t | Axis name relating to the time axis. | | |
| c | Axis name relating to the channel axis. | | |
| z | Axis name relating to the z or depth axis. | | |
| y | Axis relating to the y or height axis. | | |
| x | Axis relating to the x or width axis. | | |

31 changes: 31 additions & 0 deletions rfc/4/markdown/Axis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
orphan: true
---

# Class: Axis



URI: [ngff:Axis](https://w3id.org/ome/ngff/Axis)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[TimeAxis],[SpaceAxis],[ChannelAxis],[Axis&#124;name:AxesNames;type:AxisType]^-[TimeAxis],[Axis]^-[SpaceAxis],[Axis]^-[ChannelAxis])](https://yuml.me/diagram/nofunky;dir:TB/class/[TimeAxis],[SpaceAxis],[ChannelAxis],[Axis&#124;name:AxesNames;type:AxisType]^-[TimeAxis],[Axis]^-[SpaceAxis],[Axis]^-[ChannelAxis])

## Children

* [ChannelAxis](ChannelAxis.md)
* [SpaceAxis](SpaceAxis.md)
* [TimeAxis](TimeAxis.md)

## Referenced by Class


## Attributes


### Own

* [➞name](axis__name.md) <sub>1..1</sub>
* Range: [AxesNames](AxesNames.md)
* [➞type](axis__type.md) <sub>1..1</sub>
* Range: [AxisType](AxisType.md)
22 changes: 22 additions & 0 deletions rfc/4/markdown/AxisType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
orphan: true
---

# Enum: AxisType



URI: [ngff:AxisType](https://w3id.org/ome/ngff/AxisType)


## Permissible Values

| Text | Description | Meaning | Other Information |
| :--- | :---: | :---: | ---: |
| channel | Represents distinct image acquisition channels, typically corresponding to different fluorescence markers, stains, or detection modalities. Each channel captures a specific signal or wavelength, and the axis distinguishes among them in the image data.
| | |
| space | Denotes spatial dimensions of the image, such as physical axes in 2D or 3D (e.g., x, y, z). These axes map directly to coordinates in the sample or scene and often have associated physical units like microns.
| | |
| time | Represents a temporal axis capturing the progression of image data over time points or frames. It is used in time-lapse imaging or dynamic studies to distinguish image slices acquired at different moments.
| | |

29 changes: 29 additions & 0 deletions rfc/4/markdown/ChannelAxis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
orphan: true
---

# Class: ChannelAxis



URI: [ngff:ChannelAxis](https://w3id.org/ome/ngff/ChannelAxis)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Axis]^-[ChannelAxis&#124;name:string;type:string],[Axis])](https://yuml.me/diagram/nofunky;dir:TB/class/[Axis]^-[ChannelAxis&#124;name:string;type:string],[Axis])

## Parents

* is_a: [Axis](Axis.md)

## Referenced by Class


## Attributes


### Own

* [ChannelAxis➞name](ChannelAxis_name.md) <sub>1..1</sub>
* Range: [String](types/String.md)
* [ChannelAxis➞type](ChannelAxis_type.md) <sub>1..1</sub>
* Range: [String](types/String.md)
25 changes: 25 additions & 0 deletions rfc/4/markdown/ChannelAxis_name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
orphan: true
---

# Slot: name



URI: [ngff:ChannelAxis_name](https://w3id.org/ome/ngff/ChannelAxis_name)


## Domain and Range

[ChannelAxis](ChannelAxis.md) &#8594; <sub>1..1</sub> [String](types/String.md)

## Parents

* is_a: [➞name](axis__name.md)

## Children


## Used by

* [ChannelAxis](ChannelAxis.md)
25 changes: 25 additions & 0 deletions rfc/4/markdown/ChannelAxis_type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
orphan: true
---

# Slot: type



URI: [ngff:ChannelAxis_type](https://w3id.org/ome/ngff/ChannelAxis_type)


## Domain and Range

[ChannelAxis](ChannelAxis.md) &#8594; <sub>1..1</sub> [String](types/String.md)

## Parents

* is_a: [➞type](axis__type.md)

## Children


## Used by

* [ChannelAxis](ChannelAxis.md)
46 changes: 22 additions & 24 deletions rfc/4/markdown/Orientation.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,29 @@
---
orphan: true
---

# Class: Orientation

# 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 lateral side of an anatomical structure or body. | | |
| right-to-left | Describes the directional orientation from the right side to the left lateral 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 below (inferior) to above (superior) in an anatomical structure or body. | | |
| superior-to-inferior | Describes the directional orientation from above (superior) to below (inferior) in an anatomical structure or body. | | |
| dorsal-to-ventral | Describes the directional orientation from the top/upper (dorsal) to the belly/lower (ventral) in an anatomical structure or body. | | |
| ventral-to-dorsal | Describes the directional orientation from the belly/lower (ventral) to the top/upper (dorsal) in an anatomical structure or body. | | |
| dorsal-to-palmar | Describes the directional orientation from the top/upper (dorsal) to the palm of the hand (palmar) in a body. | | |
| palmar-to-dorsal | Describes the directional orientation from the palm of the hand (palmar) to the top/upper (dorsal) in a body. | | |
| dorsal-to-plantar | Describes the directional orientation from the top/upper (dorsal) to the sole of the foot (plantar) in a body. | | |
| plantar-to-dorsal | Describes the directional orientation from the sole of the foot (plantar) to the top/upper (dorsal) in a body. | | |
| rostral-to-caudal | Describes the directional orientation from the nasal (rostral) to the tail (caudal) end of an anatomical structure, typically used in reference to the central nervous system. | | |
| caudal-to-rostral | Describes the directional orientation from the tail (caudal) to the nasal (rostral) end of an anatomical structure, typically used in reference to the central nervous system. | | |
| cranial-to-caudal | Describes the directional orientation from the head (cranial) to the tail (caudal) end of an anatomical structure or body. | | |
| caudal-to-cranial | Describes the directional orientation from the tail (caudal) to the head (cranial) end of an anatomical structure or body. | | |
| proximal-to-distal | Describes the directional orientation from the center of the body to the periphery of an anatomical structure or limb. | | |
| distal-to-proximal | Describes the directional orientation from the periphery of an anatomical structure or limb to the center of the body. | | |
[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Orientation&#124;type:string;value:string]^-[AnatomicalOrientation],[AnatomicalOrientation])](https://yuml.me/diagram/nofunky;dir:TB/class/[Orientation&#124;type:string;value:string]^-[AnatomicalOrientation],[AnatomicalOrientation])

## Children

* [AnatomicalOrientation](AnatomicalOrientation.md)

## Referenced by Class


## Attributes


### Own

* [➞type](orientation__type.md) <sub>1..1</sub>
* Range: [String](types/String.md)
* [➞value](orientation__value.md) <sub>1..1</sub>
* Range: [String](types/String.md)
19 changes: 19 additions & 0 deletions rfc/4/markdown/SpaceAxesNames.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
orphan: true
---

# Enum: SpaceAxesNames



URI: [ngff:SpaceAxesNames](https://w3id.org/ome/ngff/SpaceAxesNames)


## Permissible Values

| Text | Description | Meaning | Other Information |
| :--- | :---: | :---: | ---: |
| z | Axis name relating to the z or depth axis. | | |
| y | Axis relating to the y or height axis. | | |
| x | Axis relating to the x or width axis. | | |

36 changes: 36 additions & 0 deletions rfc/4/markdown/SpaceAxis.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
orphan: true
---

# Class: SpaceAxis



URI: [ngff:SpaceAxis](https://w3id.org/ome/ngff/SpaceAxis)


[![img](https://yuml.me/diagram/nofunky;dir:TB/class/[Axis]^-[SpaceAxis&#124;unit:SpaceUnit;orientation:string%20%3F;name:SpaceAxesNames;type:string],[Axis])](https://yuml.me/diagram/nofunky;dir:TB/class/[Axis]^-[SpaceAxis&#124;unit:SpaceUnit;orientation:string%20%3F;name:SpaceAxesNames;type:string],[Axis])

## Parents

* is_a: [Axis](Axis.md)

## Referenced by Class


## Attributes


### Own

* [➞unit](spaceAxis__unit.md) <sub>1..1</sub>
* Description: Physical unit for spatial measurement along the axis, selected from a standardized list of distance units (e.g., micrometer, nanometer).

* Range: [SpaceUnit](SpaceUnit.md)
* [➞orientation](spaceAxis__orientation.md) <sub>0..1</sub>
* Description: The direction of an axis of type space.
* Range: [String](types/String.md)
* [SpaceAxis➞name](SpaceAxis_name.md) <sub>1..1</sub>
* Range: [SpaceAxesNames](SpaceAxesNames.md)
* [SpaceAxis➞type](SpaceAxis_type.md) <sub>1..1</sub>
* Range: [String](types/String.md)
25 changes: 25 additions & 0 deletions rfc/4/markdown/SpaceAxis_name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
orphan: true
---

# Slot: name



URI: [ngff:SpaceAxis_name](https://w3id.org/ome/ngff/SpaceAxis_name)


## Domain and Range

[SpaceAxis](SpaceAxis.md) &#8594; <sub>1..1</sub> [SpaceAxesNames](SpaceAxesNames.md)

## Parents

* is_a: [➞name](axis__name.md)

## Children


## Used by

* [SpaceAxis](SpaceAxis.md)
Loading