Neatened things up to be more reader-friendly #766
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey fellas. This isn't a proper pull request because I haven't done any tests (I'm not actually sure what to do re standards for this library?); rather, I've just I've just made the registrations.py file a little more reader-friendly.
Motivation
I'm trying to use ANTsPy to register light-sheet microscopy data of larval zebrafish brains, but am having limited success. I'm having to dig through the code to understand what arguments go where, which I find easier to do after renaming and reorganising a few things.
My hope is that now, if a person wants to understand a specific type of transform, they can read how the arguments
args
are constructed and work backwards from there.What I've tweaked
type_of_transform="antsRegistrationSyN[s]"
case I was able to recover the full length names of some of the arguments; I used this to rename some arguments. I've also renamed some of the shorter-named variables.if [Boolean Variable] == True
, so I simplified those."SyNLessAggro"
seems to do exactly the same as"SyNAggro"
, so I've added a comment to that in the function description.