vyperdatum.drivers.pdal_based
=============================

.. py:module:: vyperdatum.drivers.pdal_based


Attributes
----------

.. autoapisummary::

   vyperdatum.drivers.pdal_based.logger
   vyperdatum.drivers.pdal_based.fname


Classes
-------

.. autoapisummary::

   vyperdatum.drivers.pdal_based.PDAL


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

.. py:data:: logger

.. py:class:: PDAL(input_file: str, output_file: str, invalid_error: bool = True)

   Bases: :py:obj:`vyperdatum.drivers.base.Driver`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:attribute:: input_file


   .. py:attribute:: output_file


   .. py:method:: info(fname: str, args: Optional[list[str]] = None) -> tuple[Optional[dict], Optional[str]]

      Spawn a new process to run `pdal info` and capture its output.

      :param fname: Path to the input file.
      :type fname: str
      :param args: Optional pdal info arguments.
      :type args: Optional[list[str]]

      :returns: **stdout** -- standard output and error.
      :rtype: Optional[dict], std_err: Optional[str]



   .. py:method:: exec_pipeline(pipe_string: str)

      Execute a general pdal pipeline.

      :param pipe_string: PDAL's pipeline json object in string format.
      :type pipe_string: str



   .. py:method:: fetch_entwine(bounds: Optional[list[float]], resolution: Optional[int], output_format: str = 'writers.las') -> bool

      Download a subset of Etwine resource defined by `bounds: [x_min, x_max, y_min, y_max]`.
      The subset data is converted into the `output_format` which is a
      PDAL type.

      :param bounds: Bounding box that delimits the remote Etwine resource to be downloaded.
                     It should be a list of float values in this order: [x_min, x_max, y_min, y_max].
      :type bounds: Optional[list[float]]
      :param output_format: PDAL writers type; defaults to 'writers.las'.
                            See more https://pdal.io/en/2.8.1/stages/writers.html.
      :type output_format: str, default 'writers.las'

      :returns: True if download succeed, otherwise False.
      :rtype: bool



   .. py:method:: wkt(fname: str) -> str

      Return the WKT associated with the input file `fname`.

      :param fname: Path to the input file.
      :type fname: str

      :raises ValueError: When `pdal info --metadata <fname>` fails.

      :rtype: str



   .. py:property:: is_valid


   .. py:method:: transform(transformer_instance, vdatum_check: bool) -> None

      Create a PDAL pipeline to apply CRS transformation on the input data
      according to the `transformer_instance`.

      :param transformer_instance: Instance of the transformer class.
      :type transformer_instance: vyperdatum.transformer.Transform

      :rtype: None



.. py:data:: fname
   :value: 'C:\\Users\\mohammad.ashkezari\\Documents\\projects\\vyperdatum\\untrack\\data\\point\\laz\\ma202...