Component

class kgpy.optics.component.Component(name=<factory>, plot_kwargs=<factory>)

Bases: Plottable, Named, ABC, Generic[SurfaceT]

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

Parameters

• name (Name) –

• plot_kwargs (Dict[str, Any]) –

Return type

None

Attributes

dataframe
surface
transform

Methods

__init__([name, plot_kwargs])
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
plot(ax[, components, component_z, ...])	rtype typing.List[matplotlib.lines.Line2D]

Inheritance Diagram

copy()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

copy_shallow()

Return type

typing.TypeVar(CopyableT, bound= Copyable)

Parameters

self (CopyableT) –

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) –

property dataframe: DataFrame

name: Name

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

property surface: SurfaceT

abstract property transform: TransformList