optic-object-wavefronts 1.3.17
Representing optical components using object wavefronts

#######################
Optic Object Wavefronts
#######################
|TestStatus| |PyPiStatus| |BlackStyle| |BlackPackStyle| |MITLicenseBadge|

|ImgBlender|


A python-library to create triangle-meshes with vertex-normals of optics such as lenses and mirrors.
Use common computer-aided-design for all easy, non optical components where surface-normals do not matter.
But when surface-normals matter, use this library to creatre meshes with accurate vertex-normals.


*******
Install
*******

.. code-block:: bash

    pip install optic-object-wavefronts


**********
Primitives
**********

Disc
====

|ImgDisc|

.. |ImgDisc| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/Disc.jpg?raw=True


Cylinder
========

|ImgCylinder|

.. |ImgCylinder| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/Cylinder.jpg?raw=True


SphericalCapRegular
===================

|ImgSphericalCapRegular|

.. |ImgSphericalCapRegular| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/SphericalCapRegular.jpg?raw=True


SphericalCapHexagonal
=====================

|ImgSphericalCapHexagonal|

.. |ImgSphericalCapHexagonal| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/SphericalCapHexagonal.jpg?raw=True


SphericalCapPixels
==================

|ImgSphericalCapPixels|

.. |ImgSphericalCapPixels| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/SphericalCapPixels.jpg?raw=True


SphericalLens
=============

|ImgSphericalLens|

.. |ImgSphericalLens| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/SphericalLens.jpg?raw=True


SphericalLensHexagonal
======================

|ImgSphericalLensHexagonal|

.. |ImgSphericalLensHexagonal| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/SphericalLensHexagonal.jpg?raw=True


SphericalPlanarLensHexagonal
============================

|ImgSphericalPlanarLensHexagonal|

.. |ImgSphericalPlanarLensHexagonal| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/SphericalPlanarLensHexagonal.jpg?raw=True


.. |BlackStyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |TestStatus| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/actions/workflows/test.yml/badge.svg?branch=main
    :target: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/actions/workflows/test.yml

.. |PyPiStatus| image:: https://img.shields.io/pypi/v/optic_object_wavefronts
    :target: https://pypi.org/project/optic_object_wavefronts

.. |BlackPackStyle| image:: https://img.shields.io/badge/pack%20style-black-000000.svg
    :target: https://github.com/cherenkov-plenoscope/black_pack

.. |MITLicenseBadge| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT

.. |ImgBlender| image:: https://github.com/cherenkov-plenoscope/optic_object_wavefronts/blob/main/readme/mirror_render_blender.jpg?raw=True