brainglobe / brainreg

Automated 3D brain registration with support for multiple species and atlases.
https://brainglobe.info/documentation/brainreg/index.html
BSD 3-Clause "New" or "Revised" License
121 stars 27 forks source link

allow for additional channels with same name #185

Closed alessandrofelder closed 6 months ago

alessandrofelder commented 6 months ago

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 and 025_micron_dummy/same_file_name.tif, the files are named after the folders: image

Is this a breaking change?

No

Does this PR require an update to the documentation?

Docstring added/updated.

Checklist: