SurfaceList

class kgpy.optics.surface.SurfaceList(data=<factory>, transform=<factory>, plot_kwargs=<factory>)

Bases: WritableMixin, Plottable, Transformable, DataclassList[Surface]

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

Parameters

• data (List[ItemT]) –

• transform (TransformList) –

• plot_kwargs (Dict[str, Any]) –

Return type

None

Attributes

flat_global
flat_global_iter
flat_local
flat_local_iter
tol_iter

Methods

__init__([data, transform, 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.List[matplotlib.lines.Line2D]
raytrace(rays[, surface_last, intercept_error])	rtype kgpy.optics.rays.RaysList
reverse()
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, to_global=False, plot_annotations=True, annotation_text_y=1.05)

Return type

typing.List[matplotlib.lines.Line2D]

Parameters

• ax (Axes) –

• components (Tuple[str, str]) –

• component_z (Optional[str]) –

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

• transform_extra (Optional[TransformList]) –

• to_global (bool) –

• plot_annotations (bool) –

• annotation_text_y (float) –

raytrace(rays, surface_last=None, intercept_error=<Quantity 0.1 nm>)

Return type

kgpy.optics.rays.RaysList

Parameters

• rays (Rays) –

• surface_last (Optional[Surface]) –

• intercept_error (Quantity) –

reverse()

write_to_dxf(file_writer, unit, transform_extra=None)

Return type

None

Parameters

• self (SurfaceListT) –

• file_writer (R12FastStreamWriter) –

• unit (Unit) –

• transform_extra (Optional[Transform]) –

data: typ.List[ItemT]

property flat_global: SurfaceList

property flat_global_iter: Iterator[Surface]

property flat_local: SurfaceList

property flat_local_iter: Iterator[Surface]

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

property tol_iter: Iterator[Transformable]

transform: TransformList