[ENH] Integrate trials object with Fano factor #645
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
Moritz-Alexander-Kern
added
the
enhancement
elephant/statistics.py
Outdated
| f"different duration (minimum: {np.min(durations)}s, maximum " | ||
| f"{np.max(durations)}s).") | ||
| else: | ||
| warnings.warn(f"Spiketrains was of type {type(spiketrains)}, which does not support automatic duration" |
There was a problem hiding this comment.
remove warning
|
|
||
| Notes | ||
| ----- | ||
| The check for the equal duration of the input spike trains is performed | ||
| only if the input is of type`neo.SpikeTrain`: if you pass a numpy array, | ||
| only if the input is of type`neo.SpikeTrain`: if you pass e.g. a numpy array, | ||
| please make sure that they all have the same duration manually. |
There was a problem hiding this comment.
move notes to spiketrains parameter docstring
| (see Notes). | ||
| Default: 0.1 ms | ||
| pool_trials : bool, optional |
There was a problem hiding this comment.
remove parameter -> default behavior for trial object as input
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.
This pull request introduces an enhancement to Fano factor using the the
elephant.trialsmodule to represent trials. This change is part of a greater effort to provide a more structured and unified approach for handling trial data in Elephant.Trial representations
Changes
fanofactornow handles trial object