healpy.pixelfunc.remove_dipole

healpy.pixelfunc.remove_dipole(m, nest=False, bad=- 1.6375e+30, gal_cut=0, fitval=False, copy=True, verbose=True)

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

Parameters
mfloat, array-like

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

nestbool

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

badfloat

bad values of pixel, default to UNSEEN.

gal_cutfloat [degrees]

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

fitvalbool

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

copybool

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

verbosebool

print values of monopole and dipole

Returns
resarray 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])