OccultedLyotCoronagraph

class hcipy.coronagraphy.OccultedLyotCoronagraph(input_grid, focal_plane_mask, focal_length=1, focal_plane_mask_grid=None)

Bases: OpticalElement

A Lyot coronagraph with a focal-plane mask.

The area outside of this focal-plane mask is assumed to be fully absorbing.

Parameters:
input_gridGrid

The grid on which the incoming wavefront is defined.

focal_plane_maskField or OpticalElement

The (complex) transmission of the focal-plane mask. If this is an OpticalElement, this will be used instead. This allows for more realistic implementations of focal-plane masks.

lyot_stopField or OpticalElement or None

The (complex) transmission of the Lyot stop. If this is an OpticalElement, this will be used instead. This allows for more realistic implementations of Lyot stops.

focal_lengthscalar

The internal focal length of the Lyot system.

focal_plane_mask_gridGrid

The grid on which the focal plane mask is defined. If this is none, the grid will be determined from the focal plane mask. The default value is None.

Notes

The OccultedLyotCoronagraph tries to automatically get the grid from the focal_plane_mask. However, a bug in AgnosticOpticalElements creates an invalid access which crashes the initialization. The correct grid can be passed explicitely to circumvent this bug by using the focal_plane_mask_grid parameter.

Methods Summary

backward(wavefront)

Propagate the wavefront from the Lyot plane to the pupil plane.

forward(wavefront)

Propagate the wavefront through the Lyot coronagraph.

Methods Documentation

backward(wavefront)

Propagate the wavefront from the Lyot plane to the pupil plane.

Parameters:
wavefrontWavefront

The wavefront to propagate.

Returns:
Wavefront

The pupil-plane wavefront.

forward(wavefront)

Propagate the wavefront through the Lyot coronagraph.

Parameters:
wavefrontWavefront

The wavefront to propagate. This wavefront is assumed to be in the pupil plane.

Returns:
Wavefront

The Lyot-plane wavefront.