ms_clean#
- xrayvision.clean.ms_clean(dirty_map, dirty_beam, pixel_size, scales=None, clean_beam_width=<Quantity 4. arcsec>, gain=0.1, thres=0.01, niter=5000)[source]#
Clean the map using a multiscale clean algorithm.
- Parameters:
dirty_map (Quantity) – The 2D dirty map to be cleaned
dirty_beam (Quantity) – The 2D dirty beam should have the same dimensions as
dirty_mappixel_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 (Quantity) – The width of the gaussian to convolve the model with. If set to 0.0 the gaussian convolution is disabled
gain (float) – The gain per loop or loop gain
thres (float) – Terminates clean when
residuals.max() <= thres`niter (int) – Maximum number of iterations to perform
- Returns:
Cleaned image
- Return type:
Notes
This is an implementation of the multiscale clean algorithm as outlined in [R1] adapted for x-ray Fourier observations.
It is based on the on the implementation in the CASA software which can be found here ~L956.
References