CARIS Support Files : Portrayal Files : Lookup Tables
 

Lookup Tables

Lookup tables define symbology for INT1, S-52 and VPF portrayals. All files are in text format and have a .dic file extension.

The following table lists portrayals and associated lookup tables.

Portrayal

Lookup Tables

S-52 Simplified

areas: asymrefs.dic

lines: lsymrefs.dic

points: psymrefs.dic

S-52 Traditional

areas: asymreft.dic

lines: lsymrefs.dic

points: psymreft.dic

IENC Simplified

areas: aiencs.dic

lines: lienc.dic

points: piencs.dic

IENC Traditional

areas: aienct.dic

lines: lienc.dic

points: pienct.dic

IENC Simplified-Brazil

areas: aiencs.dic

lines: lienc.dic

points: piencs_brazil.dic

IENC Traditional-Brazil

areas: aienct.dic

lines: lienc.dic

points: pienct_brazil.dic

IENC Simplified-Paraguay-Parana Waterway

areas: aiencs.dic

lines: lienc.dic

points: piencs_paraguay.dic

IENC Traditional-Paraguay-Parana Waterway

areas: aienct.dic

lines: lienc.dic

points: pienct_paraguay.dic

VPF

areas: vpf_areas.dic

lines:  vpf_lines.dic

points: vpf_points.dic

INT1

areas: asymrefs.dic

lines: lsymrefs.dic

points: psymrefs.dic

text: tsymrefs.dic

All lookup file entries use the same structure: a row starting with a feature acronym and followed by six other fields – each field is separated by a comma and enclosed in quotation marks.

All lookup tables contain non-printing unit separator characters. These cannot be removed without corrupting the table. Lookup tables should be modified in a text editor capable of displaying non-printing characters.

The first four fields are used for displaying data.

Features are drawn in the chart by matching feature type to the appropriate lookup table. For example, an INT1 area feature is located in asymrefs.dic.

The following sections describe how CARIS reads the four fields.

Object Acronym

The Object Acronym field has the following characteristics:

six-character object acronym

features are listed in alphabetical order

all entries for a single feature code are grouped together

specific entries are listed before more general entries

if no feature acronym is found, the first entry is used to draw the feature

Attribute Value

The Attribute Value field has the following characteristics:

six-character attribute acronym

attributes are listed in the following format
<attribute_acronym><value><separator>

if the attribute is defined, the object must contain the attribute

if the attribute value is marked with ?, then the value is set to UNKNOWN

matching attribute values must be of integer or float type—string attributes are not matched

specific attribute entries are listed before more general entries

When a lookup table has been selected, CARIS checks the table to find the acronym and attributes corresponding to the feature. This means that the first entry in the lookup table whose attributes matches the feature will be chosen. If there is more than one entry for an acronym, the first match is used.

For example, if the dataset contains an ACHARE (Anchorage area) feature with a Category of Anchorage (CATACH) attribute with a value of 2, the third entry for the ACHARE feature acronym, CATACH2, is used.

If the ACHARE feature contains no attribute values, or contains attribute values not listed in the lookup table, the first entry is used.

"ACHARE","","LC(NPPART)","3","S","DISPLAYBASE","26220"

"ACHARE","CATACH1OBJNAM","LC(NPPART);SY(NPAN)","3","S","DISPLAYBASE","26220"

"ACHARE","CATACH2","LC(NPPART);SY(DLAN)","3","S","DISPLAYBASE","26220"

"ACHARE","CATACH3","LC(NPPART);SY(DLAN)","3","S","DISPLAYBASE","26220"

"ACHARE","CATACH4","LC(NPANSY);SY(DLAN);SY(IN12)","3","S","DISPLAYBASE","26220"

"ACHARE","CATACH5","LC(NPPART);SY(DLAN);SY(NPALHO)","3","S","DISPLAYBASE","26220"

"ACHARE","CATACH9","LC(NPPART);SY(DLAN)","3","S","DISPLAYBASE","26220"

"ACHARE","STATUS6","LC(NPPART);SY(DLAN)","3","S","DISPLAYBASE","26220"

