rayoptics.elem package

Package providing support for element based optical modeling

The elem subpackage provides classes and functions for element based models and rendering. These include:

• Element based model, elements

• Geometric constituents including profiles and surface

• Lens layout and rendering support layout

• Coordinate transformation support transform

The element model is managed by the ElementModel class

Submodules

• rayoptics.elem.elements module
  • GraphicsHandle
    • GraphicsHandle.color
    • GraphicsHandle.polydata
    • GraphicsHandle.polytype
    • GraphicsHandle.tfrm
  • create_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()
  • Part
    • Part.label_format
    • Part.label
    • Part.parent
    • Part.is_flipped
    • Part.ele_token
    • Part.flip()
    • Part.do_flip()
    • Part.sync_to_restore()
    • Part.sync_to_seq()
    • Part.sync_to_ele_def()
    • Part.seq()
    • Part.tree()
    • Part.idx_list()
    • Part.reference_idx()
    • Part.reference_interface()
    • Part.profile_list()
    • Part.gap_list()
    • Part.update_size()
    • Part.render_shape()
    • Part.render_handles()
    • Part.handle_actions()
  • do_flip_with_part_list()
  • Element
    • Element.s1
    • Element.s2
    • Element.gap
    • Element.tfrm
    • Element.medium_name
    • Element.handles
    • Element.actions
    • Element.clut
    • Element.label_format
    • Element.serial_number
    • Element.default_ele_token
    • Element.sd
    • Element.listobj_str()
    • Element.sync_to_restore()
    • Element.sync_to_seq()
    • Element.sync_to_ele_def()
    • Element.seq()
    • Element.tree()
    • Element.idx_list()
    • Element.reference_idx()
    • Element.reference_interface()
    • Element.profile_list()
    • Element.gap_list()
    • Element.get_power()
    • Element.get_bending()
    • Element.set_bending()
    • Element.do_flip()
    • Element.update_size()
    • Element.extent()
    • Element.render_shape()
    • Element.render_handles()
    • Element.handle_actions()
  • SurfaceInterface
    • SurfaceInterface.label_format
    • SurfaceInterface.serial_number
    • SurfaceInterface.default_ele_token
    • SurfaceInterface.listobj_str()
    • SurfaceInterface.sync_to_restore()
    • SurfaceInterface.sync_to_seq()
    • SurfaceInterface.sync_to_ele_def()
    • SurfaceInterface.seq()
    • SurfaceInterface.tree()
    • SurfaceInterface.reference_interface()
    • SurfaceInterface.reference_idx()
    • SurfaceInterface.idx_list()
    • SurfaceInterface.profile_list()
    • SurfaceInterface.gap_list()
    • SurfaceInterface.do_flip()
    • SurfaceInterface.update_size()
    • SurfaceInterface.extent()
    • SurfaceInterface.render_shape()
    • SurfaceInterface.render_handles()
    • SurfaceInterface.handle_actions()
  • Mirror
    • Mirror.label_format
    • Mirror.serial_number
    • Mirror.default_ele_token
    • Mirror.listobj_str()
    • Mirror.sync_to_restore()
    • Mirror.get_thi()
    • Mirror.seq()
    • Mirror.tree()
    • Mirror.substrate_offset()
    • Mirror.render_shape()
    • Mirror.render_handles()
  • CementedElement
    • CementedElement.idxs
    • CementedElement.ifcs
    • CementedElement.gaps
    • CementedElement.tfrm
    • CementedElement.medium_name
    • CementedElement.flats
    • CementedElement.handles
    • CementedElement.actions
    • CementedElement.clut
    • CementedElement.label_format
    • CementedElement.serial_number
    • CementedElement.default_ele_token
    • CementedElement.sd
    • CementedElement.listobj_str()
    • CementedElement.sync_to_restore()
    • CementedElement.sync_to_seq()
    • CementedElement.sync_to_ele_def()
    • CementedElement.seq()
    • CementedElement.tree()
    • CementedElement.idx_list()
    • CementedElement.reference_idx()
    • CementedElement.reference_interface()
    • CementedElement.profile_list()
    • CementedElement.gap_list()
    • CementedElement.do_flip()
    • CementedElement.update_size()
    • CementedElement.compute_inner_flat()
    • CementedElement.extent()
    • CementedElement.render_shape()
    • CementedElement.render_as_surfs()
    • CementedElement.render_handles()
    • CementedElement.handle_actions()
  • ThinElement
    • ThinElement.label_format
    • ThinElement.serial_number
    • ThinElement.default_ele_token
    • ThinElement.seq()
    • ThinElement.tree()
    • ThinElement.sync_to_restore()
    • ThinElement.sync_to_seq()
    • ThinElement.sync_to_ele_def()
    • ThinElement.reference_interface()
    • ThinElement.reference_idx()
    • ThinElement.profile_list()
    • ThinElement.idx_list()
    • ThinElement.gap_list()
    • ThinElement.do_flip()
    • ThinElement.update_size()
    • ThinElement.render_shape()
    • ThinElement.render_handles()
    • ThinElement.handle_actions()
  • DummyInterface
    • DummyInterface.label_format
    • DummyInterface.serial_number
    • DummyInterface.default_ele_token
    • DummyInterface.sync_to_restore()
    • DummyInterface.sync_to_seq()
    • DummyInterface.sync_to_ele_def()
    • DummyInterface.seq()
    • DummyInterface.tree()
    • DummyInterface.reference_interface()
    • DummyInterface.reference_idx()
    • DummyInterface.interface_list()
    • DummyInterface.profile_list()
    • DummyInterface.idx_list()
    • DummyInterface.gap_list()
    • DummyInterface.do_flip()
    • DummyInterface.update_size()
    • DummyInterface.render_shape()
    • DummyInterface.render_handles()
    • DummyInterface.handle_actions()
  • Space
    • Space.label_format
    • Space.serial_number
    • Space.default_ele_token
    • Space.sync_to_restore()
    • Space.sync_to_seq()
    • Space.sync_to_ele_def()
    • Space.seq()
    • Space.tree()
    • Space.reference_interface()
    • Space.reference_idx()
    • Space.profile_list()
    • Space.idx_list()
    • Space.gap_list()
    • Space.do_flip()
    • Space.update_size()
    • Space.extent()
    • Space.cumulative_thi()
    • Space.render_shape()
    • Space.render_handles()
    • Space.apply_decenter_to_tfrm()
    • Space.handle_actions()
  • AirGap
    • AirGap.label_format
    • AirGap.serial_number
    • AirGap.default_ele_token
    • AirGap.sync_to_restore()
    • AirGap.seq()
    • AirGap.tree()
    • AirGap.render_handles()
  • Assembly
    • Assembly.label_format
    • Assembly.serial_number
    • Assembly.default_ele_token
    • Assembly.sync_to_restore()
    • Assembly.sync_to_seq()
    • Assembly.sync_to_ele_def()
    • Assembly.seq()
    • Assembly.tree()
    • Assembly.idx_list()
    • Assembly.reference_idx()
    • Assembly.reference_interface()
    • Assembly.profile_list()
    • Assembly.gap_list()
    • Assembly.do_flip()
    • Assembly.update_size()
    • Assembly.render_shape()
    • Assembly.render_handles()
    • Assembly.handle_actions()
  • ElementModel
    • ElementModel.opt_model
    • ElementModel.elements
    • ElementModel.reset()
    • ElementModel.sync_to_restore()
    • ElementModel.reset_serial_numbers()
    • ElementModel.save_serial_numbers()
    • ElementModel.restore_serial_numbers()
    • ElementModel.update_model()
    • ElementModel.apply_scale_factor()
    • ElementModel.sync_to_seq()
    • ElementModel.sequence_elements()
    • ElementModel.add_element()
    • ElementModel.remove_element()
    • ElementModel.remove_node()
    • ElementModel.get_num_elements()
    • ElementModel.list_model()
    • ElementModel.list_elements()
    • ElementModel.element_type()
    • ElementModel.build_ele_sg_lists()
    • ElementModel.list_ele_sg()
  • build_ele_def()
