Skip to content

Current state of the BEP (NOT FOR MERGING)#24

Open
Lestropie wants to merge 138 commits intomasterfrom
bep-016
Open

Current state of the BEP (NOT FOR MERGING)#24
Lestropie wants to merge 138 commits intomasterfrom
bep-016

Conversation

@Lestropie
Copy link
Copy Markdown
Collaborator

This is a replacement of #6 as the BEP is being reinvested in.

The PR is not for merging, but to show the current state of the difference between the BEP and an up-to-date master of the BIDS specification.

effigies and others added 19 commits September 18, 2019 10:13
This PR splits the tractography section from the diffusion derivatives
document, so that #5 is easier to merge.
The new ``05-diffusion-derivatives-tractography.md`` file will remain
orphaned, but kept there as a base for the time we tackle tractography.
It shouldn't be merged into the derivatives branch until it is ready.
- More clarity of distinction between requisite and optional files in output directory.
- Try using 3 spaces rather than 4 in non-code indentation; partly to try to get tables within dot point lists to render correctly, partly to improve editor software syntax highlighting.
- Various small re-wordings.
- Slightly more use of hyperlinks.
- Short introductions to "parameter terminology" and "data representations" sections.
- Be more explicit about normalised vs. non-normalised 3-vectors, so that structure more clusely mimics that of description of spherical coordinate representation.
- Rename hyperlink names to "parameter terminology" section to better separate from later "intrinsic / extrinsic model parameters" sections.
Based on suggestion in #5. If all model intrinsic parameters are incorporated into a single file, rather than dropping the "_parameter-<param>" field, instead enforce that parameter name "all" be used.
When introducing the file naming convention, give an example of the "_<model>" field.
Re-arranged descriptions of intrinsic and extrinsic model parameters within the file naming section, and corrected a discordance in one dot point that was using an intrinsic model parameter filename path but discussing extrinsic model parameters.
Provide information on specification of orientation data after the various models and model parameters have been explained.
Lestropie and others added 6 commits May 17, 2024 10:24
Co-authored-by: Ariel Rokem <arokem@gmail.com>
- FSL bedpostx command fibre orientations stored as spherical coordinates are confirmed to use the "bvec" reference frame.
- Enforcing azimuth angle to obey the right hand rule about the zenith axis would necessitate direct modification of image intensities from bedpostx outputs to store. Therefore it would be preferable to instead define the sign of the azimuth angle based on the direction of the second reference axis.
Closes #95.
Closes #94.
Conflicts:
	src/derivatives/05-diffusion-derivatives.md
DWI models: Define "bvec" orientation reference
@arokem
Copy link
Copy Markdown
Collaborator

arokem commented Jun 5, 2024

IIUC, we need to resolve this discussion: https://github.com/bids-standard/bids-bep016/pull/104/files#r1605423106, and after that we can convert this to a PR against bids-standard/bids-specification:master. Is that others' understanding as well? Do folks want to weigh in on that terminology discussion? @francopestilli : do you have any thoughts on nomenclature for l/lmax?

@Lestropie
Copy link
Copy Markdown
Collaborator Author

Lestropie commented Jun 6, 2024

A PR without #71 and with no exemplar data generated via #23 would IMO be laughed off. You can't demand that the community format their data to your decree whilst literally never having done it yourself. Please give me time to generate a BIDS App to generate and save the derivatives currently exemplified in the specification document, so that they can be moved from there to bids-examples. I had to deal with the reference frame handling issues first.

@PeerHerholz
Copy link
Copy Markdown
Member

Hi @Lestropie,

concerning this, I started working on a respective BIDS App a while ago: bids_bep16_conv. It's a fully working BIDS App and we would only need to update the output formatting to conform to the current up-to-date version. Thus, if you would consider this feasible instead of starting a new BIDS App, I'm happy to help! No worries of course if not, e.g. you would prefer a different implementation, etc. .

Cheers, Peer

@Lestropie
Copy link
Copy Markdown
Collaborator Author

My comment was on the premise that the converter was being restricted in scope to exclusively conversion of pre-generated model fitting outputs, in which case another tool would be required to run the fitting then the conversion. Been a long break between bursts so certain details will still be a bit fuzzy. If in its current state that tool does both fitting and conversion, then that's the obvious starting point; but as per PeerHerholz/bids_bep16_conv#7 longer term we'll want to think about separation of those two steps.

arokem and others added 3 commits August 20, 2024 10:34
Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 4 to 5.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
- [Commits](codecov/codecov-action@v4...v5)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@francopestilli francopestilli marked this pull request as ready for review September 15, 2025 18:17
dependabot bot and others added 14 commits November 1, 2025 07:01
Bumps [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) from 6 to 7.
- [Release notes](https://github.com/astral-sh/setup-uv/releases)
- [Commits](astral-sh/setup-uv@v6...v7)

---
updated-dependencies:
- dependency-name: astral-sh/setup-uv
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
… with 5 updates

Bumps the actions-infrastructure group with 5 updates in the / directory:

| Package | From | To |
| --- | --- | --- |
| [actions/checkout](https://github.com/actions/checkout) | `5` | `6` |
| [actions/upload-artifact](https://github.com/actions/upload-artifact) | `4` | `5` |
| [actions/download-artifact](https://github.com/actions/download-artifact) | `5` | `6` |
| [actions/setup-node](https://github.com/actions/setup-node) | `4` | `6` |
| [actions/setup-python](https://github.com/actions/setup-python) | `5` | `6` |



Updates `actions/checkout` from 5 to 6
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v5...v6)

Updates `actions/upload-artifact` from 4 to 5
- [Release notes](https://github.com/actions/upload-artifact/releases)
- [Commits](actions/upload-artifact@v4...v5)

Updates `actions/download-artifact` from 5 to 6
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v5...v6)

Updates `actions/setup-node` from 4 to 6
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v4...v6)

Updates `actions/setup-python` from 5 to 6
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/upload-artifact
  dependency-version: '5'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/download-artifact
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/setup-node
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: actions-infrastructure
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 7 to 8.
- [Release notes](https://github.com/peter-evans/create-pull-request/releases)
- [Commits](peter-evans/create-pull-request@v7...v8)

---
updated-dependencies:
- dependency-name: peter-evans/create-pull-request
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
…codecov/codecov-action-5

chore(deps): bump codecov/codecov-action from 4 to 5
…astral-sh/setup-uv-7

chore(deps): bump astral-sh/setup-uv from 6 to 7
…peter-evans/create-pull-request-8

chore(deps): bump peter-evans/create-pull-request from 7 to 8
…actions-infrastructure-f2d4b981e8

chore(deps): bump the actions-infrastructure group across 1 directory with 5 updates
Conflicts:
	src/derivatives/05-diffusion-derivatives.md
Use of "order" has been adopted across the documentation.
- Rename exemplar data and metadata files encoding the FSL bedpostx ball-and-sticks model from "_model-bs" to "_model-ballsticks" to avoid negative acronym connotation.
- Rename permissble value for "Reference" metadata from "bvec" to "fsl": this axis reference convention is not specific to the "bvec" file format but is a convention utilised throughout the FSL software.
New appendix page: spherical harmonics
Conflicts:
	src/derivatives/05-diffusion-derivatives.md
BEP016: Renaming relevant to FSL
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants