rayoptics.mpl package

package implementing useful rayoptics graphics using matplotlib

The mpl subpackage provides useful basic optical graphics using the matplotlib plotting package. Particular features include:

• 2D lens layout, interactivelayout

• \(y-\overline{y}\) and \(\omega-\overline{\omega}\) paraxial ray diagrams, interactivediagram

• ray aberration and wavefront pupil/field plots, analysisfigure, axisarrayfigure and analysisplots

• base class to manage light and dark UI styles, styledfigure

Submodules

• rayoptics.mpl.analysisfigure module
  • AnalysisFigure
    • AnalysisFigure.subplots
    • AnalysisFigure.data_objs
    • AnalysisFigure.grid
    • AnalysisFigure.gs
    • AnalysisFigure.gridspecs
    • AnalysisFigure.kwargs
    • AnalysisFigure.refresh()
    • AnalysisFigure.update_data()
    • AnalysisFigure.plot()
    • AnalysisFigure.set()
  • RayFanPlot
    • RayFanPlot.fan_list
    • RayFanPlot.scale_type
    • RayFanPlot.user_scale_value
    • RayFanPlot.title
    • RayFanPlot.yaxis_ticks_position
    • RayFanPlot.kwargs
    • RayFanPlot.init_axis()
    • RayFanPlot.refresh()
    • RayFanPlot.update_data()
    • RayFanPlot.plot()
  • RayGeoPSF
    • RayGeoPSF.ray_list
    • RayGeoPSF.dsp_type
    • RayGeoPSF.scale_type
    • RayGeoPSF.user_scale_value
    • RayGeoPSF.title
    • RayGeoPSF.yaxis_ticks_position
    • RayGeoPSF.kwargs
    • RayGeoPSF.init_axis()
    • RayGeoPSF.refresh()
    • RayGeoPSF.update_data()
    • RayGeoPSF.ray_data_bounds()
    • RayGeoPSF.plot()
  • Wavefront
    • Wavefront.ray_grid
    • Wavefront.do_contours
    • Wavefront.image
    • Wavefront.scale_type
    • Wavefront.user_scale_value
    • Wavefront.title
    • Wavefront.yaxis_ticks_position
    • Wavefront.cmap
    • Wavefront.kwargs
    • Wavefront.init_axis()
    • Wavefront.refresh()
    • Wavefront.update_data()
    • Wavefront.plot()
  • DiffractionPSF
    • DiffractionPSF.pupil_grid
    • DiffractionPSF.maxdim
    • DiffractionPSF.title
    • DiffractionPSF.yaxis_ticks_position
    • DiffractionPSF.cmap
    • DiffractionPSF.kwargs
    • DiffractionPSF.init_axis()
    • DiffractionPSF.refresh()
    • DiffractionPSF.update_data()
    • DiffractionPSF.plot()
• rayoptics.mpl.analysisplots module
  • FieldCurveFigure
    • FieldCurveFigure.refresh()
    • FieldCurveFigure.update_data()
    • FieldCurveFigure.plot()
    • FieldCurveFigure.set()
  • ThirdOrderBarChart
    • ThirdOrderBarChart.refresh()
    • ThirdOrderBarChart.update_data()
    • ThirdOrderBarChart.plot()
    • ThirdOrderBarChart.set()
  • AnalysisPlot
    • AnalysisPlot.refresh()
    • AnalysisPlot.update_data()
    • AnalysisPlot.plot()
  • AstigmatismCurvePlot
    • AstigmatismCurvePlot.update_data()
    • AstigmatismCurvePlot.plot()
• rayoptics.mpl.axisarrayfigure module
  • Fit
    • Fit.All
    • Fit.All_Same
    • Fit.User_Scale
  • clip_to_range()
  • AxisArrayFigure
    • AxisArrayFigure.init_axis()
    • AxisArrayFigure.construct_plot_array()
    • AxisArrayFigure.wvl_to_sys_units()
    • AxisArrayFigure.refresh()
    • AxisArrayFigure.update_data()
    • AxisArrayFigure.plot()
    • AxisArrayFigure.set()
  • RayFanFigure
    • RayFanFigure.update_data()
    • RayFanFigure.plot()
    • RayFanFigure.set()
  • SpotDiagramFigure
    • SpotDiagramFigure.init_axis()
    • SpotDiagramFigure.update_data()
    • SpotDiagramFigure.plot()
    • SpotDiagramFigure.set()
  • WavefrontFigure
    • WavefrontFigure.init_axis()
    • WavefrontFigure.update_data()
    • WavefrontFigure.plot()
    • WavefrontFigure.set()
