Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
scottshambaugh committed Dec 15, 2023
1 parent 3091e9b commit f7e0c89
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
- Add on more known 2D plotting functions
- Flesh out testing of 3D plotting
- Red/cyan stereograms
- 3D take into account roll angle
- 3D shareview override
- Document derivation of offsets

----

Expand All @@ -18,6 +20,10 @@
### Removed


## [0.1.1] - 2023-12-15
### Added
* README warning about data shifting in 2D plots

## [0.1.0] - 2023-12-15
### Added
* Initial release!
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,16 @@ axstereo.scatter(x, y, z, c=z, cmap='viridis', s=10)
<img width="500" height="250" src="https://raw.githubusercontent.com/scottshambaugh/mpl_stereo/main/docs/trefoil_3d.png">
</p>

### Working With Plots
Calling any method on an `AxesStereo2D` or `AxesStereo3D` object will pass that method call onto both of the left and right subplots and be applied to both of them. In the 2D case, it's only the plotting methods which take in `x` and `y` arguments that are intercepted and the additional `z` data is processed.

The figure and two subplot axes can be accessed with the following:
```python
axstereo.fig
axstereo.ax_left
axstereo.ax_right
```

## Viewing Stereograms

These are not [*auto*stereograms](https://en.wikipedia.org/wiki/Autostereogram), like the "Magic Eye" books that were popular in the 1990's. However, they use the same viewing technique. Below is ChatGPT's how-to guide on viewing these, but I'll try to find a better beginner-friendly resource to put here.
Expand All @@ -64,3 +74,6 @@ These are not [*auto*stereograms](https://en.wikipedia.org/wiki/Autostereogram),

### Parallel vs Cross-Eyed Viewing
By default, the stereograms are set up for "parallel" viewing method as described above. For "cross-eyed" viewing, initialize with a negative `ipd` parameter. An ipd (Inter-Pupilary Distance) of 65 millimeters is the default, so call `AxesStereo2D(ipd=-65)` for the default cross-eyed viewing.

### Derivation of Geometry
TODO

0 comments on commit f7e0c89

Please sign in to comment.