Skip to content

Commit

Permalink
Update PCD writer documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
chambbj committed Feb 17, 2021
1 parent 974bb34 commit 5434ada
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion doc/stages/writers.pcd.rst
Expand Up @@ -13,6 +13,21 @@ formatted data.

.. streamable::

.. note::

X, Y, and Z dimensions will be written as single-precision floats by
default to be compatible with most of the existing PCL point types. These
dimensions can be forced to double-precision using the `order` option, but
the PCL code reading this data must be capable of reading double-precision
fields (i.e., it is not the responsibility of PDAL to ensure this
compatibility).

.. note::

When working with large coordinate values it is recommended that users
first translate the coordinate values using :ref:`filters.transformation`
to avoid loss of precision when writing single-precision XYZ data.


Example
-------
Expand Down Expand Up @@ -42,7 +57,7 @@ compression

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

_`order`
Comma-separated list of dimension names in the desired output order. For
Expand Down

0 comments on commit 5434ada

Please sign in to comment.