A package to generate Postscript plots with IDL
Developer Documentation

.
readdata.pro

Last modification date:
Sat May 11 11:42:47 2013
Statistics:
502 lines of code

READDATA

procedure READDATA, file, v1[, v2][, v3][, v4][, v5][, v6][, v7][, v8][, v9][, v10][, v11][, v12][, v13][, v14][, v15][, v16][, v17][, v18][, v19][, v20][, v21][, v22][, v23][, v24][, v25][, v26][, v27][, v28][, v29][, v30][, v31][, v32][, v33][, v34][, v35][, v36][, v37][, v38][, v39][, v40][, v41][, v42][, v43][, v44][, v45][, v46][, v47][, v48][, v49][, v50][, v51][, v52][, v53][, v54][, v55][, v56][, v57][, v58][, v59][, v60][, v61][, v62][, v63][, v64][, v65][, v66][, v67][, v68][, v69][, v70][, v71][, v72][, v73][, v74][, v75][, v76][, v77][, v78][, v79][, v80][, v81][, v82], [NP=variable], [ERR=variable], [FORMAT=string], [SKIPCH=string], [SEPCH=string], [/STRTRIM], [/ONESTRING], [STRUCTURE=integer], [TAGS=variable], [TEXT=variable], [/QUIET]

READDATA opens a data file and reads up to 82 columns. No header information is needed and lines that do not adhere to the expected format are interpreted as comments. See the full procedure

Examples
  READDATA can be used as: 
    READDATA, 'test.dat', a, b, c, d                              ; Unformatted data (double precision)
    READDATA, 'test.dat', x, y, z, FORMAT='(F,I,A)'               ; Simplified format data
    READDATA, 'test.dat', a, b, c, d, FORMAT='(2(D16.6,X),I5,A6)' ; Full format data
    READDATA, 'test.dat', x, /ONESTRING                           ; Each line is returned as a string 
    READDATA, 'test.dat', x, /STRUCTURE                           ; A structure is used as return 
Version
v. 3.1, 11 May 2013.
History

  v0.0: First version.   
  v0.1: Strings allowed.
  v1.0: General cleanup.
  v1.1: FORMAT and SKIPCH introduced.
        Name changed from READDATA2 to READDATA.
        A bug with ncompi is fixed.
  v1.2: General revision based oon READCOL.                               
        NMAX is eliminated.
        Two types of format (full and simplified) are allowed.
        SEPCH introduced.
        QUIET introduced.
  v1.3: New format 'E'.
  v1.4: Number of columns increased from 50 to 80.
  v2.0: English version.
  v2.1: IDLdoc documentation.
  v2.2: OPENHTML introduced.
        Upgrade to IDLdoc documentation. 
  v2.3: Number of columns increased from 80 to 82.
  v2.4: Bug with NP corrected. 
        Bug with L format fixed.
        Bug caused by update in astronomy library fixed.
        STRNUMBER substituted by VALID_NUM.
  v2.5: Version system update.  
        TEXT introduced.                
        Format issues with new IDL versions solved, but note the strange behavior that
         IDL has now (has ever?): READS, '2.3', v1, FORMAT='(I3)' gives v1 = 2 and      
         READS, '234', v1, FORMAT='(F3.1)' gives v1 = 234.000 i.e. IDL does not really
         care about decimal point placement in this respect! 
  v3.0: Adapted to SINGLEPLOT and SINGLECONTOUR changes.
        HTML pages moved to local directory.
  v3.1: Tabs converted to spaces in input. 
        STRTRIM added.
        STRUCTURE, TAGS added. 
Author
Jesús Maíz Apellániz, IAA
Statistics
Lines of code  502
McCabe Cyclomatic Complexity metric   93
McCabe Essential Complexity metric   12
McCabe Module Design Complexity metric   1

