BaffleList

class kgpy.optics.baffle.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.baffle.BaffleList
concat_apertures_from_raytrace(raytrace[, ...])	rtype kgpy.optics.baffle.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
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

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 (Vector3D) –

• position_2 (Vector3D) –

• mask (Optional) –

• hull_axes (Optional[Sequence[int]]) –

Return type

BaffleList

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

Return type

kgpy.optics.baffle.BaffleList

Parameters

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

• transform_extra (Optional[TransformList]) –

• color (str) –

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

Return type

kgpy.optics.baffle.BaffleList

Parameters

• raytrace (RaysList) –

• transform_extra (Optional[TransformList]) –

• hull_axes (Optional[Sequence[int]]) –

• 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

Parameters

• ax (Optional[Axes]) –

• components (Tuple[str, str]) –

• plot_kwargs (Optional[Dict[str, Any]]) –

• transform_extra (Optional[TransformList]) –

• 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) –