ign-pdal-tools 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

{ign_pdal_tools-1.6.0.dist-info → ign_pdal_tools-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ign-pdal-tools
-Version: 1.6.0
+Version: 1.7.0
 Summary: Library for common LAS files manipulation with PDAL
 Author-email: Guillaume Liegard <guillaume.liegard@ign.fr>
 Description-Content-Type: text/markdown

{ign_pdal_tools-1.6.0.dist-info → ign_pdal_tools-1.7.0.dist-info}/RECORD

@@ -1,14 +1,15 @@
-pdaltools/_version.py,sha256=Xq8G0zFAUQ7LL7Y4z3YbruoLpmF2hoaWnL6BPpSAP6M,74
+pdaltools/_version.py,sha256=9fOW18Rr_2UaEKhSgKdd6D5gPk-Z2COb77UpIg5Oq20,74
 pdaltools/color.py,sha256=7U-SThIKqrfE1xXXnFqpbIhmZEqna29nRiyLW8l8Y1c,8075
-pdaltools/las_add_buffer.py,sha256=_syALdaf6ks5KSINlfkALwGUrPOHLhK8rGlYVwDamzc,5653
+pdaltools/las_add_buffer.py,sha256=sBpTywlfsHHS8KuCUa-eydB2hylshEvjrMQt5TrqXb8,11275
 pdaltools/las_clip.py,sha256=GvEOYu8RXV68e35kU8i42GwSkbo4P9TvmS6rkrdPmFM,1034
 pdaltools/las_info.py,sha256=RE-UBdEUXqKvSrMV3mOlvE_16mhum7bw-p-ERu5bGOc,6979
 pdaltools/las_merge.py,sha256=tcFVueV9X9nNEaoAl5zCduY5DETlBg63MAgP2SuKiNo,4121
+pdaltools/las_remove_dimensions.py,sha256=0zhv9LBvlL69TLmXTJlRQcUBOaBmCRZEQU2Qadx27aM,1805
 pdaltools/replace_attribute_in_las.py,sha256=po1F-fi8s7iilqKWaryW4JRbsmdMOUe0yGvG3AEKxtk,4771
 pdaltools/standardize_format.py,sha256=KM_jC_aC9yLD5rrSUGgTwfyakbh86FXsAI-y8gokF4M,2883
 pdaltools/unlock_file.py,sha256=pIThdWMNkTph0xgJVVRaM1o9aUMQhM6804PscScB3JI,1963
-ign_pdal_tools-1.6.0.dist-info/LICENSE.md,sha256=iVzCFZTUXeiqP8bP474iuWZiWO_kDCD4SPh1Wiw125Y,1120
-ign_pdal_tools-1.6.0.dist-info/METADATA,sha256=3BZwbcQ_mDIr1XzK5JZMrjIQmRcN__FW62GMp9FKrIQ,4825
-ign_pdal_tools-1.6.0.dist-info/WHEEL,sha256=cpQTJ5IWu9CdaPViMhC9YzF8gZuS5-vlfoFihTBC86A,91
-ign_pdal_tools-1.6.0.dist-info/top_level.txt,sha256=KvGW0ZzqQbhCKzB5_Tp_buWMZyIgiO2M2krWF_ecOZc,10
-ign_pdal_tools-1.6.0.dist-info/RECORD,,
+ign_pdal_tools-1.7.0.dist-info/LICENSE.md,sha256=iVzCFZTUXeiqP8bP474iuWZiWO_kDCD4SPh1Wiw125Y,1120
+ign_pdal_tools-1.7.0.dist-info/METADATA,sha256=-dCrIES5-avXftir_W05j3rnc5w0PO7trYeyB7pLIY4,4825
+ign_pdal_tools-1.7.0.dist-info/WHEEL,sha256=Z4pYXqR_rTB7OWNDYFOm1qRk0RX6GFP2o8LgvP453Hk,91
+ign_pdal_tools-1.7.0.dist-info/top_level.txt,sha256=KvGW0ZzqQbhCKzB5_Tp_buWMZyIgiO2M2krWF_ecOZc,10
+ign_pdal_tools-1.7.0.dist-info/RECORD,,

{ign_pdal_tools-1.6.0.dist-info → ign_pdal_tools-1.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.1.0)
+Generator: setuptools (70.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pdaltools/_version.py

@@ -1,4 +1,4 @@
-__version__ = "1.6.0"
+__version__ = "1.7.0"
 
 
 if __name__ == "__main__":

pdaltools/las_add_buffer.py

@@ -1,7 +1,10 @@
 import argparse
 import logging
 import os
-from typing import List
+import tempfile
+from functools import wraps
+from pathlib import Path
+from typing import Callable, List
 
 import pdal
 
@@ -10,6 +13,9 @@ from pdaltools.las_info import (
     get_writer_parameters_from_reader_metadata,
 )
 from pdaltools.las_merge import create_list
+from pdaltools.las_remove_dimensions import remove_dimensions_from_las
+
+ORIGINAL_TILE_TAG = "is_in_original"
 
 
 def create_las_with_buffer(
@@ -20,19 +26,27 @@ def create_las_with_buffer(
     spatial_ref: str = "EPSG:2154",
     tile_width: int = 1000,
     tile_coord_scale: int = 1000,
+    tag_original_tile: bool = False,
 ):
     """Merge lidar tiles around the queried tile and crop them in order to add a buffer
     to the tile (usually 100m).
+
     Args:
-        input_dir (str): directory of pointclouds (where you look for neigbors)
-        tile_filename (str): full path to the queried LIDAR tile
-        output_filename (str) : full path to the saved cropped tile
-        buffer_width (int): width of the border to add to the tile (in pixels)
-        spatial_ref (str): Spatial reference to use to override the one from input las.
-        tile width (int): width of tiles in meters (usually 1000m)
-        tile_coord_scale (int) : scale used in the filename to describe coordinates in meters
-                (usually 1000m)
+        input_dir (str): directory of pointclouds (where you look for neighbors)
+        tile_filename (str):  full path to the queried LIDAR tile
+        output_filename (str): full path to the saved cropped tile
+        buffer_width (int, optional): width of the border to add to the tile (in meters).
+        Defaults to 100.
+        spatial_ref (_type_, optional): Spatial reference to use to override the one from input las.
+        Defaults to "EPSG:2154".
+        tile_width (int, optional): width of tiles in meters. Defaults to 1000.
+        tile_coord_scale (int, optional): scale used in the filename to describe coordinates
+        in meters. Defaults to 1000.
+        tag_original_tile (bool, optional): if true, add a new "is_in_original" dimension
+        to the output las, equal to 1 on points that belong to the original tile, 0 on points
+        that belong to the added buffer. Defaults to False.
     """
+
     bounds = get_buffered_bounds_from_filename(
         tile_filename, buffer_width=buffer_width, tile_width=tile_width, tile_coord_scale=tile_coord_scale
     )
@@ -46,6 +60,7 @@ def create_las_with_buffer(
         spatial_ref,
         tile_width=tile_width,
         tile_coord_scale=tile_coord_scale,
+        tag_original_tile=tag_original_tile,
     )
 
 
@@ -57,6 +72,7 @@ def las_merge_and_crop(
     spatial_ref: str = "EPSG:2154",
     tile_width=1000,
     tile_coord_scale=1000,
+    tag_original_tile: bool = False,
 ):
     """Merge and crop las in a single pipeline (for buffer addition)
 
@@ -65,29 +81,40 @@ def las_merge_and_crop(
     - For each file:
         - read it
         - crop it according to the bounds
+        - optionally add a dimension to differentiate points from the central pointscloud
+        from those added as a buffer
         - keep the crop in memory
         - delete the pipeline object to release the memory taken by the las reader
     - Merge the already cropped data
 
     Args:
-        input_dir (str): directory of pointclouds (where you look for neigbors)
+        input_dir (str): directory of pointclouds (where you look for neighbors)
         tile_filename (str): full path to the queried LIDAR tile
-        bounds : 2D bounding box to crop to : provided as ([xmin, xmax], [ymin, ymax])
-        output_filename (str) : full path to the saved cropped tile
-        spatial_ref (str): spatial reference for the writer
-        tile width (int): width of tiles in meters (usually 1000m)
-        tile_coord_scale (int) : scale used in the filename to describe coordinates in meters
-                (usually 1000m)
+        bounds (List): 2D bounding box to crop to : provided as ([xmin, xmax], [ymin, ymax])
+        output_filename (str): full path to the saved cropped tile
+        spatial_ref (str, optional): spatial reference for the writer. Defaults to "EPSG:2154".
+        tile_width (int, optional): width of tiles in meters (usually 1000m). Defaults to 1000.
+        tile_coord_scale (int, optional): scale used in the filename to describe coordinates in meters.
+        Defaults to 1000.
+        tag_original_tile (bool, optional):  if true, add a new "is_in_original" dimension
+        to the output las, equal to 1 on points that belong to the original tile, 0 on points
+        that belong to the added buffer. Defaults to False.
+    Raises:
+        ValueError: if the list of tiles to merge is empty
     """
+
     # List files to merge
     files_to_merge = create_list(input_dir, tile_filename, tile_width, tile_coord_scale)
-
+    central_file = files_to_merge[-1]
     if len(files_to_merge) > 0:
         # Read and crop each file
         crops = []
         for f in files_to_merge:
             pipeline = pdal.Pipeline()
             pipeline |= pdal.Reader.las(filename=f, override_srs=spatial_ref)
+            if tag_original_tile:
+                pipeline |= pdal.Filter.ferry(dimensions=f"=>{ORIGINAL_TILE_TAG}")
+                pipeline |= pdal.Filter.assign(value=f"{ORIGINAL_TILE_TAG}={int(f == central_file)}")
             pipeline |= pdal.Filter.crop(bounds=str(bounds))
             pipeline.execute()
             if len(pipeline.arrays[0]) == 0:
@@ -95,10 +122,9 @@ def las_merge_and_crop(
             else:
                 crops.append(pipeline.arrays[0])
 
-            # Retrieve metadata before the pipeline is deleted
-            # As the last file of files_to_merge is the central one, metadata will contain the info
-            # from the central file after the last iteration of the for loop
-            metadata = pipeline.metadata
+            if f == central_file:
+                # Retrieve metadata before the pipeline is deleted
+                metadata = pipeline.metadata
             del pipeline
 
         params = get_writer_parameters_from_reader_metadata(metadata, a_srs=spatial_ref)
@@ -116,6 +142,106 @@ def las_merge_and_crop(
     pass
 
 
+def remove_points_from_buffer(input_file: str, output_file: str):
+    """Remove the points that were added as a buffer to a las file using the "is_in_original"
+    dimension that has been added by create_las_with_buffer
+
+    Limitation: if any point has been added to the point cloud after adding the buffer, it
+    won't be preserved by this operation (only points from the original file are kept)
+
+    Args:
+        input_file (str): path to the input file containing the "is_in_original" dimension
+        output_file (str): path to the output_file
+    """
+    with tempfile.NamedTemporaryFile(suffix="_with_additional_dim.las") as tmp_las:
+        pipeline = pdal.Pipeline() | pdal.Reader.las(input_file)
+        pipeline |= pdal.Filter.range(limits=f"{ORIGINAL_TILE_TAG}[1:1]")
+        pipeline |= pdal.Writer.las(filename=tmp_las.name, forward="all", extra_dims="all")
+        pipeline.execute()
+
+        remove_dimensions_from_las(tmp_las.name, dimensions=[ORIGINAL_TILE_TAG], output_las=output_file)
+
+
+def run_on_buffered_las(
+    buffer_width: int, spatial_ref: str, tile_width: int = 1000, tile_coord_scale: int = 1000
+) -> Callable:
+    """Decorator to apply a function that takes a las/laz as input and returns a las/laz output
+    on an input with an additional buffer, then remove the buffer points from the output
+
+    The first argument of the decorated function must be an input path
+    The second argument of the decorated function must be an output path
+
+    The buffer is added by merging lidar tiles around the queried tile and crop them based
+    on their filenames.
+
+    Limitation: if any point has been added to the point cloud by the decorated function, it
+    won't be preserved by this operation (only points from the original file are kept)
+
+
+    Args:
+        buffer_width (int): width of the border to add to the tile (in meters)
+        spatial_ref (str): spatial reference for the writer. Example: "EPSG:2154".
+        tile_width (int, optional): width of tiles in meters (usually 1000m). Defaults to 1000.
+        tile_coord_scale (int, optional): scale used in the filename to describe coordinates in meters.
+        Defaults to 1000.
+
+    Raises:
+        FileNotFoundError: when the first argument of the decorated function is not an existing
+            file
+        FileNotFoundError:  when the second argument of the decorated function is not a path
+            with an existing parent folder
+
+    Returns:
+        Callable: decorated function
+    """
+    """Decorator to run a function that takes a las as input and returns a las output
+    on a las with an additional buffer, then remove the buffer points from the buffer points
+
+    """
+
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            input_file = args[0]
+            output_file = args[1]
+            if not Path(input_file).is_file():
+                raise FileNotFoundError(
+                    f"File {args[0]} not found. The first argument of a function decorated by "
+                    "'run_on_buffered_las' is expected to be the path to an existing input file."
+                )
+
+            if not Path(output_file).parent.is_dir():
+                raise FileNotFoundError(
+                    f"Parent folder for file {args[1]} not found. The second argument of a function "
+                    "decorated by 'run_on_buffered_las' is expected to be the path to an output "
+                    "file in an existing folder"
+                )
+
+            with (
+                tempfile.NamedTemporaryFile(suffix="_buffered_input.laz", dir=".") as buf_in,
+                tempfile.NamedTemporaryFile(suffix="_buffered_output.laz", dir=".") as buf_out,
+            ):
+                create_las_with_buffer(
+                    Path(input_file).parent,
+                    input_file,
+                    buf_in.name,
+                    buffer_width=buffer_width,
+                    spatial_ref=spatial_ref,
+                    tile_width=tile_width,
+                    tile_coord_scale=tile_coord_scale,
+                    tag_original_tile=True,
+                )
+                func(buf_in.name, buf_out.name, *args[2:], **kwargs)
+
+                remove_points_from_buffer(buf_out.name, output_file)
+
+            return
+
+        return wrapper
+
+    return decorator
+
+
 def parse_args():
     parser = argparse.ArgumentParser("Add a buffer to a las tile by stitching with its neighbors")
     parser.add_argument(

pdaltools/las_remove_dimensions.py

@@ -0,0 +1,58 @@
+import argparse
+import os
+
+import pdal
+from pdaltools.las_info import get_writer_parameters_from_reader_metadata
+
+def remove_dimensions_from_las(input_las: str, dimensions: [str], output_las: str):
+    """
+    export new las without some dimensions
+    """
+    pipeline = pdal.Pipeline() | pdal.Reader.las(input_las)
+    pipeline.execute()
+    points = pipeline.arrays[0]
+    input_dimensions = list(points.dtype.fields.keys())
+    output_dimensions = [dim for dim in input_dimensions if dim not in dimensions]
+    points_pruned = points[output_dimensions]
+    params = get_writer_parameters_from_reader_metadata(pipeline.metadata)
+    pipeline_end = pdal.Pipeline(arrays=[points_pruned])
+    pipeline_end |= pdal.Writer.las(output_las, forward="all", **params)
+    pipeline_end.execute()
+
+
+def parse_args():
+    parser = argparse.ArgumentParser("Remove dimensions from las")
+    parser.add_argument(
+        "--input_las",
+        "-i",
+        type=str,
+        required=True,
+        help="Path to the the las for which the dimensions will be removed",
+    )
+    parser.add_argument(
+        "--output_las",
+        "-o",
+        type=str,
+        required=False,
+        help="Path to the the output las ; if none, we replace the input las",
+    )
+    parser.add_argument(
+        "--dimensions",
+        "-d",
+        type=str,
+        required=True,
+        nargs="+",
+        help="The dimension we would like to remove from the point cloud file ; be aware to not remove mandatory "
+             "dimensions of las"
+    )
+
+    return parser.parse_args()
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    remove_dimensions_from_las(
+        input_las=args.input_las,
+        dimensions=args.dimensions,
+        output_las=args.input_las if args.output_las is None else args.output_las,
+    )