SystemList

class kgpy.optics.SystemList(data=<factory>, baffles_blank=<factory>)

Bases: DataclassList[System]

__init__(data=<factory>, baffles_blank=<factory>)

Parameters

• data (List[ItemT]) –

• baffles_blank (BaffleList) –

Return type

None

Attributes

baffles
tol_iter
baffles_blank

Methods

__init__([data, baffles_blank])
append(item)	rtype typing.NoReturn
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
count(value)	rtype int
index(value)	rtype int
plot([ax, components, transform_extra, ...])	rtype matplotlib.axes.Axes
reverse()
update()	rtype typing.NoReturn

Inheritance Diagram

append(item)

Return type

typing.NoReturn

Parameters

item (ItemT) –

copy()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

copy_shallow()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

count(value)

Return type

int

Parameters

value (ItemT) –

index(value)

Return type

int

Parameters

value (ItemT) –

plot(ax=None, components=('x', 'y'), transform_extra=None, plot_rays=True, color_axis=-2, plot_vignetted=False, plot_baffles=True, plot_colorbar=True)

Return type

matplotlib.axes.Axes

Parameters

• ax (Optional[Axes]) –

• components (Tuple[str, str]) –

• transform_extra (Optional[TransformList]) –

• plot_rays (bool) –

• color_axis (int) –

• plot_vignetted (bool) –

• plot_baffles (bool) –

• plot_colorbar (bool) –

reverse()

update()

Return type

typing.NoReturn

property baffles: BaffleList

baffles_blank: kgpy.optics.baffle.BaffleList

data: typ.List[ItemT]

property tol_iter: Iterator[DataclassList]