make_hicat_aperture
- hcipy.aperture.make_hicat_aperture(normalized=False, with_spiders=True, with_segment_gaps=True, return_header=False, return_segments=False)
Make the HiCAT P3 apodizer mask
- Parameters:
- normalizedboolean
If this is True, the outer diameter will be scaled to 1. Otherwise, the diameter of the pupil will be 15.0 meters.
- with_spidersboolean
Include the secondary mirror support structure in the aperture.
- with_segment_gapsboolean
Include the gaps between individual segments in the aperture.
- return_headerboolean
If this is True, a header will be returned giving all important values for the created aperture for reference.
- return_segmentsboolean
If this is True, the segments will also be returned as a list of Field generators.
- Returns:
- apertureField generator
The HiCAT aperture.
- headerdict
A dictionary containing all important values for the created aperture. Only returned if return_header is True.
- segmentslist of Field generators
The segments. Only returned when return_segments is True.