Create plotting function for VACF #23
Merged
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
|
The code should work, but I am still figuring out how to write tests for it. Also want to consider and discuss whether there is a better way of going about this. |
* OO interface refers to Matplotlib's object-oriented interface
* Tests cover plotted data and labels
|
Tests are done, but I am struggling with the type hinting for specific class instances. Any advice @hmacdope @orionarcher? |
hmacdope
requested changes
Jul 11, 2023
| @@ -228,3 +229,41 @@ def _conclude_simple(self): | |||
| self.results.vacf_by_particle[lag, :] = np.mean(sum_veloc, axis=0) | |||
| # average over # particles and update results array | |||
| self.results.timeseries = self.results.vacf_by_particle.mean(axis=1) | |||
|
|
|||
There was a problem hiding this comment.
If this takes a VACF object only it should be a method rather than standalone.
| @@ -228,3 +229,41 @@ def _conclude_simple(self): | |||
| self.results.vacf_by_particle[lag, :] = np.mean(sum_veloc, axis=0) | |||
| # average over # particles and update results array | |||
| self.results.timeseries = self.results.vacf_by_particle.mean(axis=1) | |||
|
|
|||
|
|
|||
| def plot_vacf(vacf_obj, start=0, stop=0, step=1): | |||
There was a problem hiding this comment.
can do type hint with a string `vacf_obj: "ObJType..." but see above comment.
* Method is in class `VelocityAutocorr`
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.
Towards #7
Changes made in this Pull Request:
plot_vacf()to easily plot VACFs viaMatplotlib