Writer Directives
The suffixes shown are prefixed by the current <WriterKeyword> in a mapping file. By default, the <WriterKeyword> for the Point Cloud XYZ reader is POINTCLOUDXYZ.
DATASET
This is the name of a folder containing one or more XYZ files.
The default extensions for Point Cloud XYZ files are .xyz, .csv, or .txt. To write gzipped files, use .xyz.gz as the destination file extension.
Required/Optional
Required
Mapping File Syntax
POINTCLOUDXYZ_DATASET /usr/data/xyz/output
Workbench Parameter
Destination Point Cloud XYZ Folder
DEF
Defines a Point Cloud XYZ file. The definition contains the file’s base name without any of the extensions, followed by the definitions of the attributes. There may be many DEF lines, one for each file to be written.
The syntax of a Point Cloud XYZ DEF line is:
<WriterKeyword>_DEF <baseName> \
[<attrName> <attrType>]+
The following DEF line directives are supported by the writer:
DEF Line Directives |
Value |
Required / Optional |
POINTCLOUDXYZ_INCLUDE_FIELD_NAME <yes|no> |
See INCLUDE_FIELD_NAME below for details. |
Optional |
POINTCLOUDXYZ_SEPARATOR <separator> |
See SEPARATOR below for details. |
Required |
POINTCLOUDXYZ_EXTENSION <extension> |
See EXTENSION below for details. |
Optional |
POINTCLOUDXYZ_ENCODING <encoding> |
See ENCODING for details. |
Optional |
POINTCLOUDXYZ_END_OF_LINE <yes|no> |
See END_OF_LINE for details. |
Optional |
POINTCLOUDXYZ _COLUMN_TO_PCCOMPONENT <pc,colName pairwise list> |
See COLUMN_TO_PCCOMPONENT for details. |
Required |
POINTCLOUDXYZ_QUOTE_FIELD_NAMES <yes|no|if_needed> |
See QUOTE_FIELD_NAMES for details |
Optional |
POINTCLOUDXYZ_WRITE_UTF8_BOM <yes|no> |
See WRITE_UTF8_BOM for details |
Optional |
Each of these directives has the same meaning as the global Point Cloud XYZ writer keyword with the same suffix. Any value specified on a DEF line will override values defined for equivalent global directives, as they apply to the table being defined.
Required/Optional
Required
INCLUDE_FIELD_NAME
If set this value to yes, the field names will be written as the first line in the output file. If it is set to no, column names will not be written to file.
Required/Optional
Optional
Values
Values: <yes (default) | no>
Workbench Parameter
Output Field Names
SEPARATOR
A special field is listed to identify the separator used to divide the fields in the file. By default, a space is used; however you can also use any of these one-character separators:
- Comma: ,
- Semicolon: ;
- Vertical bar: |
- Tab: indicated by a backslash (\) followed by a “t”; for example:
POINTCLOUDXYZ_SEPARATOR \t
There must be a space between POINTCLOUDXYZ _SEPARATOR and <separator>. The opening and closing angle brackets are optional.
Required/Optional
Required
Values
<separator>
COLUMN_TO_PCCOMPONENT
This directive specifies the point components to be written and the order of the fields in the output XYZ file.
Values
<component, columnname pairwise list>
Required/Optional
Optional
Workbench Parameter
Component Mapping
EXTENSION
This direction specifies the file extension to be written.
Values
<extension>
Default: .xyz
If the extension ends in .gz (e.g., xyz.gz) the writer will output gzipped files.
Required/Optional
Optional
Workbench Parameter
Extension
APPEND
Values
yes | no
Default: no
Required/Optional
Optional
Workbench Parameter
Append to File
QUOTE_FIELD_NAMES
This directive specifies whether the field names written on the first row of the file are quoted.
Values
yes | no | if_needed (default)
If set to yes, then field names will be quoted. If set to no, field names will not be quoted. If set to if_needed, field names will be quoted only if they contain a separator character.
Required/Optional
Optional
Workbench Parameter
Quote Field Names
QUOTE_OUTPUT
This directive specifies whether the values written to the file are quoted. If yes, every value is quoted. If no, no values are quoted. If set to if_needed, values are quoted if they contain one or more separator or quote characters.
If set to no, and the field contains an embedded separator, the separator character in that field is replaced by the space character. If space is already the separator, the underscore character is used instead. Generally, setting this directive to if_needed is a better choice in this case.
Values
yes | no | if_needed (default)
Required/Optional
Optional
Workbench Parameter
Quote Field Names
ENCODING
This directive specifies the file encoding to use when writing.
Values
<encoding>
Default: System
Encodings |
UTF-8 |
UTF-16LE |
UTF-16BE |
ANSI |
BIG5 |
SJIS |
CP437 |
CP708 |
CP720 |
CP737 |
CP775 |
CP850 |
CP852 |
CP855 |
CP857 |
CP860 |
CP861 |
CP862 |
CP863 |
CP864 |
CP865 |
CP866 |
CP869 |
CP932 |
CP936 |
CP950 |
CP1250 |
CP1251 |
CP1252 |
CP1253 |
CP1254 |
CP1255 |
CP1256 |
CP1257 |
CP1258 |
ISO8859-1 |
ISO8859-2 |
ISO8859-3 |
ISO8859-4 |
ISO8859-5 |
ISO8859-6 |
ISO8859-7 |
ISO8859-8 |
ISO8859-9 |
ISO8859-13 |
ISO8859-15 |
Required/Optional
Optional
Workbench Parameter
Character Encoding
END_OF_LINE
This directive specifies the end of line character to use when writing.
Values
Macintosh | Windows | Unix | System (default)
Required/Optional
Optional
Workbench Parameter
Line Termination
WRITE_UTF8_BOM
This directive specifies whether the byte order mark for UTF-encoded files should be written at the beginning.
This option only has an effect when the encoding is set to a UTF encoding.
Values
yes (default) | no
Required/Optional
Optional
Workbench Parameter
Write UTF-8 Byte Order Mark