Skip to content

Commit 6b4d6c9

Browse files
effigiesoesteban
andcommitted
Apply suggestions from code review
Co-authored-by: Oscar Esteban <[email protected]>
1 parent a1b7351 commit 6b4d6c9

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

src/schema/meta/context.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ properties:
407407
type: integer
408408
axis_codes:
409409
name: 'axis codes'
410-
description: 'Orientation labels indicating primary direction of data axes.'
410+
description: 'Orientation labels indicating primary direction of data axes defined with respect to the object of interest.'
411411
type: array
412412
minItems: 3
413413
maxItems: 3

src/schema/objects/entities.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,16 @@ direction:
8484
Therefore, if the `dir-<label>` entity is present in a filename,
8585
`"PhaseEncodingDirection"` MUST be defined in the associated metadata.
8686
87-
Labels need not follow any particular convention,
88-
and JSON metadata MUST take precedence in interpreting an image.
89-
Generic labels, such as `dir-reference` and `dir-reversed` avoid any possible inconsistency.
90-
`dir-j0` and `dir-j1` can indicate `"PhaseEncodingDirection": "j"` and `"j-"` (or vice versa),
87+
Labels need not follow any particular convention and in case of conflict,
88+
JSON metadata MUST take precedence in interpreting an image.
89+
90+
For example, `dir-j0` and `dir-j1` can indicate `"PhaseEncodingDirection": "j"` and `"j-"` (or vice versa),
9191
identifying the phase-encoding axis while avoiding indicating polarity.
92+
However, in case of a dataset indicating `dir-j0` with `"PhaseEncodingDirection": "i"`, the
93+
JSON metadata overrides the entity `dir-` setting.
94+
95+
The use of generic labels, such as `dir-reference` and `dir-reversed`, is RECOMMENDED
96+
to avoid any possible inconsistency.
9297
9398
To avoid inconsistency, if the `<label>` is `AP`, `PA`, `LR`, `RL`, `SI`, or `IS`,
9499
then the `"PhaseEncodingDirection"` SHOULD correspond to the data

0 commit comments

Comments
 (0)