make_segment_hexike_surface_from_hex_aperture

hcipy.optics.make_segment_hexike_surface_from_hex_aperture(num_rings, segment_flat_to_flat, gap_size, pupil_grid, num_modes, hexagon_angle=1.5707963267948966, starting_ring=0)

Create a SegmentedHexikeSurface on a hexagonal segmented aperture.

Parameters:
num_ringsint

The number of rings of hexagons to include, not counting the central segment.

segment_flat_to_flatscalar

The distance between sides (flat-to-flat) of a single segment.

gap_sizescalar

The gap between adjacent segments.

pupil_gridGrid

The grid on which the surface is defined.

num_modesint

The number of hexike modes to compute per segment (Noll ordered).

hexagon_anglefloat

The angle of the hexagon. At an angle of pi/2, the hexagon has a flat-top orientation.

starting_ringint

The first ring of segments. This can be used to exclude the center segment (by setting it to one), or the center segment and first ring (by setting it to two). The default (zero) includes the center segment.

Returns:
SegmentedHexikeSurface

The resulting segmented hexike surface.