rayoptics package
The ray-optics geometrical ray tracing and optical modeling and analysis package
The optical model is contained in the optical subpackage. It is
supported by the following subpackages:
optical: OpticalModel and OpticalBench import
seq: support for the Sequential model
elem: Element and PartTree models, geometry support, e.g. for profiles
oprops: optical property and actions
parax: support for paraxial optical design
raytr: support for ray tracing and analysis
codev: handles import of CODE V .seq files
zemax: handles import of Zemax .zmx files
opticalglass: this package interfaces with glass manufacturer optical data and the RefractiveIndex.Info website
The gui subpackage is a layer that implements the platform
neutral part of the graphical user interface.
The mpl subpackage implements a variety of plotting/charting
based graphics using the matplotlib package. The
qtgui subpackage implements a desktop ui style application using
Qt featuring interactive layouts and diagrams.
The util subpackage provides a variety of different math
and other miscellaneous calculations.
- listobj(obj)[source]
Print wrapper function for listobj_str() method of obj.
listobj() is designed to be used in scripting environments where detailed, textual output is supported. It is a wrapper to a call of listobj_str on obj.
Classes may implement the listobj_str method that returns a string containing a formatted description of the object. Multi-line strings are allowed; each line should end with a newline character. Examples include
DecenterData.listobj_str()andEvenPolynomial.listobj_str().
Subpackages
- rayoptics.codev package
- Submodules
- rayoptics.codev.cmdproc module
fictitious_glass_decode()read_lens()process_command()log_cmd()post_process_input()wvl_spec_data()pupil_spec_data()field_spec_data()spec_data()get_index_qualifier()surface_cmd()update_surface_and_gap()private_catalog()surface_data()update_surface_profile()profile_data()aperture_data()aperture_data_general()aperture_offset()decenter_data()diffractive_optic()CVGlassHandler
- rayoptics.codev.reader module
- rayoptics.codev.tla module
- rayoptics.codev.cmdproc module
- Submodules
- rayoptics.elem package
- Submodules
- rayoptics.elem.elements module
GraphicsHandlecreate_thinlens()create_mirror()lens_from_power()create_lens()create_lens_from_dgm()achromat()create_cemented_doublet()create_dummy_plane()create_air_gap()create_from_file()create_assembly_from_seq()render_lens_shape()render_surf_shape()full_profile()is_concave()use_flat()compute_flat()encode_obj_reference()sync_obj_reference()Partdo_flip_with_part_list()ElementSurfaceInterfaceMirrorCementedElementThinElementDummyInterfaceSpaceAirGapAssemblyElementModelbuild_ele_def()
- rayoptics.elem.layout module
- rayoptics.elem.parttree module
- rayoptics.elem.profiles module
- rayoptics.elem.sgz2ele module
- rayoptics.elem.surface module
- rayoptics.elem.transform module
- rayoptics.elem.elements module
- Submodules
- rayoptics.gui package
- rayoptics.mpl package
- rayoptics.oprops package
- rayoptics.optical package
- rayoptics.parax package
- Submodules
- rayoptics.parax.diagram module
light_or_dark()Diagramcompute_slide_line()constrain_to_line_action()DiagramNodeDiagramEdgeBarrelConstraintConjugateLineEditNodeActionEditLensActionEditAreaActionEditThicknessActionEditBendingActionAddReplaceElementActionAddElementActionReplaceElementActionGlassDropActionadd_shape()context_menu_actions()
- rayoptics.parax.etendue module
- rayoptics.parax.firstorder module
- rayoptics.parax.idealimager module
- rayoptics.parax.paraxialdesign module
bbox_from_poly()calculate_slope()ParaxialModelnodes_to_new_model()populate_model_from_parax()create_diagram_for_key()update_diagram_for_key()generate_mapping_for_key()air_gaps_to_node_defs()get_valid_ht_nodes()ht_nodes_from_node_defs()slp_nodes_from_node_defs()scan_nodes()build_from_yybar()gen_ifcs_node_mapping()opt_inv_from_dgm_and_osp()calc_object_and_pupil_from_dgm()compute_principle_points_from_dgm()specsheet_from_dgm()update_from_dgm()parax_to_dgms()dgms_to_parax()
- rayoptics.parax.specsheet module
- rayoptics.parax.thirdorder module
- rayoptics.parax.diagram module
- Submodules
- rayoptics.qtgui package
- Submodules
- rayoptics.qtgui.dockpanels module
- rayoptics.qtgui.guiappcmds module
create_new_ideal_imager_dialog()get_defaults_from_gui_parent()create_live_layout_view()create_paraxial_design_view_v2()create_ray_fan_view()create_ray_grid_view()create_wavefront_view()create_field_curves()create_3rd_order_bar_chart()create_glass_map_view()update_table_view()create_lens_table_model()create_element_table_model()create_ray_table_model()create_parax_table_model()create_parax_model_table()
- rayoptics.qtgui.idealimagerdialog module
- rayoptics.qtgui.ipyconsole module
- rayoptics.qtgui.plotview module
PlotCanvasNullDropActionupdate_figure_view()CommandItemcreate_command_panel()on_command_clicked()create_plot_view()create_glass_map_view()on_plot_scale_toggled()on_plot_scale_changed()create_plot_scale_panel()create_multi_plot_scale_panel()get_icon()create_2d_figure_toolbar()create_draw_rays_groupbox()create_diagram_controls_groupbox()create_diagram_edge_actions_groupbox()create_diagram_layers_groupbox()create_handle_context_menu()
- rayoptics.qtgui.pytablemodel module
- rayoptics.qtgui.pytableview module
- rayoptics.qtgui.rayopticsapp module
- Submodules
- rayoptics.raytr package
RayResultRayPkgRaySeg- Submodules
- rayoptics.raytr.analyses module
RayRayFanselect_plot_data()smooth_plot_data()trace_ray_fan()eval_fan()trace_fan()focus_fan()RayListtrace_ray_list()trace_list_of_rays()eval_pupil_coords()trace_pupil_coords()focus_pupil_coords()RayGridtrace_ray_grid()eval_wavefront()trace_wavefront()focus_wavefront()psf_sampling()calc_psf_scaling()calc_psf()update_psf_data()
- rayoptics.raytr.opticalspec module
- rayoptics.raytr.raytrace module
- rayoptics.raytr.sampler module
- rayoptics.raytr.trace module
ray_pkg()ray_df()list_ray()list_in_out_dir()trace_ray()trace_safe()trace()trace_base()iterate_ray()trace_with_opd()trace_boundary_rays_at_field()boundary_ray_dict()trace_boundary_rays()trace_ray_list_at_field()trace_field()trace_all_fields()trace_chief_ray()trace_fan()trace_grid()setup_pupil_coords()aim_chief_ray()apply_paraxial_vignetting()get_chief_ray_pkg()refocus()trace_astigmatism_coddington_fan()trace_coddington_fan()intersect_2_lines()trace_astigmatism_curve()trace_astigmatism()iterate_ray_raw()
- rayoptics.raytr.traceerror module
- rayoptics.raytr.vigcalc module
- rayoptics.raytr.waveabr module
calculate_reference_sphere()transfer_to_exit_pupil()eic_distance()ray_dist_to_perp_from_pt()ray_dist_to_perp_from_origin()dist_to_shortest_join()wave_abr_full_calc()wave_abr_pre_calc()wave_abr_calc()wave_abr_full_calc_finite_pup()wave_abr_pre_calc_finite_pup()wave_abr_calc_finite_pup()wave_abr_full_calc_inf_ref()wave_abr_pre_calc_inf_ref()wave_abr_calc_inf_ref()
- rayoptics.raytr.wideangle module
- rayoptics.raytr.analyses module
- rayoptics.seq package
- rayoptics.util package
str_to_class()- Submodules
- rayoptics.util.colors module
- rayoptics.util.colour_system module
- rayoptics.util.dict2d module
- rayoptics.util.line_intersection module
- rayoptics.util.misc_math module
infinity_guard()is_kinda_big()normalize()distance_sqr_2d()perpendicular_distance_2d()perpendicular_to_radial()perpendicular_to_line()perpendicular_from_origin()projected_point_on_line()projected_point_on_radial_line()projected_point_on_radial_line_full()rot_v1_into_v2()euler2opt()euler2rot3d()isanumber()transpose()circle_intersection_area()compute_tangent_point_to_circle()
- rayoptics.util.rgb2mpl module
- rayoptics.util.rgbtable module
- rayoptics.zemax package