make_hexagonal_segmented_aperture

hcipy.aperture.make_hexagonal_segmented_aperture(num_rings, segment_flat_to_flat, gap_size, starting_ring=0, return_segments=False)

Create a hexagonal segmented aperture.

All segments have a flat-to-flat size of segment_flat_to_flat, which means that the segment pitch (the distance between the centers of adjacent segments) is the sum of the segment flat-to-flat size and the gap size.

Parameters

num_ringsint

The number of rings of hexagons to include, not counting the central segment. So 2 for a JWST-like aperture, 3 for a Keck-like aperture, and so on.

segment_flat_to_flatscalar

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

gap_sizescalar

The gap between adjacent segments.

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.

return_segmentsboolean

Whether to return a ModeBasis of all segments as well.

Returns

Field generator

The segmented aperture.

list of Field generators

The segments. Only returned if return_segments is True.