generate_app_por

hcipy.coronagraphy.generate_app_por(wavefront, propagator, propagator_max, contrast, num_iterations=1)

Optimize a one-sided APP using a globally optimal algorithm. This algorithm does not apply any symmetries for two-sided dark zones or circularly-symmetric pupils. This function requires that you have installed the Gurobi optimizer.

Parameters
wavefontWavefront

The input aperture as a wavefront.

propagatorPropagator

The propagator from wavefront to the focal plane grid.

propagator_maxPropagator

The propagator from wavefront to the point in the focal-plane that we want to maximize.

contrastarray_like or scalar

The required contrast in the focal plane.

num_iterationsint

The number of iterations for the Strehl ratio to converge.

Returns
Field

The resultant electric field transmission function.