From 5434adac7c2e0ca2076eed4596104fb89b7fec4a Mon Sep 17 00:00:00 2001 From: Bradley J Chambers Date: Tue, 17 Nov 2020 09:39:03 -0600 Subject: [PATCH] Update PCD writer documentation --- doc/stages/writers.pcd.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/doc/stages/writers.pcd.rst b/doc/stages/writers.pcd.rst index b0d4545574..ebb94ebdcf 100755 --- a/doc/stages/writers.pcd.rst +++ b/doc/stages/writers.pcd.rst @@ -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 ------- @@ -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