rayoptics.elem.elements module

Module for element modeling

class GraphicsHandle(polydata, tfrm, polytype, color)

Bases: tuple

color

RGBA for the polydata or None for default

polydata

poly data in local coordinates

polytype

‘polygon’ (for filled) or ‘polyline’

tfrm

global transformation for polydata

create_thinlens(power=0.0, indx=1.5, sd=None, **kwargs)

create_mirror(c=0.0, r=None, cc=0.0, ec=None, power=None, profile=None, sd=None, **kwargs)

Create a sequence and element for a mirror.

Parameters:

• c – vertex curvature

• r – vertex radius of curvature

• cc – conic constant

• ec – = 1 + cc

• power – optical power of the mirror

• sd – semi-diameter

• profile – Spherical or Conic type, or a profile instance

lens_from_power(power=0.0, bending=0.0, th=None, sd=1.0, med=None, nom_wvl='d')

create_lens(power=0.0, bending=0.0, th=None, sd=1.0, med=None, lens=None, **kwargs)

Create a lens element chunk of sm, em, and pt tree

Parameters:

kwargs –

keyword arguments including:

• idx: insertion point in the sequential model

• t: the thickness following a chunk when inserting

• lens: tuple of cv1, cv2, th, glass_name_catalog, sd where:

  • cv1: front curvature

  • cv2: rear curvature

  • th: lens thickness

  • glass_input: a str, e.g. ‘N-BK7, Schott’ or index (+V-number)

  • sd: lens semi-diameter

achromat(power, Va, Vb)

Compute lens powers for a thin doublet achromat, given their V-numbers.

create_cemented_doublet(power=0.0, bending=0.0, th=None, sd=1.0, glasses=('N-BK7,Schott', 'N-F2,Schott'), **kwargs)

create_dummy_plane(sd=1.0, **kwargs)

create_air_gap(t=0.0, **kwargs)

create_from_file(filename, **kwargs)

create_assembly_from_seq(opt_model, idx1, idx2, **kwargs)

full_profile(profile, is_flipped, edge_extent, flat_id=None, hole_id=None, dir=1, steps=6)

Produce a 2d segmented approximation to the profile.

Parameters:

• profile – optical profile to be sampled

• is_flipped – the flipped state of the profile

• edge_extent – tuple with symmetric or asymetric bounds

• flat_id – if not None, inside diameter of flat zone

• hole_id – if not None, inside diameter of centered surface hole

• dir – sampling direction, +1 for up, -1 for down

• steps – number of profile curve samples

use_flat(do_flat, is_concave)

compute_flat(ifc, sd, under_fract=0.05)

encode_obj_reference(obj, obj_attr_str, attrs)

sync_obj_reference(obj, obj_attr_str, obj_dict, alt_attr_value)

class Part(*args, **kwargs)

Bases: Protocol

Abstract base class for all types of elements.

label_format: ClassVar[str]

label: str

parent: Any

is_flipped: bool = False

flip()

Called by opt_model.flip when a Part is flipped.

abstract do_flip()

Subclass action when it is flipped.

abstract sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

abstract sync_to_seq(seq_model: SequentialModel)

abstract tree(**kwargs) → Node

abstract idx_list() → List[int]

abstract reference_idx() → int

abstract reference_interface() → Interface

abstract profile_list() → List[SurfaceProfile]

abstract gap_list() → List[Gap]

abstract update_size() → None

abstract render_shape() → List[GraphicsHandle]

return a polyline that is representative of the cemented element.

abstract render_handles(opt_model) → Dict[str, GraphicsHandle]

abstract handle_actions() → Dict[str, Any]

do_flip_with_part_list(part_list: List[Part], flip_pt_tfrm) → None

Flip a list of parts around a flip_pt.

class Element(s1, s2, g, tfrm=None, idx=0, idx2=1, sd=1.0, label=None)

Bases: Part

Lens element domain model. Manage rendering and selection/editing.

An Element consists of 2 Surfaces, 1 Gap, and edge_extent information.

s1

first/origin Interface

s2

second/last Interface

gap

element thickness and material Gap

tfrm

global transform to element origin, (Rot3, trans3)

medium_name

the material filling the gap

flat1, flat2

semi-diameter of flat or None. Setting to None will result in re-evaluation of flat ID

do_flat1, do_flat2

‘if concave’, ‘always’, ‘never’, ‘if convex’

handles

dict of graphical entities

actions

dict of actions associated with the graphical handles

clut = <rayoptics.util.rgbtable.RGBTable object>

label_format: ClassVar[str] = 'E{}'

