Next: Asymmetric Errors Up: TXT2AST Prev: TXT2AST

Quick Guide

This section describes TXT2AST working on the following example data file, a copy can be made from $AST_ROOT/demo/import_1d.dat

    ; TXT2AST demo file - 1 dimensional
    ;
    TOPLEVEL TITLE "Fitted Fe abundance" ~
    TYPE "Radial_Profile"
    AXIS LABEL "Radius" UNITS "Arcmin" SCALAR_WIDTH 6.0
    DATA UNITS "Solar" LABEL "Abundance"
    3  1.5
    6  0.5
    9  0.3
    12 1.2e-1
  
The file can be divided into two parts, the header part and the data part; the former describes how TXT2AST is to interpret the latter. The numbers in the data part are in columns, separated by spaces, but are not required to be aligned or any particular format. The header above is now described.

The first 2 lines are comments - all text from the semicolon to to the end of the line is ignored.

The 3rd line contains the word TOPLEVEL. This informs TXT2AST to create certain named components in the output dataset. Those components allowed are TITLE and TYPE.Their contents follow the name of the component - if the case of the text is important then enclose it in double quotes. The 3rd line demonstrates the use of the continuation character ~ to continue the information on the next line of the text file. The TOPLEVEL information is optional - TXT2AST will use defaults if it is not present.

The next line ( the 5th ) contains the word AXIS. This word is a column descriptor - ie. it indicates to TXT2AST the nature of a column in the data part of the file. Like TOPLEVEL, AXIS can optionally be followed by several keywords. See under the section on "Header_Part" for their meaning.

Each data descriptor corresponds to one column in the data part. The order of the descriptors is the same as the columns.

Once all the descriptors have been specified then the data begins. TXT2AST reads in the data lines and constructs the dataset.

Note that the data is sorted by TXT2AST, so there is no need to arrange the data in the correct order. This feature can be disabled using the SORT keyword - useful for scattered data, such as phase plots.

As mentioned above, much of the header data is optional - the minimal header required to get the above data into ASTERIX would be,

    AXIS
    DATA
    3  1.5
    6  0.5
    9  0.3
    12 1.2e-1
    15 2.3e-3
  
This completes the quick guide - for more information see the other subtopics in this help.



Next: Asymmetric Errors Up: TXT2AST Prev: TXT2AST