ms_clean#
- xrayvision.clean.ms_clean(dirty_map, dirty_beam, pixel, scales=None, clean_beam_width=4.0, gain=0.1, thres=0.01, niter=5000)[source]#
Clean the map using a multiscale clean algorithm.
- Parameters:
dirty_map (
numpy.ndarray) – The 2D dirty map to be cleaneddirty_beam (
numpy.ndarray) – The 2D dirty beam should have the same dimensions asdirty_mapscales (array-like, optional, optional) – The scales to use eg
[1, 2, 4, 8]clean_beam_width (
float) – The width of the gaussian to convolve the model with. If set to 0.0 the gaussian convolution is disabledgain (
float) – The gain per loop or loop gainthres (
float) – Terminates clean whenresiduals.max() <= thres`niter (
int) – Maximum number of iterations to perform
- Returns:
numpy.ndarray– Cleaned image
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.
References