Skip to content

Commit 931bfcf

Browse files
authored
Fix (sorted) position of the PDAL "Height above ground" algorithm
and use a multi-column table of contents
1 parent 1b3ee3f commit 931bfcf

File tree

1 file changed

+122
-115
lines changed

1 file changed

+122
-115
lines changed

docs/user_manual/processing_algs/qgis/pointclouddatamanagement.rst

Lines changed: 122 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Point Cloud Data Management
66
.. contents::
77
:local:
88
:depth: 1
9+
:class: toc-columns
910

1011
.. attention:: Running these algorithms requires QGIS installed with PDAL_ >= 2.5.0
1112
(see :menuselection:`Help --> About` menu).
@@ -709,121 +710,6 @@ Python code
709710
:start-after: **algorithm_code_section**
710711
:end-before: **end_algorithm_code_section**
711712

712-
.. _pdalheightabovegroundbynearestneighbor:
713-
714-
Height above ground
715-
-----------------------------
716-
|400|
717-
718-
Calculates the height of points above the ground surface in a point cloud using a nearest neighbor algorithm.
719-
For each point, the algorithm finds the specified number of nearest ground-classified points
720-
(classification value 2) and interpolates the ground elevation from them using
721-
`Inverse Distance Weighting (IDW) <https://gisgeography.com/inverse-distance-weighting-idw-interpolation/>`_.
722-
The output adds a HeightAboveGround dimension to the point cloud.
723-
If 'Replace Z values' is enabled, the Z coordinate will be replaced with the height above ground value.
724-
Maximum Distance parameter can limit the search radius (0 = no limit).
725-
726-
Parameters
727-
..........
728-
729-
.. list-table::
730-
:header-rows: 1
731-
:widths: 20 20 20 40
732-
:class: longtable
733-
734-
* - Label
735-
- Name
736-
- Type
737-
- Description
738-
* - **Input layer**
739-
- ``INPUT``
740-
- [point cloud]
741-
- Input point cloud layer used to calculate height above ground.
742-
* - **Replace Z values with height above ground**
743-
- ``REPLACE_Z``
744-
- [boolean]
745-
746-
Default: True
747-
- If set to True, Z coordinate will be replaced with the height above ground value.
748-
Otherwise, the original Z values are kept.
749-
* - **Number of neighbors for terrain interpolation**
750-
- ``COUNT``
751-
- [numeric: integer]
752-
753-
Default: 1
754-
- The number of neighboring ground
755-
points used to interpolate the terrain elevation.
756-
* - **Maximum search distance**
757-
- ``MAX_DISTANCE``
758-
- [numeric: double]
759-
760-
Default: 0.0
761-
- Maximum distance used to limit the search radius. If set to 0, the search distance is unlimited.
762-
* - **Height above ground**
763-
- ``OUTPUT``
764-
- [point cloud]
765-
766-
Default: ``[Save to temporary file]``
767-
- Specify the point cloud file to export the point cloud with height above ground value.
768-
:ref:`One of <output_parameter_widget>`:
769-
770-
.. include:: ../algs_include.rst
771-
:start-after: **file_output_types**
772-
:end-before: **end_file_output_types**
773-
774-
Advanced parameters
775-
^^^^^^^^^^^^^^^^^^^
776-
777-
.. list-table::
778-
:header-rows: 1
779-
:widths: 20 20 20 40
780-
:class: longtable
781-
782-
* - Label
783-
- Name
784-
- Type
785-
- Description
786-
* - **VPC Output Format**
787-
- ``VPC_OUTPUT_FORMAT``
788-
- [enumeration]
789-
790-
Default: 0
791-
- Specify the underlying format in which data are stored
792-
for Virtual Point Cloud (:file:`.vpc`) output.
793-
Possible formats are:
794-
795-
* 0 --- ``COPC``
796-
* 1 --- ``LAZ``
797-
* 2 --- ``LAS``
798-
799-
LAZ/LAS may be faster to process, however they only
800-
allow rendering of the point cloud extents.
801-
802-
Outputs
803-
.......
804-
805-
.. list-table::
806-
:header-rows: 1
807-
:widths: 20 20 20 40
808-
:class: longtable
809-
810-
* - Label
811-
- Name
812-
- Type
813-
- Description
814-
* - **Height above ground**
815-
- ``OUTPUT``
816-
- [point cloud]
817-
- Output point cloud layer with height above ground calculated for each point.
818-
819-
Python code
820-
...........
821-
822-
**Algorithm ID**: ``pdal:heightabovegroundbynearestneighbor``
823-
824-
.. include:: ../algs_include.rst
825-
:start-after: **algorithm_code_section**
826-
:end-before: **end_algorithm_code_section**
827713

828714
.. _pdaltile:
829715

@@ -1164,6 +1050,125 @@ Python code
11641050
:start-after: **algorithm_code_section**
11651051
:end-before: **end_algorithm_code_section**
11661052