• rayoptics.elem.layout module
  • light_or_dark()
  • create_optical_element()
  • OpticalElement
    • OpticalElement.listobj_str()
    • OpticalElement.update_shape()
    • OpticalElement.render_color()
    • OpticalElement.get_label()
    • OpticalElement.edit_shape_actions()
  • RayBundle
    • RayBundle.listobj_str()
    • RayBundle.get_label()
    • RayBundle.render_ray()
    • RayBundle.render_shape()
    • RayBundle.update_shape()
    • RayBundle.edit_ray_bundle_actions()
  • RayFanBundle
    • RayFanBundle.listobj_str()
    • RayFanBundle.get_label()
    • RayFanBundle.render_ray()
    • RayFanBundle.update_shape()
  • SingleRay
    • SingleRay.listobj_str()
    • SingleRay.get_label()
    • SingleRay.render_ray()
    • SingleRay.update_shape()
  • ParaxialRay
    • ParaxialRay.listobj_str()
    • ParaxialRay.get_label()
    • ParaxialRay.render_ray()
    • ParaxialRay.update_shape()
    • ParaxialRay.apply_data()
    • ParaxialRay.edit_paraxial_layout_actions()
  • LensLayout
    • LensLayout.sync_light_or_dark()
    • LensLayout.system_length()
    • LensLayout.renderable_pt_nodes()
    • LensLayout.create_element_entities()
    • LensLayout.create_oe()
    • LensLayout.create_ray_entities()
    • LensLayout.create_ray_fan_entities()
    • LensLayout.create_paraxial_ray_entities()
    • LensLayout.get_ray_table()
    • LensLayout.register_commands()
    • LensLayout.add_element_cmd_actions()
  • split_gap()
  • add_elements()
  • add_reflector()
  • add_thinlens()
  • add_lens()
  • add_mirror()
  • add_conic()
  • add_doublet()
  • GlassDropAction
    • GlassDropAction.dragEnterEvent()
    • GlassDropAction.dragMoveEvent()
    • GlassDropAction.dragLeaveEvent()
    • GlassDropAction.dropEvent()
