writers.text

Contents

writers.text#

The text writer writes out to a text file. This is useful for debugging or getting smaller files into an easily parseable format. The text writer supports both GeoJSON and CSV output.

Default Embedded Stage

This stage is enabled by default

Streamable Stage

This stage supports streaming operations

Example#

[
    {
        "type":"readers.las",
        "filename":"inputfile.las"
    },
    {
        "type":"writers.text",
        "format":"geojson",
        "order":"X,Y,Z",
        "keep_unspecified":"false",
        "filename":"outputfile.txt"
    }
]

Options#

filename

File to write to, or “STDOUT” to write to standard out [Required]

format

Output format to use. One of geojson or csv. [Default: “csv”]

precision

Decimal Precision for output of values. This can be overridden for individual dimensions using the order option. [Default: 3]

order

Comma-separated list of dimension names in the desired output order. For example “X,Y,Z,Red,Green,Blue”. Dimension names can optionally be followed with a colon (‘:’) and an integer to indicate the precision to use for output. Ex: “X:3, Y:5,Z:0” If no precision is specified the value provided with the [precision] option is used. [Default: none]

keep_unspecified

If true, writes all dimensions. Dimensions specified with the [order] option precede those not specified. [Default: true]

jscallback

When producing GeoJSON, the callback allows you to wrap the data in a function, so the output can be evaluated in a <script> tag.

quote_header

When producing CSV, should the column header named by quoted? [Default: true]

write_header

Whether a header should be written. [Default: true]

newline

When producing CSV, what newline character should be used? (For Windows, \\r\\n is common.) [Default: “\n”]

delimiter

When producing CSV, what character to use as a delimiter? [Default: “,”]

where

An expression that limits points passed to a writer. Points that don’t pass the expression skip the stage but are available to subsequent stages in a pipeline. [Default: no filtering]

where_merge

A strategy for merging points skipped by a ‘where' option when running in standard mode. If true, the skipped points are added to the first point view returned by the skipped filter. If false, skipped points are placed in their own point view. If auto, skipped points are merged into the returned point view provided that only one point view is returned and it has the same point count as it did when the writer was run. [Default: auto]

Contents