In another example a soundings feature code is not specified for the following entry:

"SOUNDG","","CS(SOUNDG02)","6","O","OTHER","33010"

You can add the SGSL1 soundings feature code to the entry:

"SOUNDG","","CS(SOUNDG02,,SGSL1)","6","O","OTHER","33010"

SGSL1 will be used for all SOUNDG features.

Symbolization

The Symbolization field has the following characteristics:

symbology entries are separated by semi-colons;

entries are placed in the order given in the lookup table;

area colour fills are listed before lines or centred symbols; and,

features drawn with no specific symbolization use double quotation marks ("").

The following table lists the feature type and relevant symbolization codes.

Feature Type

Symbology Instruction

Comments

Points

CS(SOUNDG02,
DEPTH_ATTRIBUTE,
FEATURE_CODE)

(S-52 only)

This code is a call to a conditional symbology procedure, used only for drawing soundings type point features.

Note: DEPTH_ATTRIBUTE and FEATURE_CODE are parameters of the SOUNDG02 procedure.

SOUNDG02: the conditional symbology procedure used to display depth values for point objects. As a procedure call, this parameter is a literal value which must be included in the instruction as SOUNDG02.

DEPTH_ATTRIBUTE: the sounding feature attribute from which the sounding value is retrieved (for example, VALSOU).

FEATURE_CODE: the feature code used (for example, SGSL).

SY(FEATURE_CODE)

(paper charts only)

This code is used for drawing a symbol using the specified feature code in the ih_master.txt file.

If the feature code does not exist in the master file or in invalid for symbols, a ? character is used instead.

SY(FEATURE_CODE, ORIENT)

(paper charts only)

This code is similar to the above, except that it can assign an angular distance measured from true north (north azimuth). This can be the value of the attribute (typically ORIENT) or an explicit number.

Points (cont’d)

TE, TX (STRING, HJUST,
VJUST,SPACE,CHARS,
XOFFS,YOFFS,COLOUR,
DISPLAY)

(S-52 only)

The TE code is used for numeric only text, such as soundings.

The TX code is used for alphanumeric text.

STRING: text string

HJUST: horizontal justification
1 - centre
2 - right
3 - left (default))

VJUST: vertical justification
1 - bottom (default)
2 - centre
3 - top

SPACE: character spacing
1 - fit (characters are expanded or compressed to
fit the current field width)
2 - standard (CHARS attribute typeface and
spacing is used) (default)
3 - standard with word wrap (CHARS attribute
typeface and spacing is used, text longer than
8 characters is split to fit onto separate lines).

CHARS: character specification
- defines style (font), weight, width (straight,
italic), and text character size.
- Style: 1 - a plain, sans serif font (recommended)
- Weight: 4 - light, 5 - medium (default), 6 - bold
- Width: 1 - upright (non-italic, recommended); for
ENC $CHARS attributes, set value to 2)
- Body Size: 10 - uppercase character height
(measured in pica points; 10 pica (default)
= 3.51mm; this is the minimum size).

XOFFS: X-offset of the pivot point, measured in the units used for Body Size (see CHARS).
0 (default value): undefined
+ (value greater than zero): right offset
- (value less than zero): left offset
Note: offset = value * Body Size

YOFFS: Y-offset of the pivot point, measured in the units used for Body Size (see CHARS)
0 (default value): undefined
+ (value greater than zero): downward offset
- (value less than zero): upward offset
Note: offset = value * Body Size

COLOUR: 5-character colour token.

DISPLAY: text grouping, if any, for the selection.

Lines

LC(FEATURE_CODE)

(paper charts only)

This code draws a complex line using the feature code specified in the ih_master file.

Line ends are drawn as retangular or rounded, according to the feature code in ih_master.txt. If the feature code does not specify a line-end style, rectangular is used as the default.

If the $capsy (cap style) attribute for the line feature is set, this value overrides the feature code settings in ih_master.txt.

If the feature code does not exist in the master file or in invalid for symbols, a ? character is used instead.

The LC code is the preferred code for line drawing.

