make_hicat_lyot_stop

hcipy.aperture.make_hicat_lyot_stop(normalized=False, with_spiders=True, inner_diameter_fraction=0.2, outer_diameter_fraction=0.9, return_header=False)

Make the HiCAT Lyot stop.

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.

inner_diameter_fractionscalar

The fractional size of the circular central obstruction as fraction of the pupil diameter.

outer_diameter_fractionscalar

The fractional size of the circular outer edge as fraction of the pupil diameter.

return_headerboolean

If this is True, a header will be returned giving all important values for the created aperture for reference.

Returns

lyot_stopField generator

A field generator for the Lyot stop.

headerdict

A dictionary containing all important values for the created aperture. Only returned if return_header is True.