rayoptics.parax package

Package for paraxial optical design and analysis

The parax subpackage provides core classes and functions for paraxial/first order optical design. These include:

• Definition of the first order quantities defining an optical system, specsheet, idealimager, and etendue

• Paraxial and third order calculations, firstorder, thirdorder

• Support for \(y-\overline{y}\) and \(\omega-\overline{\omega}\) diagrams, paraxialdesign and diagram

The paraxial model is managed by the ParaxialModel class

Submodules

• rayoptics.parax.diagram module
  • light_or_dark()
  • Diagram
    • Diagram.setup_dgm_type()
    • Diagram.get_label()
    • Diagram.sync_light_or_dark()
    • Diagram.set_active_layer()
    • Diagram.update_data()
    • Diagram.apply_data()
    • Diagram.assign_object_to_node()
    • Diagram.register_commands()
    • Diagram.register_add_replace_element()
    • Diagram.render_shape()
    • Diagram.update_diagram_from_shape()
    • Diagram.fit_axis_limits()
  • compute_slide_line()
  • constrain_to_line_action()
  • DiagramNode
    • DiagramNode.listobj_str()
    • DiagramNode.update_shape()
    • DiagramNode.get_label()
    • DiagramNode.handle_actions()
  • DiagramEdge
    • DiagramEdge.listobj_str()
    • DiagramEdge.update_shape()
    • DiagramEdge.render_color()
    • DiagramEdge.get_label()
    • DiagramEdge.handle_actions()
  • BarrelConstraint
    • BarrelConstraint.listobj_str()
    • BarrelConstraint.update_shape()
    • BarrelConstraint.get_label()
    • BarrelConstraint.handle_actions()
  • ConjugateLine
    • ConjugateLine.listobj_str()
    • ConjugateLine.update_shape()
    • ConjugateLine.get_label()
    • ConjugateLine.edit_conjugate_line_actions()
    • ConjugateLine.handle_actions()
  • EditNodeAction
  • EditLensAction
  • EditAreaAction
  • EditThicknessAction
  • EditBendingAction
  • AddReplaceElementAction
    • AddReplaceElementAction.SelectInfo
      • AddReplaceElementAction.SelectInfo.artist
      • AddReplaceElementAction.SelectInfo.info
  • AddElementAction
  • ReplaceElementAction
  • GlassDropAction
    • GlassDropAction.dragEnterEvent()
    • GlassDropAction.dragMoveEvent()
    • GlassDropAction.dragLeaveEvent()
    • GlassDropAction.dropEvent()
  • add_shape()
  • context_menu_actions()
• rayoptics.parax.etendue module
  • create_etendue_dict()
  • na2slp()
  • slp2na()
  • ang2slp()
  • slp2ang()
  • get_aperture_from_slope()
  • get_slope_from_aperture()
  • calc_aperture_from_input()
  • do_etendue_via_imager()
  • do_field_via_imager()
  • do_aperture_via_imager()
  • do_etendue_to_imager()
  • fill_in_etendue_data()
• rayoptics.parax.firstorder module
  • ParaxData
    • ParaxData.ax_ray
    • ParaxData.fod
    • ParaxData.pr_ray
  • FirstOrderData
    • FirstOrderData.opt_inv
    • FirstOrderData.power
    • FirstOrderData.efl
    • FirstOrderData.fl_obj
    • FirstOrderData.fl_img
    • FirstOrderData.pp1
    • FirstOrderData.ppk
    • FirstOrderData.pp_sep
    • FirstOrderData.ffl
    • FirstOrderData.bfl
    • FirstOrderData.fno
    • FirstOrderData.m
    • FirstOrderData.red
    • FirstOrderData.n_obj
    • FirstOrderData.n_img
    • FirstOrderData.obj_dist
    • FirstOrderData.img_dist
    • FirstOrderData.obj_ang
    • FirstOrderData.img_ht
    • FirstOrderData.enp_dist
    • FirstOrderData.enp_radius
    • FirstOrderData.exp_dist
    • FirstOrderData.exp_radius
    • FirstOrderData.obj_na
    • FirstOrderData.img_na
    • FirstOrderData.listobj_str()
    • FirstOrderData.list_first_order_data()
  • paraxial_trace()
  • get_parax_matrix()
  • compute_first_order()
  • compute_principle_points()
  • list_parax_trace_fotr()
  • list_parax_trace()
  • specsheet_from_parax_data()
