allow for additional channels with same name #185
Merged
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.
Description
What is this PR
Why is this PR needed?
Folders/files containing additional channels to register currently can't have the same name.
Registered additional channels get overwritten.
What does this PR do?
Allows users to pass additional channel folder/file with the same name.
The files that will be written will be the first unique set of names going up the levels of the file tree.
This means that the current behaviour is preserved for unique sets of additional channel names.
This PRs also adds tests for this, and sensible error raising if you pass the same additional channel multiple times.
This PR also adds a docstring to the
prep_registration
function.References
Closes #183
How has this PR been tested?
New tests added.
Manual checking on real life data shows that for two additional channel tiff files with same names but in different folders (
025_micron/same_file_name.tif
and025_micron_dummy/same_file_name.tif
, the files are named after the folders:Is this a breaking change?
No
Does this PR require an update to the documentation?
Docstring added/updated.
Checklist: