BaffleList

class kgpy.optics.baffles.BaffleList(initlist=None)

Bases: UserList

__init__(initlist=None)

Methods

__init__([initlist])
append(item)	S.append(value) -- append value to the end of the sequence
clear()
concat_apertures_from_global_positions(...)
concat_apertures_from_lofts(lofts[, ...])	rtype: kgpy.optics.baffles.BaffleList
concat_apertures_from_raytrace(raytrace[, ...])	rtype: kgpy.optics.baffles.BaffleList
copy()
count(value)
extend(other)	S.extend(iterable) -- extend sequence by appending elements from the iterable
index(value, [start, [stop]])	Raises ValueError if the value is not present.
insert(i, item)	S.insert(index, value) -- insert value before index
plot([ax, components, plot_kwargs, ...])	rtype: matplotlib.axes._axes.Axes
pop([index])	Raise IndexError if list is empty or index is out of range.
remove(item)	S.remove(value) -- remove first occurrence of value.
reverse()	S.reverse() -- reverse IN PLACE
sort(*args, **kwds)
to_dxf(file_base)

Inheritance Diagram

digraph inheritancea6e32a1ad7 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "collections.UserList" [URL="https://docs.python.org/3/library/collections.html#collections.UserList",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A more or less complete user-defined wrapper around list objects."]; "collections.abc.MutableSequence" -> "collections.UserList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Collection" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.Collection",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "collections.abc.Sized" -> "collections.abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Iterable" -> "collections.abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Container" -> "collections.abc.Collection" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Container" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.Container",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "collections.abc.Iterable" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "collections.abc.MutableSequence" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.MutableSequence",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "collections.abc.Sequence" -> "collections.abc.MutableSequence" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Reversible" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.Reversible",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "collections.abc.Iterable" -> "collections.abc.Reversible" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Sequence" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="All the operations on a read-only sequence."]; "collections.abc.Reversible" -> "collections.abc.Sequence" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Collection" -> "collections.abc.Sequence" [arrowsize=0.5,style="setlinewidth(0.5)"]; "collections.abc.Sized" [URL="https://docs.python.org/3/library/collections.abc.html#collections.abc.Sized",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "kgpy.optics.baffles.BaffleList" [URL="kgpy.optics.baffles.BaffleList.html#kgpy.optics.baffles.BaffleList",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "collections.UserList" -> "kgpy.optics.baffles.BaffleList" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

append(item)

S.append(value) – append value to the end of the sequence

clear() → None -- remove all items from S

concat_apertures_from_global_positions(position_1, position_2, mask=None, hull_axes=None)

Parameters:

• position_1 (Cartesian3D) –

• position_2 (Cartesian3D) –

• mask (Optional) –

• hull_axes (Sequence[int] | None) –

Return type:

BaffleList

concat_apertures_from_lofts(lofts, transform_extra=None, color='black')

Return type:

kgpy.optics.baffles.BaffleList

Parameters:

• lofts (Dict[int, Tuple[Surface, Surface]]) –

• transform_extra (TransformList | None) –

• color (str) –

concat_apertures_from_raytrace(raytrace, transform_extra=None, hull_axes=None, color='black')

Return type:

kgpy.optics.baffles.BaffleList

Parameters:

• raytrace (RayFunctionList) –

• transform_extra (TransformList | None) –

• hull_axes (Sequence[int] | None) –

• color (str) –

copy()

count(value) → integer -- return number of occurrences of value

extend(other)

S.extend(iterable) – extend sequence by appending elements from the iterable

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(i, item)

S.insert(index, value) – insert value before index

plot(ax=None, components=('x', 'y'), plot_kwargs=None, transform_extra=None, plot_apertures_base=False)

Return type:

matplotlib.axes._axes.Axes

Parameters:

• ax (Axes | None) –

• components (Tuple[str, str]) –

• plot_kwargs (Dict[str, Any] | None) –

• transform_extra (TransformList | None) –

• plot_apertures_base (bool) –

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(item)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

sort(*args, **kwds)

to_dxf(file_base)

Parameters:

file_base (Path) –