bids-standard / bids-bep016

BEP016: diffusion derivatives
Creative Commons Attribution 4.0 International
6 stars 7 forks source link

"OrientationRepresentation" rename #91

Closed Lestropie closed 1 month ago

Lestropie commented 2 months ago

I've never liked the naming of this field, but never come up with a clear superior alternative.

"OrientationEncoding" might be the closest; I'm wary because in diffusion we talk about "diffusion sensitisation encoding", whereas what's happening here is rather "what is / are the basis function(s) by which anisotropic information on S2 is being encoded".

Open to suggestions.

Lestropie commented 2 months ago
Lestropie commented 2 months ago

Another factor that may have an influence here is whether this remains as a single metadata field, or whether it becomes just one field in a sub-dictionary, which is what I'm currently leaning towards. For those metadata fields that apply per parameter of a model, it may be beneficial to separate those fields that yield information about the anisotropic nature of what's encoded there from everything else.

So that would currently be:

Totally separating these away from things like "Description" and "Units" might be more clear.

If such grouping were to be done, then it would split metadata field naming of something like "orientation dependence" or "higher-dimensionality encoding" from what I've termed "basis functions" above.

Lestropie commented 1 month ago

92 has both renamed to "OrientationEncoding" and turned into a dictionary to encapsulate all relevant information. Closing given I've made the change as described, but doing so doesn't mean it's set in stone, alternatives can still be proposed.