1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"> 2 3<!--Converted with LaTeX2HTML 2018.3 (Released July 19, 2018) --> 4<HTML lang="EN"> 5<HEAD> 6<TITLE>help_st</TITLE> 7<META NAME="description" CONTENT="help_st"> 8<META NAME="keywords" CONTENT="idl"> 9<META NAME="resource-type" CONTENT="document"> 10<META NAME="distribution" CONTENT="global"> 11 12<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> 13<META NAME="viewport" CONTENT="width=device-width, initial-scale=1.0"> 14<META NAME="Generator" CONTENT="LaTeX2HTML v2018.3"> 15 <link rel='apple-touch-icon' sizes='180x180' href='images/favicons/apple-touch-icon.png?v=2017'> 16 <link rel='icon' type='image/png' sizes='32x32' href='images/favicons/favicon-32x32.png?v=2017'> 17 <link rel='icon' type='image/png' sizes='16x16' href='images/favicons/favicon-16x16.png?v=2017'> 18 <link rel='manifest' href='images/favicons/manifest.json?v=2017'> 19 <link rel='mask-icon' href='images/favicons/safari-pinned-tab.svg?v=2017' color='#5bbad5'> 20 <link rel='shortcut icon' href='images/favicons/favicon.ico?v=2017'> 21 <meta name='apple-mobile-web-app-title' content='HEALPix'> 22 <meta name='application-name' content='HEALPix'> 23 <meta name='msapplication-config' content='images/favicons/browserconfig.xml?v=2017'> 24 <meta name='theme-color' content='#ffffff'> 25 26<LINK REL="STYLESHEET" HREF="idl.css"> 27 28<LINK REL="next" HREF="idl_hpx2dm.htm"> 29<LINK REL="previous" HREF="idl_healpixwindow.htm"> 30<LINK REL="next" HREF="idl_hpx2dm.htm"> 31</HEAD> 32 33<body text="#000000" bgcolor="#FFFFFA"> 34 35<DIV CLASS="navigation"><!--Navigation Panel--> 36<A 37 HREF="idl_healpixwindow.htm"> 38<IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A> 39<A 40 HREF="idl_HEALPix_IDL_subroutines.htm"> 41<IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A> 42<A 43 HREF="idl_hpx2dm.htm"> 44<IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A> 45<A ID="tex2html337" 46 HREF="idl_TABLE_CONTENTS.htm"> 47<IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A> 48<BR> 49<B> Previous:</B> <A 50 HREF="idl_healpixwindow.htm">healpixwindow</A> 51 52<B>Up:</B> <A 53 HREF="idl_HEALPix_IDL_subroutines.htm">HEALPix/IDL subroutines</A> 54 55<B> Next:</B> <A 56 HREF="idl_hpx2dm.htm">hpx2dm</A> 57<B> Top:</B> <a href="main.htm">Main Page</a></DIV> 58<!--End of Navigation Panel--> 59 60<H1><A ID="SECTION3200"></A> 61<A ID="idl:help_st"></A> 62<BR> 63 64</H1> 65 66<P> 67<b><font size=+6><FONT COLOR="#CC0000">help_st</FONT></font></b><hr> 68<H3>This IDL facility provides some HELP-like information on any IDL variable, 69and especially on sub-structures.</H3> 70Location in HEALPix directory tree: <a href="https://sourceforge.net/p/healpix/code/1005/tree/trunk/src/idl/misc/help_st.pro"><b>src/idl/misc/help_st.pro</b></a> 71 72<P> 73<hr><h1>FORMAT </h1><h3>IDL> 74<FONT COLOR="#CC0000">help_st</FONT>, 75<A HREF="#idl:help_st:var">Var</A> 76</h3> 77 78<P> 79<hr> 80<H1>QUALIFIERS</H1> 81 82 <DL COMPACT><DT> 83<B>Var</B> 84<DD><A ID="idl:help_st:var"></A>IDL variable, of any kind 85 </DL> 86 87<P> 88<hr> 89<H1>DESCRIPTION</H1> 90<blockquote> 91If <A HREF="#idl:help_st:var"><SPAN CLASS="texttt">Var</SPAN></A> is an IDL structure, <FONT COLOR="#CC0000">help_st</FONT> does a recursive <SPAN CLASS="texttt">HELP,/STRUCTURES</SPAN> on <SPAN CLASS="texttt">Var</SPAN> and each of its substructure, otherwise it does the equivalent of <SPAN CLASS="texttt">HELP, Var</SPAN> (see respectively 92Examples 93<A HREF="#idl:help_st:example1">#1</A> and 94<A HREF="#idl:help_st:example2">#2</A> below) 95</blockquote> 96 97<P> 98<hr><H1>RELATED ROUTINES</H1><h3>This section lists the routines related to <b><FONT COLOR="#CC0000">help_st</FONT></b></h3> 99 100 <DL COMPACT><DT> 101<B>idl</B> 102<DD>version 6.4 or more is necessary to run <FONT COLOR="#CC0000">help_st</FONT>. 103 </DL> 104 105<P> 106<hr><H1>EXAMPLE # 1:</H1> 107<tt><A ID="idl:help_st:example1"></A><TABLE CELLPADDING=3> 108<TR><TD ALIGN="LEFT"><A HREF="idl_init_healpix_healpix_system.htm#idl:init_healpix">init_healpix</A> ; make sure that <SPAN CLASS="texttt">!healpix</SPAN> is defined</TD> 109</TR> 110<TR><TD ALIGN="LEFT">help, /structure, !healpix</TD> 111</TR> 112<TR><TD ALIGN="LEFT"><FONT COLOR="#CC0000">help_st</FONT>, !healpix</TD> 113</TR> 114</TABLE></tt> 115<blockquote> 116<TABLE STYLE="width:100%;"> 117<TR><TD> 118the example above compares the output of <SPAN CLASS="texttt">help,/structures</SPAN> which only describes the top structure: 119 120<BR> 121<BR><SMALL CLASS="SCRIPTSIZE"><SPAN CLASS="texttt"> ** Structure <151cef8>, 7 tags, length=528, data length=524, refs=2: 122<BR></SMALL><TABLE CELLPADDING=3> 123<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 124 VERSION </SMALL></TD> 125<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 126<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '3.40' </SMALL></TD> 127</TR> 128<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 129 DATE </SMALL></TD> 130<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 131<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '2018-01-01' </SMALL></TD> 132</TR> 133<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 134 DIRECTORY </SMALL></TD> 135<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 136<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix' </SMALL></TD> 137</TR> 138<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 139 PATH </SMALL></TD> 140<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRUCT </SMALL></TD> 141<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> -> <Anonymous> Array[1] </SMALL></TD> 142</TR> 143<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 144 NSIDE </SMALL></TD> 145<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> LONG </SMALL></TD> 146<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> Array[30] </SMALL></TD> 147</TR> 148<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 149 BAD_VALUE </SMALL></TD> 150<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> FLOAT </SMALL></TD> 151<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> -1.63750e+30 </SMALL></TD> 152</TR> 153<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 154 COMMENT </SMALL></TD> 155<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 156<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> Array[15] 157</SMALL></TD> 158</TR> 159</TABLE><SMALL CLASS="SCRIPTSIZE"></SPAN></SMALL> 160 161<BR> 162<P> 163and <SPAN CLASS="texttt"><FONT COLOR="#CC0000">help_st</FONT></SPAN>, which describes each sub-structure: 164 165<BR><SMALL CLASS="SCRIPTSIZE"><SPAN CLASS="texttt"> ** Structure <151cef8>, 7 tags, length=528, data length=524, refs=2: 166<BR></SMALL><TABLE CELLPADDING=3> 167<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 168 .VERSION </SMALL></TD> 169<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 170<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '3.40' </SMALL></TD> 171</TR> 172<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 173 .DATE </SMALL></TD> 174<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 175<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '2018-01-01' </SMALL></TD> 176</TR> 177<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 178 .DIRECTORY </SMALL></TD> 179<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 180<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix' </SMALL></TD> 181</TR> 182<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 183 .PATH.BIN.CXX </SMALL></TD> 184<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 185<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/src/cxx/generic_gcc/bin/'</SMALL></TD> 186</TR> 187<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 188 .PATH.BIN.F90 </SMALL></TD> 189<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 190<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/bin/' </SMALL></TD> 191</TR> 192<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 193 .PATH.DATA </SMALL></TD> 194<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 195<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/data/' </SMALL></TD> 196</TR> 197<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 198 .PATH.DOC.HTML </SMALL></TD> 199<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 200<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/doc/html/' </SMALL></TD> 201</TR> 202<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 203 .PATH.DOC.PDF </SMALL></TD> 204<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 205<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/doc/pdf/' </SMALL></TD> 206</TR> 207<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 208 .PATH.SRC </SMALL></TD> 209<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 210<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/src/' </SMALL></TD> 211</TR> 212<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 213 .PATH.TEST </SMALL></TD> 214<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 215<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> '/home/user/Healpix/test/' </SMALL></TD> 216</TR> 217<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 218 .NSIDE </SMALL></TD> 219<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> LONG </SMALL></TD> 220<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> Array[30] </SMALL></TD> 221</TR> 222<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 223 .BAD_VALUE </SMALL></TD> 224<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> FLOAT </SMALL></TD> 225<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> -1.63750e+30 </SMALL></TD> 226</TR> 227<TR><TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> 228 .COMMENT </SMALL></TD> 229<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> STRING </SMALL></TD> 230<TD ALIGN="LEFT"><SMALL CLASS="SCRIPTSIZE"> Array[15] 231</SMALL></TD> 232</TR> 233</TABLE><SMALL CLASS="SCRIPTSIZE"></SPAN></SMALL> 234</TD></TR> 235</TABLE> 236</blockquote> 237 238<P> 239<hr><H1>EXAMPLE # 2:</H1> 240<tt><A ID="idl:help_st:example2"></A><TABLE CELLPADDING=3> 241<TR><TD ALIGN="LEFT">a=0</TD> 242</TR> 243<TR><TD ALIGN="LEFT">help,a+1</TD> 244</TR> 245<TR><TD ALIGN="LEFT"><FONT COLOR="#CC0000">help_st</FONT>, a+1</TD> 246</TR> 247</TABLE></tt> 248<blockquote><IMG STYLE="height: 7.23ex; vertical-align: -3.12ex; " SRC="idl_img69.png" 249 ALT="$\textstyle \parbox{\hsize}{ 250will print out 251\\ 252{\scriptsize{\texttt{ 253<Expressi... 254...} = \hspace{3em} 1 \\ 255A+1 \hspace{3em} INT \hspace{3em} = \hspace{3em} 1 256}}} 257}$"></blockquote> 258 259<P> 260 261<P> 262 263<P> 264 265<DIV CLASS="navigation"><HR> 266<!--Navigation Panel--> 267<A 268 HREF="idl_healpixwindow.htm"> 269<IMG WIDTH="63" HEIGHT="24" ALT="previous" SRC="prev.png"></A> 270<A 271 HREF="idl_HEALPix_IDL_subroutines.htm"> 272<IMG WIDTH="26" HEIGHT="24" ALT="up" SRC="up.png"></A> 273<A 274 HREF="idl_hpx2dm.htm"> 275<IMG WIDTH="37" HEIGHT="24" ALT="next" SRC="next.png"></A> 276<A ID="tex2html337" 277 HREF="idl_TABLE_CONTENTS.htm"> 278<IMG WIDTH="65" HEIGHT="24" ALT="contents" SRC="contents.png"></A> 279<BR> 280<B> Previous:</B> <A 281 HREF="idl_healpixwindow.htm">healpixwindow</A> 282 283<B>Up:</B> <A 284 HREF="idl_HEALPix_IDL_subroutines.htm">HEALPix/IDL subroutines</A> 285 286<B> Next:</B> <A 287 HREF="idl_hpx2dm.htm">hpx2dm</A> 288<B> Top:</B> <a href="main.htm">Main Page</a></DIV> 289<!--End of Navigation Panel--> 290<ADDRESS> 291Version 3.50, 2018-12-10 292</ADDRESS> 293</BODY> 294</HTML> 295