1053+
.. _pdalheightabovegroundbynearestneighbor:
1054+
1055+
Height above ground
1056+
-----------------------------
1057+
|400|
1058+
1059+
Calculates the height of points above the ground surface in a point cloud using a nearest neighbor algorithm.
1060+
For each point, the algorithm finds the specified number of nearest ground-classified points
1061+
(classification value 2) and interpolates the ground elevation from them using
1062+
`Inverse Distance Weighting (IDW) <https://gisgeography.com/inverse-distance-weighting-idw-interpolation/>`_.
1063+
The output adds a HeightAboveGround dimension to the point cloud.
1064+
If 'Replace Z values' is enabled, the Z coordinate will be replaced with the height above ground value.
1065+
Maximum Distance parameter can limit the search radius (0 = no limit).
1066+
1067+
.. seealso:: :ref:`pdalheightabovegroundtriangulation`
1068+
1069+
Parameters
1070+
..........
1071+
1072+
.. list-table::
1073+
:header-rows: 1
1074+
:widths: 20 20 20 40
1075+
:class: longtable
1076+
1077+
* - Label
1078+
- Name
1079+
- Type
1080+
- Description
1081+
* - **Input layer**
1082+
- ``INPUT``
1083+
- [point cloud]
1084+
- Input point cloud layer used to calculate height above ground.
1085+
* - **Replace Z values with height above ground**
1086+
- ``REPLACE_Z``
1087+
- [boolean]
1088+
1089+
Default: True
1090+
- If set to True, Z coordinate will be replaced with the height above ground value.
1091+
Otherwise, the original Z values are kept.
1092+
* - **Number of neighbors for terrain interpolation**
1093+
- ``COUNT``
1094+
- [numeric: integer]
1095+
1096+
Default: 1
1097+
- The number of neighboring ground
1098+
points used to interpolate the terrain elevation.
1099+
* - **Maximum search distance**
1100+
- ``MAX_DISTANCE``
1101+
- [numeric: double]
1102+
1103+
Default: 0.0
1104+
- Maximum distance used to limit the search radius. If set to 0, the search distance is unlimited.
1105+
* - **Height above ground**
1106+
- ``OUTPUT``
1107+
- [point cloud]
1108+
1109+
Default: ``[Save to temporary file]``
1110+
- Specify the point cloud file to export the point cloud with height above ground value.
1111+
:ref:`One of <output_parameter_widget>`:
1112+
1113+
.. include:: ../algs_include.rst
1114+
:start-after: **file_output_types**
1115+
:end-before: **end_file_output_types**
1116+
1117+
Advanced parameters
1118+
^^^^^^^^^^^^^^^^^^^
1119+
1120+
.. list-table::
1121+
:header-rows: 1
1122+
:widths: 20 20 20 40
1123+
:class: longtable
1124+
1125+
* - Label
1126+
- Name
1127+
- Type
1128+
- Description
1129+
* - **VPC Output Format**
1130+
- ``VPC_OUTPUT_FORMAT``
1131+
- [enumeration]
1132+
1133+
Default: 0
1134+
- Specify the underlying format in which data are stored
1135+
for Virtual Point Cloud (:file:`.vpc`) output.
1136+
Possible formats are:
1137+
1138+
* 0 --- ``COPC``
1139+
* 1 --- ``LAZ``
1140+
* 2 --- ``LAS``
1141+
1142+
LAZ/LAS may be faster to process, however they only
1143+
allow rendering of the point cloud extents.
1144+
1145+
Outputs
1146+
.......
1147+
1148+
.. list-table::
1149+
:header-rows: 1
1150+
:widths: 20 20 20 40
1151+
:class: longtable
1152+
1153+
* - Label
1154+
- Name
1155+
- Type
1156+
- Description
1157+
* - **Height above ground**
1158+
- ``OUTPUT``
1159+
- [point cloud]
1160+
- Output point cloud layer with height above ground calculated for each point.
1161+
1162+
Python code
1163+
...........
1164+
1165+
**Algorithm ID**: ``pdal:heightabovegroundbynearestneighbor``
1166+
1167+
.. include:: ../algs_include.rst
1168+
:start-after: **algorithm_code_section**
1169+
:end-before: **end_algorithm_code_section**
1170+
1171+
11671172
.. _pdalheightabovegroundtriangulation:
11681173

11691174
Height above ground (using triangulation)
@@ -1178,6 +1183,8 @@ specified number of neighbors, then computes the height above this surface for a
11781183
The output adds a HeightAboveGround dimension to the point cloud. If 'Replace Z values' is enabled,
11791184
the Z coordinate will be replaced with the height above ground value.
11801185

1186+
.. seealso:: :ref:`pdalheightabovegroundbynearestneighbor`
1187+
11811188
Parameters
11821189
..........
11831190

0 commit comments

Comments
 (0)