rayoptics.elem.parttree module

Manage connectivity between sequence and element models using a tree.

class PartTree(opt_model, **kwargs)

Bases: object

sync_to_restore(opt_model)

update_model(**kwargs)

is_empty()

check_consistency(seq_model, ele_model)

init_from_sequence(seq_model)

Initialize part tree using a seq_model.

sort_tree_using_sequence(seq_model)

Resequence part tree using a seq_model.

add_element_model_to_tree(ele_model)

add_element_to_tree(e, **kwargs)

remove_element_from_tree(e, **kwargs)

remove_node(e_node, merge=True, **kwargs)

Remove e_node and all related seq_model dependencies.

If merge is True, delete the AirGap following e_node and add it’s thickness to the AirGap preceding e_node.

node(obj)

Return the node paired with obj.

obj_by_name(name)

Return the node paired with obj.

trim_node(obj)

Remove the branch where obj is the sole leaf.

parent_node(obj, tag='#element#space#dummyifc')

Return the parent node for obj, filtered by tag.

parent_object(obj, tag='#element#space#dummyifc')

Return the parent object (and node) for obj, filtered by tag.

get_child_filter(tag='#element#assembly', not_tag='')

Returns a fct that filters a list of nodes to satisfy the tags

list_tree(*args, **kwargs)

Print a graphical console representation of the tree.

The optional arguments are passed through to the by_attr filter. Useful examples or arguments include:

• pt.list_tree(lambda node: f”{node.name}: {node.tag}”)

• pt.list_tree(attrname=’tag’)

list_tree_full()

Print a graphical console representation of the tree with tags.

nodes_with_tag(tag='#element', not_tag='', root=None, node_list=None)

Return a list of nodes that contain the requested tag.

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

build_pt_sg_lists()

list_pt_sg()

sync_part_tree_on_update(ele_model, seq_model, root_node)

Update node names to track element labels.

The node labels for the children of parts are handled here. At the leaf level, the node names encode the interface or gap index. At the element level, the indexing is modified for element flip.

handle_object_image_tags(seq_model)

Ensure nodes for object and image ifcs and gaps are tagged.

sync_part_tree_on_restore(opt_model, ele_model, seq_model, root_node)

sync_part_tree_on_restore_idkey(opt_model, ele_model, seq_model, root_node)

sequence_to_elements(seq_model, ele_model, part_tree)

Parse the seq_model into elements and update ele_model accordingly.

find_ele_changes(seq_model, ele_model, part_tree, print_visit=False)

Parse the seq_model into elements and categorize the changes.

Returns:

list of ele_defs in common between sm and pt added_ele: list of ele_defs for new elements to be created removed_ele: list of ele_defs to be removed modified_ele: list of existing elements to be updated from new ele_defs sme_list: ele_defs obtained by parsing the seq_model seq_str: character encoding of seq_model ifcs and gaps eme_list: ele_defs for current elements in the element model eme_dict: key: ele_def returns the value: element asm_list: ele_defs for current assemblies in the element/part model asm_dict: key: ele_def the value: assembly

Return type:

common_ele

part_list_from_seq(opt_model, idx1, idx2)

Using the part_tree, return the parts for the input sequence range.

list_tree_all_from_node(node, **kwargs)

List the tree from node with full node output.

list_tree_from_node(node, *args, **kwargs)

List the tree from node with attribute filtering.

The optional arguments are passed through to the by_attr filter. Useful examples or arguments include:

• pt.list_tree(lambda node: f”{node.name}: {node.tag}”)

• pt.list_tree(attrname=’tag’)