Neurocaps

💻 Metadata
- Simply wanted the latest metadata update to be on Zenodo and to have the same DOI as I forgot to upload
version 0.14.2.post1 there.

💻 Metadata
- Updated a warning during timeseries extraction that only included a partial reason for why the indices for condition
have been filtered out. Added information about `fd_threshold` being the reason why.

♻ Changed
- Implemented a minor code refactoring that allows runs flagged due to "outlier_percentage", runs were all volumes will
be scrubbed due to all volumes exceeding the threshold for framewise displacement, and runs were the specified condition
returns zero indices will not undergo timeseries extraction.
- Also clarified the language in a warning that occurs when all NifTI files have been excluded or missing for a subject.
🐛 Fixes
- If a condition does not exist in the event file, a warning will be issued if this occurs. This should prevent empty
timeseries or errors. In the warning the condition will be named in the event of a spelling error.
- Added specific error type to except blocks for the cosine similarities that cause a division by zero error.

💻 Metadata
- Updates typehint `fd_threshold` since it was only updated in the doc string.

♻ Changed
- In `TimeseriesExtractor`, `fd_threshold` can now be a dictionary, which includes a sub-key called "outlier_percentage",
a float value between 0 and 1 representing a percentage. Runs where the proportion of volumes exceeding the "threshold"
is higher than this percentage are removed. If `condition` is specified in `self.get_bold`, only the runs where the
proportion of volumes exceeds this value for the specific condition of interest are removed. A warning is issued
whenever a run is flagged.
- As of now, flagging and removal of runs, due to "outlier_percentage", is conducted after timeseries extraction.
This was done to minimize disrupting the original code and for easier testing for feature reliability as significant
code refactoring could cause unintended behaviors and requires longer testing for reliability. In a future patch, runs
will be assessed to see if they meet the exclusion criteria due to "outlier_percentage" prior to extraction and will be
skipped if flagged.
💻 Metadata
- Warning issue if cosine similarity is 0.
- Minor improvements to warning clarity.
- Changelog versioning updated for transparency since patches may include changes to parameters to improve behavior or
added paramaters to fix behavior. But these changes will be backwards compatible.

🚀 New/Added
- More flexibility when calculating cosine similarity in the `CAP.caps2radar` function. Now a `method` and `alpha` parameter
is added to choose between calculating "traditional" cosine similarity, a more "selective" cosine similarity, or
a "combined" approach where `alpha` is used to determine the relative contributions of the `traditional` and `selective`
approach.
🐛 Fixes
- Added try except blocks in `CAP.caps2radar`, to handle division by zero cases.
- In `CAP.caps2surf`, `as_outline` kwarg is now its own separate layer, which should allow the outline to be build
on top of the stat map when requested.