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:
The element model is managed by the ElementModel
class
Submodules
- rayoptics.elem.elements module
GraphicsHandle
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()
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.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.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.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
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.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.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.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.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.render_shape()
Space.render_handles()
Space.handle_actions()
AirGap
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.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
RayBundle
RayFanBundle
SingleRay
ParaxialRay
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
- 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.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
Spherical
Conic
append_pt_to_2d_profile()
aspheric_profile()
EvenPolynomial
EvenPolynomial.__init__()
EvenPolynomial.r
EvenPolynomial.ec
EvenPolynomial.listobj_str()
EvenPolynomial.copyFrom()
EvenPolynomial.copyDataFrom()
EvenPolynomial.gen_coef_list()
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.listobj_str()
RadialPolynomial.copyFrom()
RadialPolynomial.copyDataFrom()
RadialPolynomial.gen_coef_list()
RadialPolynomial.apply_scale_factor()
RadialPolynomial.flip()
RadialPolynomial.update()
RadialPolynomial.sag()
RadialPolynomial.f()
RadialPolynomial.df()
RadialPolynomial.profile()
YToroid
XToroid
mutate_profile()
test()
- rayoptics.elem.sgz2ele module
flatten_visit()
SMVisitor
SMVisitor.print_visit()
SMVisitor.visit_seq_model()
SMVisitor.visit_space()
SMVisitor.visit_surface()
SMVisitor.visit_lens()
SMVisitor.visit_mirror()
SMVisitor.visit_air()
SMVisitor.visit_cemented()
SMVisitor.visit_mangin()
SMVisitor.visit_thin_lens()
SMVisitor.visit_dummy()
SMVisitor.visit_object()
SMVisitor.visit_image()
SMVisitor.generic_visit()
- rayoptics.elem.surface module
InteractionMode
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
Aperture
Circular
Rectangular
Elliptical
- rayoptics.elem.transform module