Skip to content

Commit 8642f5c

Browse files
committed
[ENH] Specify that dir-<label> should correspond to PhaseEncodingDirection
1 parent ed66563 commit 8642f5c

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/schema/objects/entities.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,12 @@ direction:
8383
This entity represents the `"PhaseEncodingDirection"` metadata field.
8484
Therefore, if the `dir-<label>` entity is present in a filename,
8585
`"PhaseEncodingDirection"` MUST be defined in the associated metadata.
86-
Please note that the `<label>` does not need to match the actual value of the field.
86+
87+
If the `<label>` is `AP`, `PA`, `LR`, `RL`, `SI`, or `IS`,
88+
then the `"PhaseEncodingDirection"` SHOULD correspond to the data
89+
axis that most closely aligns with the cardinal direction and orientation.
90+
For example, `dir-AP` for an image in RAS+ orientation SHOULD have
91+
`"PhaseEncodingDirection": "j-"`.
8792
type: string
8893
format: label
8994
echo:

0 commit comments

Comments
 (0)