Usage
=====

The package was designed to be easily used through the experiments.

Here is an example of how you can import it

.. code-block:: python

    from altametris.geo3d.core.pipeline import Pipeline
    from altametris.geo3d.core import functional as fn

    # create a pipeline schema:
    # read las -> select the class 64 -> cluster
    schema = [fn.reader_las("filename.las"), fn.class_ranger(64, 64), fn.cluster()]
    pipeline = Pipeline(schema)

    # execute the pipeline
    _ = pipeline.execute()

    # get the metadata of the pipeline (statistics)
    metadata = pipeline.metadata()

    # get the output as a numpy structured array
    array = pipeline.array()

Notes
-----

See the folder `notebooks` for more examples.