RaysList

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

Bases: WritableMixin, Plottable, DataclassList[Rays]

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

Parameters

• data (List[ItemT]) –

• plot_kwargs (Dict[str, Any]) –

Return type

None

Attributes

intercepts
tol_iter

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[, components, component_z, ...])	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

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, components=('x', 'y'), component_z=None, plot_kwargs=None, transform_extra=None, color_axis=-2, plot_vignetted=False, plot_colorbar=True)

Return type

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

Parameters

• ax (Axes) –

• components (Tuple[str, str]) –

• component_z (Optional[str]) –

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

• transform_extra (Optional[TransformList]) –

• color_axis (int) –

• plot_vignetted (bool) –

• plot_colorbar (bool) –

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 (Optional[Transform]) –

data: typ.List[ItemT]

property intercepts: Vector3D

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

property tol_iter: Iterator[DataclassList]