[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


PRINT_STRUCT Source code in print_struct.pro

PRINT_STRUCT

Name
       PRINT_STRUCT
Purpose
       Print the tag values of an array of structures in nice column format.
Explanation
       The tag names are displayed in a header line.
Calling Sequence
       print_struct, structure, Tags_to_print [ , title, string_matrix
                FILE=, LUN_OUT=, TNUMS= , TRANGE= , FRANGE=, WHICH=
                FORM_FLOAT =, MAX_ELEMENTS
Input Parameters
       structure = array of structured variables
       Tags_to_print = string array specifying the names of tags to print.
                       Default is to print all tags which are not arrays.
Optional Input Keywords
       FILE = string, optional file name to which output will then be written.
       LUN_OUT = Logical unit number for output to an open file,
               default is to print to standard output.
       TNUMS = tag numbers to print (alternative to specifying tag names).
       TRANGE = [beg,end] tag number range to print.
       FRANGE = same as TRANGE.
       WHICH = optional array of subscripts to select
               which structure elements to print.
       FORM_FLOAT = string array of three elements specifying
               floating point format, ex: FORM=['f','9','2'] means "(F9.2)",
               (default float format is G12.4).
       MAX_ELEMENTS = positive integer, print only tags that have less than
                       this number of elements (default is no screening).
       /NO_TITLE - If set, then the header line of tag names is not printed
       /STRINGS : instead of printing, return the array of strings in
               fourth argument of procedure: string_matrix.
Output Parameters
       title = optional string, list of tags printed/processed.
       string_matrix = optional output of string matrix of tag values,
                       instead of printing to terminal or file, if /STRINGS.
Procedure
       Check the types and lengths of fields to decide formats,
       then loop and form text string from requested fields, then print.
Revision History
       Written: Frank Varosi NASA/GSFC 1991.
       F.V.1993, fixed up the print formats.
       F.V.1994, added more keyword options.
       F.V.1997, added WHICH and MAX_ELEM keyword options.
       WBL 1997, Use UNIQ() rather than UNIQUE function
       Converted to IDL V5.0   W. Landsman   September 1997
       Remove call to N_STRUCT()   W. Landsman  March 2004

Last modified by pro2html on 2004 March 10 at 05:06 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically