geo3d.rasters.generator
=======================

.. py:module:: geo3d.rasters.generator


Classes
-------

.. autoapisummary::

   geo3d.rasters.generator.RasterGenerator


Module Contents
---------------

.. py:class:: RasterGenerator(color: bool = True)

   Main public API for raster generation.


   .. py:attribute:: _pipeline_builder


   .. py:attribute:: color
      :value: True



   .. py:method:: generate(reader: str, filename: str, center: Tuple[float, float], output_png: str, output_tif: str | None = None, noise_outlier: bool = False, above_ground_filter: bool = False, height_threshold: float = 4.0, ept_resolution: float | None = None, ept_token: str | None = None, raster_resolution: float = 0.06, raster_side: int = 35, raster_window_size: float = 2.0, dry_run: bool = False) -> altametris.geo3d.rasters.types.GeoTransform | altametris.geo3d.core.pipeline.Pipeline

      Generate a raster in PNG format from a point cloud.

      :param reader: The type of point cloud reader. 'las' or 'ept'.
      :type reader: str
      :param filename: The path to the input point cloud.
      :type filename: str
      :param center: The center point of the raster in absolute values (X, Y).
      :type center: Tuple[float, float]
      :param output_png: The path to the output PNG file.
      :type output_png: str
      :param output_tif: The path to the TIF raster if not None. Defaults to None.
      :type output_tif: str
      :param noise_outlier: Remove noise from point cloud. Defaults to True.
      :type noise_outlier: bool, optional
      :param above_ground_filter: Filter points above ground using a height threshold. Defaults to True.
      :type above_ground_filter: bool, optional
      :param height_threshold: The height threshold to filter points above ground. Defaults to 4.0.
      :type height_threshold: float, optional
      :param ept_resolution: The EPT input resolution. Defaults to None.
      :type ept_resolution: float | None, optional
      :param ept_token: The EPT token. Defaults to None.
      :type ept_token: str | None, optional
      :param raster_resolution: Raster cell resolution. Defaults to 0.06.
      :type raster_resolution: float, optional
      :param raster_side: The raster side in meters. Defaults to 35.
      :type raster_side: int, optional
      :param raster_window_size: Raster window size. Defaults to 2.0.
      :type raster_window_size: float, optional
      :param dry_run: Return the PDAL pipeline but don't run it. Defaults to False.
      :type dry_run: bool, optional

      :returns: A GeoTransform object containing georeference metadata or the pipeline if dry_run.
      :rtype: GeoTransform | Pipeline