LS(SOLD, 1, COLOUR_TOKEN)

(paper charts only)

This code draws a line. The first parameter can be SOLD (solid), DOTT (dotted line), or DASH (dashed line).

The second parameter is the width of the line (in pixels).

The third parameter is the colour token.

If the $capsy (cap style) attribute for the line feature is set, this value overrides the settings in line lookup table.

The default line end is rectangular.

LC(FEATURE_CODE)

(S-52 only)

This code draws a line using a feature code specified in LIN (.lin) file in symshow folder.

If the $capsy (cap style) attribute for the line feature is set, this value overrides the feature code settings.

LS(SOLD, 1, COLOUR_TOKEN)

(S-52 only)

This code draws a line. The first parameter can be SOLD (solid), DOTT (dotted line), or DASH (dashed line).

The second parameter is the width of the line (in pixels).

The third parameter is the colour token.

The default line end is rounded.

SY(FEATURE_CODE, ORIENT)

(S-52 only)

This code is used for drawing a symbol in the middle of a line.

This is the same code as used for point symbolization. See the Points section for more information.

Areas

AC(COLOUR_TOKEN)

(S-52 and paper charts)

This code specifies the colour token name from ih_colour.xml.

AC(COLOUR_TOKEN,
TRANSPARENCY_VALUE)

(S-52 and paper charts)

The second parameter is used to define transparency (1=25%, 2=50%, 3=75%).

This feature is not yet supported: only solid colours are drawn.

AH(COLOUR_TOKEN,STYLE,
THICKNESS,SPACING)

(paper charts only)

The STYLE parameter sets the hatch pattern:

BackDiagonal

Cross

DiagonalCross

ForwardDiagonal

Horizontal

Vertical

The default value is ForwardDiagonal. All hatch style values are case sensitive

The third parameter sets the thickness of the hatch lines. The default value is 0.01 mm.

The fourth parameter sets the spacing between the hatch lines. The default value is 1.0 mm.

AP(FEATURE_CODE)

(paper charts only)

The pattern fill name used to reference pattern fill definitions (not yet supported).

LC(FEATURE_CODE)

(paper charts only)

For definitions, see the Lines type section.

LS(SOLD,1,COLOUR_TOKEN)

(paper charts only)

For definitions, see the Lines type section.

SY(FEATURE_CODE, ORIENT)

(paper charts only)

For definitions, see the Points type section.

Text

TB(FILL_COLOUR,
OUTLINE_COLOUR,
OUTLINE_WIDTH,
MARGIN_RIGHT_MM,
MARGIN_LEFT_MM,
MARGIN_TOP_MM,
MARGIN_BOTTOM_MM)

(paper charts only)

Draw a text box around the text feature.

FILL_COLOUR: background colour
OUTLINE_COLOUR: border colour
MARGIN_RIGHT_MM: distance of the right-hand side of the margin in millimetres.
MARGIN_LEFT_MM: distance of the left-hand side of the margin in millimetres.
MARGIN_TOP_MM: distance of the top-side edge of the margin in millimetres.
MARGIN_BOTTOM_MM: distance of the right-side edge of the margin in millimetres.

TH(COLOUR,WIDTH_MM)

(paper charts only)

Draw a halo around each character of the text feature.

The first parameter is the colour token.

The second parameter is the width of the halo line around each text character. The halos are drawn underneath the characters of the text.

TS(SYMBOL_NAME,SIZE_MM,OFFSETS_X_MM,
OFFSETS_Y_MM,ANGLE)

(paper charts only)

Draw a symbol behind the text feature.

SYMBOL_NAME: name of the symbol drawn with the text.

SIZE_MM: size of the symbol in millimetres.

OFFSETS_X_MM: left/right offset for the symbol.

OFFSETS_Y_MM: downward/upward offset for the symbol.

ANGLE: the angle at which the symbol is drawn with respect to the text.

Display Priority

The Priority value controls the drawing order of objects. Features are drawn in numerical order, so features with a priority of one are drawn first and then the higher priority features are drawn on top of these features. You can override the default priority levels set in this file using the $prior attribute.