• rayoptics.mpl.interactivediagram module
  • InteractiveDiagram
    • InteractiveDiagram.opt_model
    • InteractiveDiagram.refresh_gui
    • InteractiveDiagram.dgm_type
    • InteractiveDiagram.enable_slide
    • InteractiveDiagram.bend_or_gap
    • InteractiveDiagram.parax_model
    • InteractiveDiagram.parax_model_key
    • InteractiveDiagram.setup_dgm_type()
    • InteractiveDiagram.sync_light_or_dark()
    • InteractiveDiagram.update_data()
    • InteractiveDiagram.get_artist_for_handle()
    • InteractiveDiagram.action_complete()
    • InteractiveDiagram.set()
    • InteractiveDiagram.fit_axis_limits()
• rayoptics.mpl.interactivefigure module
  • SelectInfo
    • SelectInfo.artist
    • SelectInfo.info
  • artist_str()
  • display_artist_and_event()
  • InteractiveFigure
    • InteractiveFigure.do_draw_frame
    • InteractiveFigure.do_draw_axes
    • InteractiveFigure.oversize_factor
    • InteractiveFigure.aspect
    • InteractiveFigure.artist_filter
    • InteractiveFigure.connect_events()
    • InteractiveFigure.disconnect_events()
    • InteractiveFigure.is_unit_aspect_ratio
    • InteractiveFigure.refresh()
    • InteractiveFigure.update_data()
    • InteractiveFigure.action_complete()
    • InteractiveFigure.register_action()
    • InteractiveFigure.register_pan()
    • InteractiveFigure.register_zoom_box()
    • InteractiveFigure.update_patches()
    • InteractiveFigure.create_patches()
    • InteractiveFigure.create_polygon()
    • InteractiveFigure.create_polyline()
    • InteractiveFigure.create_vertex()
    • InteractiveFigure.get_artist_for_handle()
    • InteractiveFigure.update_axis_limits()
    • InteractiveFigure.fit_axis_limits()
    • InteractiveFigure.set_view_bbox()
    • InteractiveFigure.fit()
    • InteractiveFigure.zoom()
    • InteractiveFigure.zoom_in()
    • InteractiveFigure.zoom_out()
    • InteractiveFigure.draw_frame()
    • InteractiveFigure.draw_axes()
    • InteractiveFigure.plot()
    • InteractiveFigure.find_artists_at_location()
    • InteractiveFigure.do_shape_action()
    • InteractiveFigure.on_select()
    • InteractiveFigure.on_key_press()
    • InteractiveFigure.on_motion()
    • InteractiveFigure.on_press()
    • InteractiveFigure.on_release()
    • InteractiveFigure.find_artists_and_hilite()
    • InteractiveFigure.set()
  • update_artist_hiliting()
  • PanAction
  • ZoomBoxAction
  • enter_polyline()
  • snap_to_grid_fct()
• rayoptics.mpl.interactivelayout module
  • InteractiveLayout
    • InteractiveLayout.opt_model
    • InteractiveLayout.refresh_gui
    • InteractiveLayout.offset_factor
    • InteractiveLayout.do_draw_parts
    • InteractiveLayout.part_filter
    • InteractiveLayout.do_draw_rays
    • InteractiveLayout.do_draw_beams
    • InteractiveLayout.do_draw_edge_rays
    • InteractiveLayout.do_draw_ray_fans
    • InteractiveLayout.num_rays_in_fan
    • InteractiveLayout.clip_rays
    • InteractiveLayout.do_paraxial_layout
    • InteractiveLayout.entity_factory_list
    • InteractiveLayout.sync_light_or_dark()
    • InteractiveLayout.set()
    • InteractiveLayout.update_data()
    • InteractiveLayout.action_complete()
    • InteractiveLayout.fit_axis_limits()
• rayoptics.mpl.styledfigure module
  • copy_styles()
  • apply_style()
  • StyledFigure
    • StyledFigure.sync_light_or_dark()
    • StyledFigure.set()