Add 3D plotting option to Plotterly

mharris-dstl commented 5 months ago

This PR gives the option of plotting in 3D using Plotterly. It also adds more tests and makes dimension checking in Plotterly more holistic. More details are:

Plotting is now supported in 3D for ground truth, measurements, and tracks. Sensor plotting is not here but no reason why it can't be added in the future.
Dimension checking has been simplified so that integers can always be used in cases like if self.dimension == 1:
Track uncertainty has been added in the way of error bars in the x, y, and z direction, as suggested by @Carlson-J here. It is not perfect because it does not show times where covariance is large, but it's a simple way of getting an idea of track uncertainty. It makes use of scatterplot3d's error arguments - making custom error bars that plot the eigenvectors would require significant effort to implement. Unfortunately, I think a bug in Plotly means 3d error bars are fixed at 1 pixel wide, so they are quite hard to see. I think it's still better than not having them, but the functionality can be removed from this PR if desired. See the pictures below:

gawebb-dstl commented 5 months ago

Code changes look good from reading them. I'll try using the new code soon

codecov[bot] commented 5 months ago

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Comparison is base (0a0f43b) 93.23% compared to head (6e8eadb) 93.40%. Report is 23 commits behind head on main.

Files	Patch %	Lines
stonesoup/plotter.py	79.24%	3 Missing and 8 partials :warning:

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #932 +/- ## ========================================== + Coverage 93.23% 93.40% +0.17% ========================================== Files 200 200 Lines 12516 12538 +22 Branches 2580 2591 +11 ========================================== + Hits 11669 11711 +42 + Misses 595 585 -10 + Partials 252 242 -10 ``` | [Flag](https://app.codecov.io/gh/dstl/Stone-Soup/pull/932/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl) | Coverage Δ | | |---|---|---| | [integration](https://app.codecov.io/gh/dstl/Stone-Soup/pull/932/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl) | `67.03% <22.64%> (-0.03%)` | :arrow_down: | | [unittests](https://app.codecov.io/gh/dstl/Stone-Soup/pull/932/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl) | `88.84% <77.35%> (+0.25%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dstl#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

dstl / Stone-Soup

Add 3D plotting option to Plotterly #932

Codecov Report