SystemList

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

Bases: DataclassList[System]

Parameters:
__init__(data=<factory>, baffles_blank=<factory>)
Parameters:
Return type:

None

Attributes

baffles

tol_iter

baffles_blank

data

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.Axes

reverse()

update()

rtype:

typing.NoReturn

Inheritance Diagram

digraph inheritancef530242e71 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "abc.ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",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="Helper class that provides a standard way to create an ABC using"]; "kgpy.mixin.Copyable" [URL="kgpy.mixin.Copyable.html#kgpy.mixin.Copyable",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"]; "abc.ABC" -> "kgpy.mixin.Copyable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.DataclassList" [URL="kgpy.mixin.DataclassList.html#kgpy.mixin.DataclassList",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="DataclassList(data: List[~ItemT] = <factory>)"]; "kgpy.mixin.Toleranceable" -> "kgpy.mixin.DataclassList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Copyable" -> "kgpy.mixin.DataclassList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "typing.Generic" -> "kgpy.mixin.DataclassList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Toleranceable" [URL="kgpy.mixin.Toleranceable.html#kgpy.mixin.Toleranceable",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"]; "abc.ABC" -> "kgpy.mixin.Toleranceable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.optics.systems.SystemList" [URL="kgpy.optics.systems.SystemList.html#kgpy.optics.systems.SystemList",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="SystemList(data: List[~ItemT] = <factory>, baffles_blank: 'BaffleList' = <factory>)"]; "kgpy.mixin.DataclassList" -> "kgpy.optics.systems.SystemList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "typing.Generic" [URL="https://docs.python.org/3/library/typing.html#typing.Generic",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="Abstract base class for generic types."]; }
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='wavelength', plot_vignetted=False, plot_baffles=True, plot_colorbar=True)
Return type:

matplotlib.axes._axes.Axes

Parameters:
reverse()
update()
Return type:

typing.NoReturn

property baffles: BaffleList
baffles_blank: BaffleList
data: typ.List[ItemT]
property tol_iter: Iterator[DataclassList]