rayoptics.elem.layout module

Interactive 2D lens picture

The Lens Layout capability provides a 2D display of the optical model represented by shapes. Shapes contain dict attributes to manage the graphical rendering and editing actions associated with their parent objects. These attributes must include:

handles: named graphic handles for different aspects of the parent object

actions: functions for press, drag, and release actions

light_or_dark(is_dark=True)

create_optical_element(opt_model, e)

class OpticalElement(opt_model, e)

Bases: object

mediator class for rendering and editing optical elements

listobj_str()

update_shape(view)

render_color()

get_label()

edit_shape_actions()

class RayBundle(opt_model, fld, fld_label, wvl, start_offset, ray_table_callback=None, **kwargs)

Bases: object

class for ray bundle from a single field point

listobj_str()

get_label()

render_ray(ray, tfrms)

render_shape(rayset, tfrms)

update_shape(view)

edit_ray_bundle_actions()

class RayFanBundle(opt_model, ray_fan, start_offset, label='ray fan')

Bases: object

class for a RayFan from a single field point

listobj_str()

get_label()

render_ray(ray_pkg, tfrms)

update_shape(view)

class SingleRay(opt_model, ray, start_offset, label='single ray')

Bases: object

class for a Ray from a single field point

listobj_str()

get_label()

render_ray(ray_pkg, tfrms)

update_shape(view)

class ParaxialRay(opt_model, ray, color, seq_start=1, label='paraxial')

Bases: object

class for paraxial ray rendering/editing

listobj_str()

get_label()

render_ray(ray, tfrms)

update_shape(view)

apply_data(vertex, lcl_pt)

edit_paraxial_layout_actions()

class LensLayout(opt_model, is_dark=True, **kwargs)

Bases: object

manager for live layout graphics entities

sync_light_or_dark(is_dark)

system_length(ele_bbox, offset_factor=0.05)

returns system length and ray start offset

renderable_pt_nodes(part_filter='')

create_element_entities(view, part_filter='')

create_oe(e)

opaque wrapper for create_optical_element()

create_ray_entities(view, start_offset, **kwargs)

create_ray_fan_entities(view, start_offset, num_rays=21, **kwargs)

create_paraxial_ray_entities(view)

get_ray_table()

register_commands(*args, **kwargs)

add_element_cmd_actions(**kwargs)

split_gap(opt_model, idx, lcl_pt)

split g=gap[idx] into t_old = t_0 + t_k using t_0 = lcl_pt.x

add_elements(opt_model, idx, lcl_pt, create, **kwargs)

add_reflector(opt_model, idx, lcl_pt, create, **kwargs)

add_thinlens(opt_model, idx, lcl_pt, **kwargs)

add_lens(opt_model, idx, lcl_pt, **kwargs)

add_mirror(opt_model, idx, lcl_pt, **kwargs)

add_conic(opt_model, idx, lcl_pt, **kwargs)

add_doublet(opt_model, idx, lcl_pt, **kwargs)

class GlassDropAction

Bases: object

dragEnterEvent(canvas_fig, event)

dragMoveEvent(canvas_fig, event)

dragLeaveEvent(canvas_fig, event)

dropEvent(canvas_fig, event)