Skip to content

ENH: Support OutputTransformParameterFileFormat parameter for TOML#1289

Merged
N-Dekker merged 1 commit intomainfrom
OutputTransformParameterFileFormat-TOML
Feb 10, 2025
Merged

ENH: Support OutputTransformParameterFileFormat parameter for TOML#1289
N-Dekker merged 1 commit intomainfrom
OutputTransformParameterFileFormat-TOML

Conversation

@N-Dekker
Copy link
Copy Markdown
Member

@N-Dekker N-Dekker commented Feb 10, 2025 •
edited
Loading

Supports the parameter OutputTransformParameterMapFileFormat" in elastix registration parameter files. Allows specifying the file format of the output transform parameter files.

Possible values:

  • "txt": Use the legacy file format, "TransformParameters.*.txt" (the default)
  • "TOML": Use the TOML file format, "TransformParameters.*.toml"
  • "" (empty string): Use the default

@N-Dekker
Copy link
Copy Markdown
Member Author

N-Dekker commented Feb 10, 2025

Some considerations:

  • We might choose to support spelling the parameter value for TOML with lowercase: "toml". I did not propose that, because the standard way appears to be uppercase: https://toml.io
  • We might support multiple parameter values, (OutputTransformParameterMapFileFormat "txt" "TOML"), to output the files in both file formats. But it's a bit extra work to implement. 🤷
  • We might change the default output format to TOML. But I would rather do so after the next release, to allow users to gradually move from txt to TOML.
  • In Python, it should be quite easy to convert TOML to text, using Python's standard tomllib package.

@N-Dekker N-Dekker changed the title ENH: Support OutputTransformParameterMapFileFormat parameter for TOML ENH: Support OutputTransformParameterFileFormat parameter for TOML Feb 10, 2025
@N-Dekker
ENH: Support OutputTransformParameterFileFormat parameter for TOML
8d758fe 
Supports the parameter `OutputTransformParameterMapFileFormat"` in elastix registration parameter files. Allows specifying the file format of the output transform parameter files.

Possible values:

 - `"txt"`: Use the legacy file format, "TransformParameters.*.txt" (the default)
 - `"TOML"`: Use the TOML file format, "TransformParameters.*.toml"
 - `""` (empty string): Use the default
@N-Dekker N-Dekker force-pushed the OutputTransformParameterFileFormat-TOML branch from 3160094 to 8d758fe Compare February 10, 2025 16:07
@N-Dekker N-Dekker merged commit 0626258 into main Feb 10, 2025
@N-Dekker N-Dekker deleted the OutputTransformParameterFileFormat-TOML branch February 10, 2025 16:40
N-Dekker added a commit that referenced this pull request Feb 14, 2025
@N-Dekker
DOC: Document the OutputTransformParameterFileFormat parameter
81b5865 
- Follow-up to pull request #1289 commit 0626258 "ENH: Support `OutputTransformParameterFileFormat` parameter for TOML"
N-Dekker added a commit that referenced this pull request Feb 14, 2025
@N-Dekker
BUG: Remove accidental spaces after specific\n
8e8a82b 
Accidentally introduced with pull request #1289 commit 0626258 "ENH: Support `OutputTransformParameterFileFormat` parameter for TOML"
N-Dekker added a commit that referenced this pull request Feb 17, 2025
@N-Dekker
DOC: Document the OutputTransformParameterFileFormat parameter
e56b17b 
- Follow-up to pull request #1289 commit 0626258 "ENH: Support `OutputTransformParameterFileFormat` parameter for TOML"
N-Dekker added a commit that referenced this pull request Feb 17, 2025
@N-Dekker
BUG: Remove accidental spaces after specific\n
89b8412 
Accidentally introduced with pull request #1289 commit 0626258 "ENH: Support `OutputTransformParameterFileFormat` parameter for TOML"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mstaring mstaring Awaiting requested review from mstaring

@stefanklein stefanklein Awaiting requested review from stefanklein

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@N-Dekker