vis_ms_clean

xrayvision.clean.vis_ms_clean(vis, shape, pixel_size, scales, clean_beam_width=4.0, niter=5000, map=True, gain=0.1, thres=0.01)

Clean the visibilities using a multiscale clean method.

A wrapper around ms_clean which calculates the dirty map and psf.

Parameters:

• vis (Visibilities) – The visibilities to clean

• shape (Annotated[Quantity, Unit("pix")]) – Size of map

• pixel_size (Annotated[Quantity, Unit("arcsec / pix")]) – The pixel size in arcsec

• scales (array-like, optional, optional) – The scales to use eg [1, 2, 4, 8]

• clean_beam_width (Annotated[Quantity, Unit("arcsec")] | None) – The width of the gaussian to convolve the model with. If set to 0.0 the gaussian convolution is disabled

• gain (float | None) – The gain per loop or loop gain

• thres (float | None) – Terminates clean when residuals.max() <= thres`

• niter (int | None) – Maximum number of iterations to perform

• map (bool | None) – Return a sunpy.map.Map by default or array only if False

Returns:

Cleaned image

Return type:

Quantity | ndarray[Any, dtype[float64]]