10.5.2   Standard (SATURN) Format Matrix Data Files

MX can read in a trip matrix from a “standard” ascii .dat file using a standard format described formally in Section 4.  The detailed specification is as follows:

1)       RUN CARD     (Optional)

Cols. 1 -  3 ‘RUN’

Cols. 5 - 80          A title associated with the run.

If omitted a default run name is used.

2)       NAMELIST PARAMETERS (&PARAM) (Mandatory)

See Appendix A for a description of Namelist input.

Table 10.2 – Namelist Parameters

Parameter

Type

Default

Interpretation

NROWS

INTEGER

0

Defines the number of rows (i.e., origins) of the matrix to be built

NCOLS

INTEGER

0

Defines the number of columns (i.e., destinations) of the matrix to be built

KROPT

INTEGER

1

Defines the formats for the matrix elements, records 5) below. 1 signifies SATURN formats, either “long” or “short”.  See Section 4.4 for the (currently limited) alternatives: 4 for CSV and 6 for TUBA 1.

IROCKY

INTEGER

0

The sector corresponding to a zone may be derived by dividing the zone number by IROCKY (a very bad spelling of HIERARCHY!).  If 0 it does not apply.  See 5.1.7.

LONG

LOGICAL

F

T – The ‘long’ input formats apply- see ‘the MATRIX ELEMENTS’ records (5)(b) below

LONGER

LOGICAL

F

T – The “long” data is in strictly formatted blocks of 10 columns – see (5)(b) below

MPNEXT

LOGICAL

F

T – Matrix parameters are given on the following record

TFL

LOGICAL

F

T - The rules for hierarchical node and zone numbers as used in TfL networks are assumed to operate. E.g., the first digit in a 4-digit zone number gives its sector. See 5.1.7.2 and 6.8

GISFIL

TEXT

‘’

The filename of the GIS file associated with this matrix (5.7)

FILZ2S

TEXT

Blank

The filename of a file listing the sectors per zone; see 10.2.5.3.

FILZ2G

TEXT

Blank

The filename listing groups per zone (see 10.2.5.5).

 

3)       THE “MATRIX PARAMETER” RECORD (optional - MPNEXT=T)

Cols.  1 - 8           - The “units” of the matrix elements; e.g., time

Cols.  9 - 16         - The “dimensions” of the elements, e.g. minutes

(See Section 10.2.3 for a more complete explanation of these terms.    If MPNEXT is .FALSE. they are set to blank by default.)

4)       MATRIX TITLE RECORD   (Mandatory)

Cols. 1 - 76  A title for the SATURN matrix; see 10.2.6

5)       MATRIX ELEMENTS   (Mandatory)

If KROPT = 1 two different “standard SATURN” input formats are allowed depending on the value of the logical parameters LONG and/or LONGER. (But, see Section 4.4, further “non-standard” alternatives also exist for KROPT > 1, e.g., CSV if KROPT = 4.)

(a)  LONG = FALSE (its default):                   (FORMAT 15I5)

1ST CARD(S) - The “name” for row 1 in cols. 1 to 5, followed by the NCOLS elements in cols. 6-10, 11-15, etc., using the subsequent cards as necessary.  Thus the first record contains the name plus 14 elements, the second record contains elements 15-29 with the 15th element in cols. 1-5.

2ND CARD(S) -          As above for the second row. Etc..Etc.. .

 (b)  LONG = TRUE:

1st CARD(S) - The ‘name’ for row 1 in cols. 1 to 5, followed by the NCOLS elements in cols. 6 - 15, 16 - 25, ... up to column 75, starting with cols. 6 - 15 on any subsequent records, written as F10.3;  i.e., the decimal points must (normally) lie in columns 12, 22,...62.

But – if LONGER = T – with both the name and the cell values in strictly fixed blocks of 10 columns so that the name is in columns 1-10 on record one and the cell values are in columns 11-20, 21-30 … up to column 80. Thus the cell data on all records beyond the first start in column 11, 7 cells per record.

2nd CARD(S) - As above for the second row. Etc..etc..

In either case the ‘names’ must be in strictly increasing order, but not necessarily sequential; see Section 10.2.2.

                END OF THE DATA INPUT