Skip to content

Commit

Permalink
docs: add documentation for 'odd_asphere' geometry in various sections
Browse files Browse the repository at this point in the history
  • Loading branch information
HarrisonKramer committed Jan 26, 2025
1 parent 092d455 commit 81e3223
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/api_geometries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ that require a numerical solution to find the intersection point with a ray.
geometries.base
geometries.chebyshev
geometries.even_asphere
geometries.odd_asphere
geometries.newton_raphson
geometries.plane
geometries.polynomial
Expand Down
1 change: 1 addition & 0 deletions docs/developers_guide/geometry_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Optiland includes a wide range of built-in geometries:
- **Planes**: Flat surfaces with infinite or finite extent.
- **Spheres and Conics**: Defined by radius of curvature and conic constant.
- **Even Aspheres**: Described by polynomial terms for deviations from a sphere.
- **Odd Aspheres**: Similar to even aspheres but with additional terms for odd powers.
- **Polynomial XY and Chebyshev Surfaces**: Useful for advanced freeform optical systems.
- **Custom Geometries**: Users can easily extend the framework by subclassing the `BaseGeometry` (analytical geometries) or `NewtonRaphsonGeometry` (iterative geometries) classes.

Expand Down
1 change: 1 addition & 0 deletions docs/gallery/specialized_lenses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ While these lenses are perhaps more complex, they are built using the same basic
specialized_lenses/objective
specialized_lenses/f_theta_lens
specialized_lenses/f_theta_with_fold_mirror
specialized_lenses/odd_asphere
specialized_lenses/microscope
specialized_lenses/catadioptric
specialized_lenses/endoscope
Expand Down
103 changes: 103 additions & 0 deletions docs/gallery/specialized_lenses/odd_asphere.ipynb

Large diffs are not rendered by default.

0 comments on commit 81e3223

Please sign in to comment.