From 3b9a167d4c3e0c195bbff12b9eb3e416ee714db6 Mon Sep 17 00:00:00 2001 From: Scott Shambaugh Date: Sun, 23 Jun 2024 22:40:55 -0600 Subject: [PATCH] Stereosquare docs --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ab5e09..22d7189 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ axstereo.scatter(x, y, z, c=z, cmap='viridis', s=10)

### Red-Cyan Anaglyphs -Some 2D plots can also be made into anaglyphs, which are stereograms that can be viewed with red-cyan 3D glasses. While this allows for seeing the stereoscopic effect without training your eyes, it also means that the data cannot be otherwise colored. +Some 2D plots can also be made into anaglyphs, which are stereograms that can be viewed with red-cyan 3D glasses. While this allows for seeing the stereoscopic effect without training your eyes, it also means that the data cannot be otherwise colored. Note that 3D plots cannot currently be made into anaglyphs. The same warning as for the 2D stereo plots about shifting data applies here as well. If `eye_balance` is -1 or +1 such that the data for one of the colors is not shifted, then that color will be applied to the x-axis tick labels to show that they are accurate. ```python @@ -166,6 +166,20 @@ axstereo = AxesAnaglyph(zzero=max(z)) # data will sink below the page

+### Stereo Squares +The side-by-side, anaglyph, and wiggle plots all have somewhat different viewing methods, and people prefer different methods. For sharing stereograms widely, the `StereoSquare2D` and `StereoSquare3D` classes can be used to generate a single plot that shows all three plots on a 2x2 grid. + +```python +from mpl_stereo import StereoSquare2D +stereosquare = StereoSquare2D() +stereosquare.imshow_stereo(church_left_data, church_right_data) # imshow_stereo is the only special method +# For other plotting, just call them on the stereosquare object, eg stereosquare.plot(x, y, z) +``` + +

+ +

+ ### Animations See an example of how to use this with matplotlib animations in [docs/gen_graphics.py](docs/gen_graphics.py).