serial_number = 0

label: str

property sd

Semi-diameter

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

tree(**kwargs)

Build tree linking sequence to element model.

idx_list()

reference_idx()

reference_interface()

profile_list()

gap_list()

get_bending()

set_bending(bending)

do_flip()

Subclass action when it is flipped.

update_size()

extent()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class Mirror(ifc, tfrm=None, idx=0, sd=1.0, thi=None, z_dir=1.0, label=None)

Bases: Part

label_format: ClassVar[str] = 'M{}'

serial_number = 0

label: str

get_thi()

listobj_str()

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

tree(**kwargs)

reference_interface()

reference_idx()

idx_list()

profile_list()

gap_list()

do_flip()

Subclass action when it is flipped.

update_size()

extent()

substrate_offset()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class CementedElement(ifc_list, label=None)

Bases: Part

Cemented element domain model. Manage rendering and selection/editing.

A CementedElement consists of 3 or more Surfaces, 2 or more Gaps, and edge_extent information.

idxs

list of seq_model interface indices (depends on is_flipped)

ifcs

list of Interface

gaps

list of thickness and material Gap

tfrm

global transform to element origin, (Rot3, trans3)

medium_name

the material filling the gap

flats

semi-diameter of flat if ifc is concave, or None

handles

dict of graphical entities

actions

dict of actions associated with the graphical handles

clut = <rayoptics.util.rgbtable.RGBTable object>

label_format: ClassVar[str] = 'CE{}'

serial_number = 0

label: str

property sd

Semi-diameter

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

tree(**kwargs)

idx_list()

reference_idx()

reference_interface()

profile_list()

gap_list()

do_flip()

Subclass action when it is flipped.

update_size()

compute_inner_flat(idx, sd)

compute flats, if needed, for the inner cemented surfaces.

Parameters:

• idx – index of inner surface in profile list

• sd – the semi-diameter of the cemented element

This function is needed to handle the cases where one of the outer surfaces has a flat and the inner surface would intersect this flat. All inner cemented surfaces are assumed to be spherical. See model US007277232_Example04P.roa

extent()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class ThinElement(ifc, tfrm=None, idx=0, sd=None, label=None)

Bases: Part

label_format: ClassVar[str] = 'TL{}'

serial_number = 0

label: str

tree(**kwargs)

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

reference_interface()

reference_idx()

profile_list()

idx_list()

gap_list()

do_flip()

Subclass action when it is flipped.

update_size()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class DummyInterface(ifc, idx=0, sd=None, tfrm=None, label=None)

Bases: Part

label_format: ClassVar[str] = 'D{}'

serial_number = 0

label: str

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

tree(**kwargs)

reference_interface()

reference_idx()

interface_list()

profile_list()

idx_list()

gap_list()

do_flip()

Subclass action when it is flipped.

update_size()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class AirGap(g, idx=0, tfrm=None, label=None, z_dir=1, **kwargs)

Bases: Part

label_format: ClassVar[str] = 'AG{}'

serial_number = 0

label: str

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

tree(**kwargs)

reference_interface()

reference_idx()

profile_list()

idx_list()

gap_list()

do_flip()

Subclass action when it is flipped.

update_size()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class Assembly(part_list, idx=0, tfrm=None, label=None)

Bases: Part

label_format: ClassVar[str] = 'ASM{}'

serial_number = 0

label: str

sync_to_restore(ele_model, surfs, gaps, tfrms, profile_dict, parts_dict)

sync_to_seq(seq_model)

tree(**kwargs)

idx_list()

reference_idx()

reference_interface()

profile_list()

gap_list()

do_flip()

Subclass action when it is flipped.

update_size()

render_shape()

return a polyline that is representative of the cemented element.

render_handles(opt_model)

handle_actions()

parent: Any

class ElementModel(opt_model, **kwargs)

Bases: object

Maintain the element based representation of the optical model

opt_model

the OpticalModel

elements

list of element type things

reset()

sync_to_restore(opt_model)

reset_serial_numbers()

airgaps_from_sequence(seq_model, tfrms)

add airgaps and dummy interfaces to an older version model

add_dummy_interface_at_image(seq_model, tfrms)

update_model(**kwargs)

sync_to_seq(seq_model)

Update element positions and ref_idx using the sequential model.

sequence_elements()

Sort elements in order of reference interfaces in seq_model

relabel_airgaps()

add_element(e: Part)

remove_element(e: Part)

remove_node(e_node)

get_num_elements()

list_model(tag: str = '#element#assembly#dummyifc')

list_elements()

element_type(i)