Parameters
file
in, required
string
File name.
v1
in, required
First variable to be read.
v2
in, optional
Additional variable to be read.
v3
in, optional
Additional variable to be read.
v4
in, optional
Additional variable to be read.
v5
in, optional
Additional variable to be read.
v6
in, optional
Additional variable to be read.
v7
in, optional
Additional variable to be read.
v8
in, optional
Additional variable to be read.
v9
in, optional
Additional variable to be read.
v10
in, optional
Additional variable to be read.
v11
in, optional
Additional variable to be read.
v12
in, optional
Additional variable to be read.
v13
in, optional
Additional variable to be read.
v14
in, optional
Additional variable to be read.
v15
in, optional
Additional variable to be read.
v16
in, optional
Additional variable to be read.
v17
in, optional
Additional variable to be read.
v18
in, optional
Additional variable to be read.
v19
in, optional
Additional variable to be read.
v20
in, optional
Additional variable to be read.
v21
in, optional
Additional variable to be read.
v22
in, optional
Additional variable to be read.
v23
in, optional
Additional variable to be read.
v24
in, optional
Additional variable to be read.
v25
in, optional
Additional variable to be read.
v26
in, optional
Additional variable to be read.
v27
in, optional
Additional variable to be read.
v28
in, optional
Additional variable to be read.
v29
in, optional
Additional variable to be read.
v30
in, optional
Additional variable to be read.
v31
in, optional
Additional variable to be read.
v32
in, optional
Additional variable to be read.
v33
in, optional
Additional variable to be read.
v34
in, optional
Additional variable to be read.
v35
in, optional
Additional variable to be read.
v36
in, optional
Additional variable to be read.
v37
in, optional
Additional variable to be read.
v38
in, optional
Additional variable to be read.
v39
in, optional
Additional variable to be read.
v40
in, optional
Additional variable to be read.
v41
in, optional
Additional variable to be read.
v42
in, optional
Additional variable to be read.
v43
in, optional
Additional variable to be read.
v44
in, optional
Additional variable to be read.
v45
in, optional
Additional variable to be read.
v46
in, optional
Additional variable to be read.
v47
in, optional
Additional variable to be read.
v48
in, optional
Additional variable to be read.
v49
in, optional
Additional variable to be read.
v50
in, optional
Additional variable to be read.
v51
in, optional
Additional variable to be read.
v52
in, optional
Additional variable to be read.
v53
in, optional
Additional variable to be read.
v54
in, optional
Additional variable to be read.
v55
in, optional
Additional variable to be read.
v56
in, optional
Additional variable to be read.
v57
in, optional
Additional variable to be read.
v58
in, optional
Additional variable to be read.
v59
in, optional
Additional variable to be read.
v60
in, optional
Additional variable to be read.
v61
in, optional
Additional variable to be read.
v62
in, optional
Additional variable to be read.
v63
in, optional
Additional variable to be read.
v64
in, optional
Additional variable to be read.
v65
in, optional
Additional variable to be read.
v66
in, optional
Additional variable to be read.
v67
in, optional
Additional variable to be read.
v68
in, optional
Additional variable to be read.
v69
in, optional
Additional variable to be read.
v70
in, optional
Additional variable to be read.
v71
in, optional
Additional variable to be read.
v72
in, optional
Additional variable to be read.
v73
in, optional
Additional variable to be read.
v74
in, optional
Additional variable to be read.
v75
in, optional
Additional variable to be read.
v76
in, optional
Additional variable to be read.
v77
in, optional
Additional variable to be read.
v78
in, optional
Additional variable to be read.
v79
in, optional
Additional variable to be read.
v80
in, optional
Additional variable to be read.
v81
in, optional
Additional variable to be read.
v82
in, optional
Additional variable to be read.

Keywords
NP
out, optional
variable
Number of elements in each variable.
ERR
out, optional
variable
Error flag.
FORMAT
in, optional
string
Format of the (simplified) type '(F,I,A)' or of the (full) type '(3(X,A2),I2,F5.1)'. Variable types allowed: A, B, D, E, F, I, L, and X (the latter, only full format).
SKIPCH
in, optional
string
Character to skip a line (use it to begin those lines).
SEPCH
in, optional
string (def. " ")
Separator to use for unformatted or simple-format cases.
STRTRIM
in, optional
boolean (def. FALSE)
Flag to eliminate white spaces with simple format when SEPCH is not " ".
ONESTRING
in, optional
boolean (def. FALSE)
Flag to read each line as a single string.
STRUCTURE
in, optional
integer (def. 0)
Flag to read each line as a structure. It also selects the line number to read the tags.
TAGS
out, optional
variable
Tag names (see structure).
TEXT
out, optional
variable
Lines that do not conform to the format.
QUIET
in, optional
boolean (def. FALSE)
Flag to supress informational messages.


Personal IDL library of Jesús Maíz Apellániz, Ramón y Cajal Fellow, Instituto de Astrofísica de Andalucía.
Feel free to contact me for more information about these routines or to submit a bug report or a feature request.

Produced by IDLdoc 1.6 beta on Fri Jun 28 22:22:43 2013