• rayoptics.elem.parttree module
  • PartTree
    • PartTree.sync_to_restore()
    • PartTree.update_model()
    • PartTree.is_empty()
    • PartTree.check_consistency()
    • PartTree.init_from_sequence()
    • PartTree.sort_tree_using_sequence()
    • PartTree.add_element_model_to_tree()
    • PartTree.add_element_to_tree()
    • PartTree.remove_element_from_tree()
    • PartTree.remove_node()
    • PartTree.node()
    • PartTree.obj_by_name()
    • PartTree.trim_node()
    • PartTree.parent_node()
    • PartTree.parent_object()
    • PartTree.get_child_filter()
    • PartTree.list_tree()
    • PartTree.list_tree_full()
    • PartTree.nodes_with_tag()
    • PartTree.list_model()
    • PartTree.build_pt_sg_lists()
    • PartTree.list_pt_sg()
    • PartTree.sync_part_tree_on_update()
    • PartTree.handle_object_image_tags()
  • sync_part_tree_on_restore()
  • sync_part_tree_on_restore_idkey()
  • sequence_to_elements()
  • find_ele_changes()
  • part_list_from_seq()
  • list_tree_all_from_node()
  • list_tree_from_node()
• rayoptics.elem.profiles module
  • resize_list()
  • intersect_parabola()
  • SurfaceProfile
    • SurfaceProfile.update()
    • SurfaceProfile.f()
    • SurfaceProfile.df()
    • SurfaceProfile.normal()
    • SurfaceProfile.sag()
    • SurfaceProfile.profile()
    • SurfaceProfile.apply_scale_factor()
    • SurfaceProfile.intersect()
    • SurfaceProfile.intersect_welford()
    • SurfaceProfile.intersect_spencer()
    • SurfaceProfile.intersect_scipy()
  • Spherical
    • Spherical.__init__()
    • Spherical.r
    • Spherical.listobj_str()
    • Spherical.copyFrom()
    • Spherical.copyDataFrom()
    • Spherical.mutate()
    • Spherical.apply_scale_factor()
    • Spherical.flip()
    • Spherical.intersect_tangent_plane()
    • Spherical.intersect()
    • Spherical.f()
    • Spherical.df()
    • Spherical.sag()
    • Spherical.profile()
  • Conic
    • Conic.__init__()
    • Conic.r
    • Conic.ec
    • Conic.listobj_str()
    • Conic.copyFrom()
    • Conic.copyDataFrom()
    • Conic.apply_scale_factor()
    • Conic.flip()
    • Conic.intersect_tangent_plane()
    • Conic.intersect()
    • Conic.f()
    • Conic.df()
    • Conic.sag()
    • Conic.profile()
  • append_pt_to_2d_profile()
  • aspheric_profile()
  • EvenPolynomial
    • EvenPolynomial.initial_size
    • EvenPolynomial.__init__()
    • EvenPolynomial.r
    • EvenPolynomial.ec
    • EvenPolynomial.get_by_order()
    • EvenPolynomial.set_by_order()
    • EvenPolynomial.listobj_str()
    • EvenPolynomial.copyFrom()
    • EvenPolynomial.copyDataFrom()
    • EvenPolynomial.calc_max_nonzero_coef()
    • EvenPolynomial.apply_scale_factor()
    • EvenPolynomial.flip()
    • EvenPolynomial.update()
    • EvenPolynomial.sag()
    • EvenPolynomial.f()
    • EvenPolynomial.df()
    • EvenPolynomial.profile()
  • RadialPolynomial
    • RadialPolynomial.initial_size
    • RadialPolynomial.__init__()
    • RadialPolynomial.r
    • RadialPolynomial.cc
    • RadialPolynomial.get_coef()
    • RadialPolynomial.set_coef()
    • RadialPolynomial.get_by_order()
    • RadialPolynomial.set_by_order()
    • RadialPolynomial.listobj_str()
    • RadialPolynomial.copyFrom()
    • RadialPolynomial.copyDataFrom()
    • RadialPolynomial.calc_max_nonzero_coef()
    • RadialPolynomial.apply_scale_factor()
    • RadialPolynomial.flip()
    • RadialPolynomial.update()
    • RadialPolynomial.sag()
    • RadialPolynomial.f()
    • RadialPolynomial.df()
    • RadialPolynomial.profile()
  • YToroid
    • YToroid.initial_size
    • YToroid.__init__()
    • YToroid.r
    • YToroid.rR
    • YToroid.ec
    • YToroid.get_by_order()
    • YToroid.set_by_order()
    • YToroid.listobj_str()
    • YToroid.copyFrom()
    • YToroid.copyDataFrom()
    • YToroid.calc_max_nonzero_coef()
    • YToroid.apply_scale_factor()
    • YToroid.flip()
    • YToroid.update()
    • YToroid.sag()
    • YToroid.fY()
    • YToroid.f()
    • YToroid.df()
    • YToroid.profile()
  • XToroid
    • XToroid.__init__()
    • XToroid.sag()
    • XToroid.f()
    • XToroid.df()
  • mutate_profile()
  • test()
