healpy.pixelfunc.remove_dipole

healpy.pixelfunc.remove_dipole(m, nest=False, bad=<class 'Mock'>, gal_cut=0, fitval=False, copy=True, verbose=False)

Fit and subtract the dipole and the monopole from the given map m.

Parameters :

m : float, array-like

the map to which a dipole is fitted and subtracted, accepts masked arrays

nest : bool

if False m is assumed in RING scheme, otherwise map is NESTED

bad : float

bad values of pixel, default to UNSEEN.

gal_cut : float

pixels at latitude in [-gal_cut;+gal_cut] are not taken into account

fitval : bool

whether to return or not the fitted values of monopole and dipole

copy : bool

whether to modify input map or not (by default, make a copy)

verbose : bool

print values of monopole and dipole

Returns :

res : array or tuple of length 3

if fitval is False, returns map with monopole and dipole subtracted, otherwise, returns map (array, in res[0]), monopole (float, in res[1]), dipole_vector (array, in res[2])

See also

fit_dipole, fit_monopole, remove_monopole