help_st

This IDL facility provides some HELP-like information on any IDL variable, and especially on sub-structures.

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

FORMAT

IDL> help_st, Var

QUALIFIERS

Var

IDL variable, of any kind

DESCRIPTION

If Var is an IDL structure, help_st does a recursive HELP,/STRUCTURES on Var and each of its substructure, otherwise it does the equivalent of HELP, Var (see respectively Examples #1 and #2 below)

RELATED ROUTINES

This section lists the routines related to help_st

idl

version 6.4 or more is necessary to run help_st.

EXAMPLE # 1:

init_healpix ; make sure that !healpix is defined

help, /structure, !healpix

help_st, !healpix

the example above compares the output of help,/structures which only describes the top structure:

** Structure <151cef8>, 7 tags, length=528, data length=524, refs=2:

VERSION	STRING	'3.40'
DATE	STRING	'2018-01-01'
DIRECTORY	STRING	'/home/user/Healpix'
PATH	STRUCT	-> <Anonymous> Array[1]
NSIDE	LONG	Array[30]
BAD_VALUE	FLOAT	-1.63750e+30
COMMENT	STRING	Array[15]

and help_st, which describes each sub-structure:
** Structure <151cef8>, 7 tags, length=528, data length=524, refs=2:

.VERSION	STRING	'3.40'
.DATE	STRING	'2018-01-01'
.DIRECTORY	STRING	'/home/user/Healpix'
.PATH.BIN.CXX	STRING	'/home/user/Healpix/src/cxx/generic_gcc/bin/'
.PATH.BIN.F90	STRING	'/home/user/Healpix/bin/'
.PATH.DATA	STRING	'/home/user/Healpix/data/'
.PATH.DOC.HTML	STRING	'/home/user/Healpix/doc/html/'
.PATH.DOC.PDF	STRING	'/home/user/Healpix/doc/pdf/'
.PATH.SRC	STRING	'/home/user/Healpix/src/'
.PATH.TEST	STRING	'/home/user/Healpix/test/'
.NSIDE	LONG	Array[30]
.BAD_VALUE	FLOAT	-1.63750e+30
.COMMENT	STRING	Array[15]

EXAMPLE # 2:

a=0

help,a+1

help_st, a+1

$\parbox{\hsize}{ will print out \\ {\scriptsize{\texttt{ <Expressi... ...} = \hspace{3em} 1 \\ A+1 \hspace{3em} INT \hspace{3em} = \hspace{3em} 1 }}} }$