RegularPolygon

class kgpy.optics.surface.aperture.RegularPolygon(plot_kwargs=<factory>, num_samples=1000, is_obscuration=False, decenter=<factory>, radius=<Quantity 0. mm>, num_sides=8, offset_angle=<Quantity 0. deg>)

Bases: Polygon

Parameters

• plot_kwargs (Dict[str, Any]) –

• num_samples (int) –

• is_obscuration (bool) –

• decenter (Translate) –

• radius (Quantity) –

• num_sides (int) –

• offset_angle (Quantity) –

__init__(plot_kwargs=<factory>, num_samples=1000, is_obscuration=False, decenter=<factory>, radius=<Quantity 0. mm>, num_sides=8, offset_angle=<Quantity 0. deg>)

Parameters

• plot_kwargs (Dict[str, Any]) –

• num_samples (int) –

• is_obscuration (bool) –

• decenter (Translate) –

• radius (Quantity) –

• num_sides (int) –

• offset_angle (Quantity) –

Return type

None

Attributes

broadcasted
edge_subtent	Calculate the angle subtended by each edge of the polygon by dividing the angle of a circle (360 degrees) by the number of sides in the regular polygon.
half_edge_subtent	Calculate the angle subtended between a vertex and a point on the center of an edge.
is_obscuration
max
min
min_radius	Calculate the distance from the center of the polygon to the center of an edge of a polygon.
num_samples
num_sides
offset_angle
radius
shape
shapely_poly
vertices
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) –

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

decenter: kgpy.transform.rigid.Translate

property edge_subtent

Calculate the angle subtended by each edge of the polygon by dividing the angle of a circle (360 degrees) by the number of sides in the regular polygon. :return: Angle subtended by each edge

property half_edge_subtent

Calculate the angle subtended between a vertex and a point on the center of an edge. This is sometimes a more useful quantity than the subtent of an entire edge. :return:

is_obscuration: bool = False

property max: Vector3D

property min: Vector3D

property min_radius

Calculate the distance from the center of the polygon to the center of an edge of a polygon. :return: The minimum radius of the polygon.

num_samples: int = 1000

num_sides: int = 8

offset_angle: astropy.units.Quantity = <Quantity 0. deg>

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

radius: astropy.units.Quantity = <Quantity 0. mm>

property shape

property shapely_poly: Polygon

property vertices: Vector3D

property wire: Quantity