init_healpix

This IDL facility creates an IDL system variable (!HEALPIX) containing various HEALPix related quantities

Location in HEALPix directory tree: src/idl/misc/init_healpix.pro 

FORMAT

IDL> INIT_HEALPIX [,VERBOSE=]

KEYWORDS

VERBOSE=

if set, turn on the verbose mode, giving a short description of the variables just created.

DESCRIPTION

init_healpix defines the IDL system variable and structure !HEALPIX containing several quantities and character string necessary to HEALPix, eg : allowed resolution parameters Nside, full path to package directory, package version...

RELATED ROUTINES

This section lists the routines related to init_healpix

idl

version 6.4 or more is necessary to run init_healpix.

!HEALPIX

IDL system variable defined by init_healpix.

EXAMPLE # 1:

init_healpix,/verbose

init_healpix will create the system variable !Healpix, and give a short description of the tags available, as shown below

Initializing !HEALPIX system variable
This system variable contains some information on Healpix :
!HEALPIX.VERSION = current version number,
!HEALPIX.DATE = date of release,
!HEALPIX.DIRECTORY = directory containing Healpix package,
!HEALPIX.PATH = structure containing:
!HEALPIX.PATH.BIN = structure containing binary path :
!HEALPIX.PATH.BIN.CXX = C++
!HEALPIX.PATH.BIN.F90 = Fortran90
!HEALPIX.PATH.DATA = path to data subdirectory,
!HEALPIX.PATH.DOC = path to doc subdirectories (.html, .pdf, .epub),
!HEALPIX.PATH.SRC = path to src subdirectory,
!HEALPIX.PATH.TEST = path to test subdirectory,
!HEALPIX.NSIDE = list of all valid values of Nside parameter,
!HEALPIX.BAD_VALUE = value of flag given to missing pixels in FITS files,
!HEALPIX.COMMENT = this description.

EXAMPLE # 2:

help, !healpix, /structure

will print the content of the !Healpix system structure.