• rayoptics.parax.idealimager module
  • IdealImager
    • IdealImager.f
    • IdealImager.m
    • IdealImager.s
    • IdealImager.sp
    • IdealImager.tt
  • ideal_imager_setup()
• rayoptics.parax.paraxialdesign module
  • bbox_from_poly()
  • calculate_slope()
  • ParaxialModel
    • ParaxialModel.sync_to_restore()
    • ParaxialModel.update_model()
    • ParaxialModel.sync_to_seq()
    • ParaxialModel.set_from_specsheet()
    • ParaxialModel.build_lens()
    • ParaxialModel.parax_from_dgms()
    • ParaxialModel.get_num_nodes()
    • ParaxialModel.parax_to_nodes()
    • ParaxialModel.update_parax_to_dgms()
    • ParaxialModel.replace_node_with_dgm()
    • ParaxialModel.nodes_to_parax()
    • ParaxialModel.get_pt()
    • ParaxialModel.get_pt_np()
    • ParaxialModel.set_pt()
    • ParaxialModel.apply_scale_factor()
    • ParaxialModel.get_gap_for_node()
    • ParaxialModel.add_node()
    • ParaxialModel.assign_object_to_node()
    • ParaxialModel.compute_signed_rindx()
    • ParaxialModel.replace_node_with_seq()
    • ParaxialModel.get_object_for_node()
    • ParaxialModel.delete_node()
    • ParaxialModel.apply_ht_dgm_data()
    • ParaxialModel.apply_slope_dgm_data()
    • ParaxialModel.process_seq_mapping()
    • ParaxialModel.update_composite_node_fct()
    • ParaxialModel.update_rindex()
    • ParaxialModel.paraxial_trace()
    • ParaxialModel.list_model()
    • ParaxialModel.list_lens()
    • ParaxialModel.list_sys_seq()
    • ParaxialModel.first_order_data()
    • ParaxialModel.seq_path_to_paraxial_lens()
    • ParaxialModel.paraxial_lens_to_seq_model()
    • ParaxialModel.lens_from_dgm()
    • ParaxialModel.calc_object_and_pupil()
    • ParaxialModel.pwr_slope_solve()
    • ParaxialModel.pwr_ht_solve()
    • ParaxialModel.thi_ht_solve()
    • ParaxialModel.set_paraxial_focus()
    • ParaxialModel.compute_principle_points_from_dgm()
    • ParaxialModel.apply_conjugate_shift()
    • ParaxialModel.calc_conjugate_shift()
    • ParaxialModel.match_pupil_and_conj()
    • ParaxialModel.paraxial_vignetting()
    • ParaxialModel.dgm_sketch_to_parax_model()
  • nodes_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
  • create_specsheet()
  • create_specsheets()
  • create_specsheet_from_model()
  • SpecSheet
    • SpecSheet.conjugate_type
    • SpecSheet.imager
    • SpecSheet.imager_inputs
    • SpecSheet.frozen_imager_inputs
    • SpecSheet.etendue_inputs
    • SpecSheet.etendue_values
    • SpecSheet.partitions
    • SpecSheet.listobj_str()
    • SpecSheet.sync_to_restore()
    • SpecSheet.imager_defined()
    • SpecSheet.partition_defined()
    • SpecSheet.generate_from_inputs()
    • SpecSheet.get_etendue_inputs()
    • SpecSheet.get_parax_start_data()
• rayoptics.parax.thirdorder module
  • compute_third_order()
  • calc_4th_order_aspheric_term()
  • aspheric_seidel_contribution()
  • seidel_to_wavefront()
  • seidel_to_transverse_aberration()
  • seidel_to_field_curv()