fintrace.drawing
================

.. py:module:: fintrace.drawing

.. autoapi-nested-parse::

   A module for drawing tools and functions.



Classes
-------

.. autoapisummary::

   fintrace.drawing.Grid
   fintrace.drawing.RotatedRect
   fintrace.drawing.Photodiode
   fintrace.drawing.Hexagon


Functions
---------

.. autoapisummary::

   fintrace.drawing.drawDetectors
   fintrace.drawing.drawAllDetectors
   fintrace.drawing.checkGrid
   fintrace.drawing.drawGrid
   fintrace.drawing.drawAllShapes
   fintrace.drawing.make_shapes_list
   fintrace.drawing.make_optics_list
   fintrace.drawing.make_cavities_dict
   fintrace.drawing.drawLaser
   fintrace.drawing.getBeam
   fintrace.drawing.get_seq_beams
   fintrace.drawing.drawRotatedRect
   fintrace.drawing.drawPhotodiode


Module Contents
---------------

.. py:function:: drawDetectors(canvas, detector, gdict, layername)

.. py:function:: drawAllDetectors(canvas, detectors, gdict: dict, layername=None)

.. py:function:: checkGrid(gtrace_dict: dict)

.. py:function:: drawGrid(cnv: gtrace.draw.Canvas, grid: None, objects: dict)

.. py:function:: drawAllShapes(cnv, shapes_to_plot)

.. py:function:: make_shapes_list(gtrace_dict: dict) -> list

.. py:function:: make_optics_list(gtrace_dict: dict, skip_optics=[]) -> list

.. py:function:: make_cavities_dict(finesse_cavs: dict, skip_optics=[]) -> dict

.. py:function:: drawLaser(canvas, laserbeam, laser_width=0.1, laser_length=0.2, layer=None)

.. py:function:: getBeam(i, beam, mirror, path, prev_mirror, beamDict)

.. py:function:: get_seq_beams(cavity, cavity_path_comps, gtrace_optics)

.. py:class:: Grid(xlim, ylim, xstep=None, ystep=None)

   Bases: :py:obj:`gtrace.draw.Shape`


   Shape class


   .. py:attribute:: xlim


   .. py:attribute:: ylim


   .. py:attribute:: xstep
      :value: None



   .. py:attribute:: ystep
      :value: None



.. py:class:: RotatedRect(point, width, height, name, color=(0, 0, 0), thickness=0, normAngle=0)

   Bases: :py:obj:`gtrace.draw.Shape`


   A rotated rectangle


   .. py:attribute:: point


   .. py:attribute:: width


   .. py:attribute:: height


   .. py:attribute:: thickness
      :value: 0



   .. py:attribute:: normAngle
      :value: 0



   .. py:attribute:: name


   .. py:attribute:: color
      :value: (0, 0, 0)



.. py:function:: drawRotatedRect(optic)

.. py:class:: Photodiode(point, normAngle, width=None, name='PD', thickness=0.1)

   Bases: :py:obj:`gtrace.draw.Shape`


   Shape class


   .. py:attribute:: point


   .. py:attribute:: normAngle


   .. py:attribute:: width
      :value: None



   .. py:attribute:: name
      :value: 'PD'



   .. py:attribute:: thickness
      :value: 0.1



.. py:function:: drawPhotodiode(optic)

.. py:class:: Hexagon(center, normAngle, radius=1, thickness=0, name=None, color=None)

   Bases: :py:obj:`gtrace.draw.Shape`


   Shape class


   .. py:attribute:: center


   .. py:attribute:: normAngle


   .. py:attribute:: radius
      :value: 1



   .. py:attribute:: thickness
      :value: 0



   .. py:attribute:: name
      :value: None



   .. py:attribute:: color
      :value: None



   .. py:method:: draw()