[ENH] Added ASSET class initialization parameter to define the binning rounding error tolerance #585
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
July 25, 2023 15:50
Moritz-Alexander-Kern
changed the title
Moritz-Alexander-Kern
added
the
enhancement
Moritz-Alexander-Kern
requested changes
Jul 25, 2023
added 2 commits
July 25, 2023 17:57
|
Thanks for the review, @Moritz-Alexander-Kern. I made the requested changes and also modified the unit tests slightly so that the binning of each of the two input lists is checked (same spiketrains, but reverse order). |
Moritz-Alexander-Kern
approved these changes
Jul 26, 2023
There was a problem hiding this comment.
Thanks implementing the requested changes so promptly @kohlerca .
Approved from my side. ✔️
mdenker
approved these changes
Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently, the
ASSETclass performs the binning of the spiketrains using the default behavior of theBinnedSpikeTrainclass inconversion.Therefore, when spike times are closer to the right bin edge than a defined tolerance value, the
BinnedSpikeTrainclass shifts the spike to the next bin. This behavior can be controlled by thetoleranceparameter ofBinnedSpikeTrain.This PR adds the new parameter
bin_toleranceto theASSETclass, in order to allow the user to define the desired tolerance (and henceBinnedSpikeTrainbehavior).The parameter can take a string
'default'to use the default behavior ofBinnedSpikeTrain(and which corresponds to the current status ofASSETbefore this PR), or a float value or None. In the latter two cases, these values are forwarded to the binning class, and will result in either shifting or not shifting the spikes, respectively.