Aperture

class kgpy.optics.surface.aperture.Aperture(plot_kwargs=<factory>, num_samples=1000)

Bases: WritableMixin, Broadcastable, Plottable, ABC

Parameters

• plot_kwargs (Dict[str, Any]) –

• num_samples (int) –

__init__(plot_kwargs=<factory>, num_samples=1000)

Parameters

• plot_kwargs (Dict[str, Any]) –

• num_samples (int) –

Return type

None

Attributes

broadcasted
max
min
num_samples
shape
wire

Methods

__init__([plot_kwargs, num_samples])
copy()	rtype typing.TypeVar(CopyableT, bound= Copyable)
copy_shallow()	rtype typing.TypeVar(CopyableT, bound= Copyable)
is_unvignetted(points[, num_extra_dims])	rtype numpy.ndarray
plot(ax[, components, component_z, ...])	rtype typing.List[matplotlib.lines.Line2D]
write_to_dxf(file_writer, unit[, ...])	rtype None

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

abstract is_unvignetted(points, num_extra_dims=0)

Return type

numpy.ndarray

Parameters

• points (Vector2D) –

• num_extra_dims (int) –

plot(ax, components=('x', 'y'), component_z=None, plot_kwargs=None, transform_extra=None, sag=None)

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

• sag (Optional[Sag]) –

write_to_dxf(file_writer, unit, transform_extra=None, sag=None)

Return type

None

Parameters

• self (ApertureT) –

• file_writer (R12FastStreamWriter) –

• unit (Unit) –

• transform_extra (Optional[Transform]) –

• sag (Optional[Sag]) –

property broadcasted

abstract property max: Vector3D

abstract property min: Vector3D

num_samples: int = 1000

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

property shape

abstract property wire: Vector3D