ngcasa.deconvolution.is_converged

is_converged(img_dataset, iterpars, storage_parms)

Todo

This function is not yet implemented

An iteration controller for image reconstruction

The current image set (residual, psf, model, etc) is evaluated against stopping criteria derived from input parameters (iterpars) and the image set itself.

Step 1 : Derive stopping criteria

• Merge explicit user-parameters in iterpars (niter,threshold,etc..) with criteria that are calculated from the imageset (psfsidelobelevel, cyclethreshold, N-sigma-based thresholds, mask-sensitive thresholds)

• Calculate ‘cycleniter’ and ‘cyclethreshold’ to be used in Step 2.

Step 2 : Apply stopping criteria (as an ordered list)

• Peak residual within the mask region for imagename.residual <= threshold

• Total iters done >= niter

Returns

img_dataset – An convergence history list of dict is added to the attributes of img_dataset.

Return type

xarray.core.dataset.Dataset