regular_polygon_aperture

hcipy.aperture.regular_polygon_aperture(num_sides, circum_diameter, angle=0, center=None)

Makes a Field generator for a regular-polygon-shaped aperture.

Parameters
num_sidesinteger

The number of sides for the polygon.

circum_diameterscalar

The circumdiameter of the polygon.

anglescalar

The angle by which to turn the polygon.

centerarray_like

The center of the aperture

Returns
Field generator

This function can be evaluated on a grid to get a Field.