2D Scatter Point Files

From XMS Wiki
Jump to: navigation, search

Two-dimensional scatter point sets are stored in 2D scatter point files. Multiple scatter point sets can be stored in a single file. Each point in a scatter point set is defined by a pair of xy coordinates. The format of the 2D scatter file is shown in Figure 1 and a sample file in Figure 2.

SCAT2D /* File type identifier */
BEGSET /* Beginning of cards for scatter point set */
NAME "name" /* Name of scatter point set */
ID id /* ID of scatter point set */
DELEV elev1 /* Default elevation */
IXY np /* Number of points in set, begin point listing */
id1 x1 y1 /* Point id and coordinatess, one per line */
id2 x2 y2
.
.
idnp xnp ynp
ENDSET /* End of cards for scatter point set */
/* Repeat point set cards as many times as necessary */

Figure 1. 2D Scatter Point File Format.


SCAT2D
BEGSET
NAME "gages"
ID 8493
DELEV 0.00000000000e+00
IXY 25
1 1.47000000000e+02 3.90000000000e+02
2 8.82000000000e+02 9.49000000000e+02
.
.
24 1.73000000000e+02 7.01000000000e+02
25 5.39000000000e+02 8.98000000000e+02
ENDSET

Figure 2. Sample 2D Scatter Point File.


The cards used in the 2D scatter point file are as follows:

Card Type SCAT2D
Description File type identifier. Must be on first line of file. No fields.
Required YES


Card Type BEGSET
Description Identifies the beginning of a scatter point set. No fields.
Required NO


Card Type NAME
Description Defines the name for the following scatter point set.
Required NO
Field Variable Value Description


Format

NAME "name"

Sample

NAME "wells"

Field

Variable
Value
Description

1

name
str
The name for the following scatter points. Remains as default until new NAME card is encountered.


Card Type

ID

Description

Defines the ID for the scatter point set.

Required

YES

Format

ID id

Sample

ID 43098

Field

Variable
Value
Description

1

id
+
The ID for the following scatter point set.


Card Type

DELEV

Description

Defines the default elevation for the scatter point set.

Required

NO

Format

DELEV el

Sample

DELEV 9.0

Field

Variable
Value
Description

1

el
±
The default elevation for the following scatter points. Remains as default until new DELEV card is encountered.


Card Type

IXY

Description

Defines a scatter point set.

Required

YES

Format

IXY np

id1 x1 y1

id2 x2 y2

.

.

idnp xnp ynp


Sample

IXY 4

1 12.3 34.5

2 52.2 23.5

3 63.2 27.4

4 91.1 29.3


Field

Variable
Value
Description

1

np
+
The number of scatter points in the scatter point set.

2

id
+
The ids of the points.

3-4

x,y
±
The coordinates of the points.

Repeat fields 2–4 np times




Card Type

ENDSET

Description

Identifies the end of a scatter point set. No fields.

Required

NO


Back to XMS