[Feature] Online Unitary Event Analysis #491
Open
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
… online version of the Unitary Event Analysis into 'elephant'
…taryEventAnalysis' TestCase and load it then several times for the respective test-functions which use this dataset; uncommented import/usage of matplotlib within this TestCase (the created plots are just a possible debug help for the developer, but not needed for executing the test-functions)
This comment was marked as outdated.
This comment was marked as outdated.
…o the call of '__init__()'; changed order of class methods: public methods are now first in alphabetical order, followed by the private helper methods which are unordered; changed order of testing the class attributes after performing the 'reset()' method in the test-function 'test_reset' to be the same as in the docstring of the 'OnlineUnitaryEventAnalysis' class
Moritz-Alexander-Kern
requested review from
mdenker,
Moritz-Alexander-Kern,
kohlerca and
rjurkus
|
Hey @ojoenlanuca,
Thanks for contributing ! |
There was a problem hiding this comment.
Thanks for this nice addition to elephant.
Here is an initial review checking for naming conventions, code style and unit-tests.
- check naming conventions in https://elephant.readthedocs.io/en/latest/style_guide.html
- please help justifying the use of viziphant in the unit-tests
- consistent naming with
unitary_event_analysis.py
Consider this an initial review, an in-depth review will follow.
Moritz-Alexander-Kern
added
the
enhancement
… and numpy.ndarray for 'events' parameters, in the later case three additional parameters must be specified, namely: 't_start', 't_stop' and 'time_unit'; extended TestCase class to cover also these alternative types for the 'spiketrains' and 'events' representation
… parameters which are not pq.Quantities
1 task
…e tw_counter represents the number of already analyzed trials and n_trials represents the number of trials for which a trigger event was given; tw_counter <= n_trials, i.e. it is possible to provide more trigger events than could be actually analyzed due to the simulation duration (providing trigger events that would occure after the simulation end)
…and online UEA results
…ome calculations; fixed PEP issues (not all)
… UnitTests of test_online.py
added 2 commits
November 17, 2022 16:41
Moritz-Alexander-Kern
changed the title
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 online version of the Unitary Event Analysis (UEA). It is related to the pull request #405, because it provides another online batched statistic. These pull requests could be reviewed jointly, but also separately, depending on what will be more efficient in terms of the overall time needed for the reviews.
Like the other online batched measures in #405, the online version of the UEA is implemented as a class, which stores the necessary intermediate results within class-attributes and updates them with the aid of the 'update_uea()' class-method. To perform such an update-step, several helper-methods are used to manage the spike data and to pre-process it in the same manner as the standard/offline UEA it does.
The 'concurrent_test_runner_for_uea.py' module is optional. It executes all test-functions of 'TestOnlineUnitaryEventAnalysis' unittest.TestCase, which is located in 'test_online.py', in a concurrent manner to reduce run-time. It uses the third-party package 'concurrencytest', which is yet not part of the 'elephant'-requirements.
Task List