healpy.fitsfunc.read_map

healpy.fitsfunc.read_map(filename, field=0, dtype=<class 'Mock'>, nest=False, hdu=1, h=False, verbose=False)

Read an healpix map from a fits file.

Parameters :

filename : str

the fits file name

field : int or tuple of int, optional

The column to read. Default: 0. By convention 0 is temperature, 1 is Q, 2 is U. Field can be a tuple to read multiple columns (0,1,2)

dtype : data type, optional

Force the conversion to some type. Default: np.float64

nest : bool, optional

If True return the map in NEST ordering, otherwise in RING ordering; use fits keyword ORDERING to decide whether conversion is needed or not If None, no conversion is performed.

hdu : int, optional

the header number to look at (start at 0)

h : boo, optional

If True, return also the header. Default: False.

verbose : bool, optional

If True, print a number of diagnostic messages

Returns :

m | (m0, m1, ...) [, header] : array or a tuple of arrays, optionally with header appended

The map(s) read from the file, and the header if h is True.

Project Versions

Previous topic

healpy.fitsfunc.getformat

Next topic

healpy.fitsfunc.write_map

This Page