RayFunctionList

class kgpy.optics.rays.RayFunctionList(data=<factory>, plot_kwargs=<factory>)

Bases: WritableMixin, Plottable, DataclassList[RayFunction]

Parameters:

• data (List[ItemT]) –

• plot_kwargs (Dict[str, Any]) –

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

Parameters:

• data (List[ItemT]) –

• plot_kwargs (Dict[str, Any]) –

Return type:

None

Attributes

intercepts
tol_iter
plot_kwargs
data

Methods

__init__([data, plot_kwargs])
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[, component_x, component_y, ...])	rtype: typing.Tuple[typing.List[matplotlib.lines.Line2D], typing.Optional[matplotlib.colorbar.Colorbar]]
reverse()
to_dxf(filename[, dxf_unit])
write_to_dxf(file_writer, unit[, ...])	rtype: None

Inheritance Diagram

digraph inheritance641c898f0e { 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.io.dxf.WritableMixin" [URL="kgpy.io.dxf.WritableMixin.html#kgpy.io.dxf.WritableMixin",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="WritableMixin()"]; "abc.ABC" -> "kgpy.io.dxf.WritableMixin" [arrowsize=0.5,style="setlinewidth(0.5)"]; "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.Plottable" [URL="kgpy.mixin.Plottable.html#kgpy.mixin.Plottable",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="Plottable(plot_kwargs: Dict[str, Any] = <factory>)"]; "kgpy.mixin.Copyable" -> "kgpy.mixin.Plottable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "abc.ABC" -> "kgpy.mixin.Plottable" [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.rays.RayFunctionList" [URL="kgpy.optics.rays.RayFunctionList.html#kgpy.optics.rays.RayFunctionList",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="RayFunctionList(data: List[~ItemT] = <factory>, plot_kwargs: Dict[str, Any] = <factory>)"]; "kgpy.io.dxf.WritableMixin" -> "kgpy.optics.rays.RayFunctionList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Plottable" -> "kgpy.optics.rays.RayFunctionList" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.DataclassList" -> "kgpy.optics.rays.RayFunctionList" [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, component_x='x', component_y='y', component_z='z', transform_extra=None, color_axis='wavelength_base', plot_vignetted=False, colormap=None, **kwargs)

Return type:

typing.Tuple[typing.List[matplotlib.lines.Line2D], typing.Optional[matplotlib.colorbar.Colorbar]]

Parameters:

• ax (Axes) –

• component_x (str) –

• component_y (str) –

• component_z (str) –

• transform_extra (TransformList | None) –

• color_axis (str) –

• plot_vignetted (bool) –

• colormap (ScalarMappable | None) –

reverse()

to_dxf(filename, dxf_unit=Unit('inch'))

Parameters:

• filename (Path) –

• dxf_unit (Unit) –

write_to_dxf(file_writer, unit, transform_extra=None)

Return type:

None

Parameters:

• self (RaysListT) –

• file_writer (R12FastStreamWriter) –

• unit (Unit) –

• transform_extra (TransformList | None) –

data: typ.List[ItemT]

property intercepts: Cartesian3D

plot_kwargs: typing.Dict[str, typing.Any]

property tol_iter: Iterator[DataclassList]