• rayoptics.elem.sgz2ele module
  • flatten_visit()
  • SMVisitor
    • SMVisitor.print_visit()
    • SMVisitor.visit_seq_model()
    • SMVisitor.visit_surface()
    • SMVisitor.visit_lens()
    • SMVisitor.visit_mirror()
    • SMVisitor.visit_air()
    • SMVisitor.visit_thickness()
    • SMVisitor.visit_cemented()
    • SMVisitor.visit_mangin()
    • SMVisitor.visit_thin_lens()
    • SMVisitor.visit_dummy()
    • SMVisitor.visit_phantom()
    • SMVisitor.visit_object()
    • SMVisitor.visit_image()
    • SMVisitor.generic_visit()
• rayoptics.elem.surface module
  • InteractionMode
    • InteractionMode.Transmit
    • InteractionMode.Reflect
  • Surface
    • Surface.label
    • Surface.profile
    • Surface.clear_apertures
    • Surface.edge_apertures
    • Surface.interface_type()
    • Surface.listobj_str()
    • Surface.update()
    • Surface.sync_to_restore()
    • Surface.profile_cv
    • Surface.optical_power
    • Surface.set_optical_power()
    • Surface.apply_scale_factor()
    • Surface.from_first_order()
    • Surface.update_following_reflection()
    • Surface.z_sag()
    • Surface.set_z_sag()
    • Surface.calc_cv_from_zsag()
    • Surface.flip()
    • Surface.set_max_aperture()
    • Surface.surface_od()
    • Surface.point_inside()
    • Surface.edge_pt_target()
    • Surface.get_y_aperture_extent()
    • Surface.full_profile()
    • Surface.intersect()
    • Surface.normal()
  • DecenterData
    • DecenterData.listobj_str()
    • DecenterData.dtype
    • DecenterData.update()
    • DecenterData.apply_scale_factor()
    • DecenterData.tform_before_surf()
    • DecenterData.tform_after_surf()
  • Aperture
    • Aperture.sync_to_restore()
    • Aperture.listobj_str()
    • Aperture.dimension()
    • Aperture.set_dimension()
    • Aperture.max_dimension()
    • Aperture.point_inside()
    • Aperture.bounding_box()
    • Aperture.apply_scale_factor()
    • Aperture.tform()
  • Circular
    • Circular.listobj_str()
    • Circular.dimension()
    • Circular.set_dimension()
    • Circular.max_dimension()
    • Circular.point_inside()
    • Circular.edge_pt_target()
    • Circular.apply_scale_factor()
  • Rectangular
    • Rectangular.listobj_str()
    • Rectangular.dimension()
    • Rectangular.set_dimension()
    • Rectangular.point_inside()
    • Rectangular.edge_pt_target()
    • Rectangular.apply_scale_factor()
  • Elliptical
    • Elliptical.listobj_str()
    • Elliptical.dimension()
    • Elliptical.set_dimension()
    • Elliptical.apply_scale_factor()
• rayoptics.elem.transform module
  • compute_global_coords()
  • compute_local_transforms()
  • list_tfrms()
  • forward_transform()
  • reverse_transform()
  • cascade_transform()
  • transfer_coords()
  • transform_before_surface()
  • transform_after_surface()