input_map*

This routine reads a HEALPix map from a FITS file. This can deal with full sky as well as cut sky maps, but always outputs a full sky map (with possibly many empty pixels).

Location in HEALPix directory tree: src/f90/mod/fitstools.F90 


FORMAT

call input_map*( filename, map, npixtot, nmaps[, fmissval, header, units, extno, ignore_polcconv] )

Arguments appearing in italic are optional.


ARGUMENTS

name & dimensionality kind i/o description
       
filename(len=filenamelen) CHR IN FITS file to be read from, containing a full sky or cut sky map
map(0:npixtot-1,1:nmaps) SP/ DP OUT full sky map(s) constructed from the data present in the file, missing pixels are filled with fmissval
npixtot I4B/ I8B IN number of pixels in the full sky map
nmaps I4B IN number of maps in the file
       
fmissval SP/ DP IN value to be given to missing pixels, default:0
header(LEN=80)(1:) CHR OUT FITS extension header
units(LEN=20)(1:nmaps) CHR OUT maps units
extno I4B IN extension number to read the data from (0 based).default:0 (the first extension is read)
ignore_polccconv LGT IN by default (ignore_polcconv=.false.) the output of this routine depends on the value of the FITS keyword POLCCONV found in filename, as described in the note on POLCCONV in The HEALPix Primer. Setting ignore_polcconv=.true. will force input_map to ignore that keyword.


EXAMPLE:

use pix_tools, only: nside2npix
use fitstools, only: getsize_fits, input_map
...
npixtot = getsize_fits('map.fits',nmaps=nmaps, nside=nside)
npix = nside2npix(nside)
allocate(map(0:npix-1,1:nmaps))
call input_map('map.fits', map, npix, nmaps, fmissval=0.)
Reads into map the content of the FITS file 'map.fits'. If there are missing pixels in the input file (ie, having value NaN (Not of Number), $\pm$ Infinity or matching the FITS keyword BAD_DATA) they will take on output the value provided in optional fmissval (here 0, which also is its default value).

MODULES & ROUTINES

This section lists the modules and routines used by input_map*.

fitstools
module, containing:
printerror
routine for printing FITS error messages.
read_bintab
routine to read a binary table from a FITS file
read_fits_cut4
routine to read cut sky map from a FITS file
read_fits_partial
routine to read a partial sky map from a FITS file
cfitsio
library for FITS file handling.


RELATED ROUTINES

This section lists the routines related to input_map*

anafast
executable that reads a HEALPix map and analyses it.
synfast
executable that generate full sky HEALPix maps
getsize_fits
subroutine to know the size of a FITS file.
output_map
subroutine to write a FITS file from a HEALPix map
write_bintabh
subroutine to write a large array into a FITS file piece by piece
input_tod*
subroutine to read an arbitrary subsection of a large binary table

Version 3.82, 2022-07-28