predict_kernel¶

predict_kernel(beam, target_beam, pstol=1e-06, patol=0.001)[source]¶

Predict the required convolution kernel to each a target restoring beam.

pstol: the tolerance in arcsec for original vs. target bmaj/bmin identical or kernel "point source" like. patol: the tolerance in degree for original vs. target bpa identical

return_code:: 0: sucess, the target beam can be reached with a valid convolution kernel 1: fail, "point source" like 2: fail, unable to reach the target beam shape, and the original beam is probably already too large in a certain direction.

Note

Although ia.deconvolvefrombeam() can also predict convolution kernel sizes, its return can be misleading in some circumstances (see CAS-13804). Therefore, we use ia.beamforconvolvedsize() here even though we have to catch the CASA runtime error messages.