plot_fit_path

pyoof.plot_fit_path(path_pyoof, order, illum_func, telgeo, resolution, box_factor, angle, plim_rad, save)[source] [edit on github]

Plot all important figures after a least squares minimization.

Parameters:

path_pyoof : str

Path to the pyoof output, 'pyoof_out/directory'.

order : int

Order used for the Zernike circle polynomial, \(n\).

illum_func : function

Illumination function, \(E_\mathrm{a}(x, y)\), to be evaluated with the key I_coeff. The illumination functions available are illum_pedestal and illum_gauss.

telgeo : list

List that contains the blockage distribution, optical path difference (OPD) function, and the primary radius (float) in meters. The list must have the following order, telego = [block_dist, opd_func, pr].

resolution : int

Fast Fourier Transform resolution for a rectangular grid. The input value has to be greater or equal to the telescope resolution and with power of 2 for faster FFT processing. It is recommended a value higher than resolution = 2 ** 8.

box_factor : int

Related to the FFT resolution (resolution key), defines the image pixel size level. It depends on the primary radius, pr, of the telescope, e.g. a box_factor = 5 returns x = np.linspace(-5 * pr, 5 * pr, resolution), an array to be used in the FFT2 (fft2).

angle : str

Angle unit, it can be 'degrees' or 'radians'.

plim_rad : ndarray

Contains the maximum values for the \(u\) and \(v\) wave-vectors, it can be in degrees or radians depending which one is chosen in angle key. The ndarray must be in the following order, plim_rad = np.array([umin, umax, vmin, vmax]).

save : bool

If True, it stores all plots in the 'pyoof_out/directory' directory.

Returns:

fig_beam : Figure

The three beam maps plotted from the input parameters. Each map with a different offset \(d_z\) value. From left to right, \(d_z^-\), \(0\) and \(d_z^+\).

fig_phase : Figure

Aperture phase distribution for the Zernike circle polynomials for the telescope primary dish.

fig_res : Figure

Figure from the three observed beam maps residual. Each map with a different offset \(d_z\) value. From left to right, \(d_z^-\), \(0\) and \(d_z^+\).

fig_data : Figure

Figure from the three observed beam maps. Each map with a different offset \(d_z\) value. From left to right, \(d_z^-\), \(0\) and \(d_z^+\).

fig_cov : Figure

Triangle figure representing Variance-Covariance matrix.

fig_corr : Figure

Triangle figure representing Correlation matrix.