Deploy to GitHub pages

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a564e7d5fc37885fd248d8bd3b9e8dd6
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/changelog.rst.txt

@@ -0,0 +1 @@
+.. include:: ../../../CHANGELOG.rst

_sources/commandline_interface.rst.txt

@@ -0,0 +1,41 @@
+pointcloudset CLI
+======================
+
+The best way to work with large ROS1 or ROS2 files is to convert the rosbag beforehand with
+the provided command line tool.
+
+It is also possible to convert whole or parts of ROS files to many poplar formats which
+are supported by pyntcloud:
+
+
+.asc / .pts / .txt / .csv / .xyz
+.las
+.npy / .npz
+.obj
+.off (with color support)
+.pcd
+.ply
+
+
+Example
+--------------------------
+
+An example to convert topic /os1_cloud_node/point within the test.bag rosbag to
+the converted directory.
+
+.. code-block:: console
+
+   pointcloudset convert -t /os1_cloud_node/points -d converted test.bag
+
+List all PointCloud2 topics in a ROS file.
+
+.. code-block:: console
+
+   pointcloudset topics test.bag
+
+
+.. click:: pointcloudset.io.dataset.commandline:typer_click_object
+   :prog: pointcloudset
+   :nested: full
+
+   pointcloudset -d converted -o csv .

_sources/description_python_api.rst.txt

@@ -0,0 +1,35 @@
+How to read the API documentation
+========================================
+
+A Dataset consists of multiple PointCloud objects which form the two main classes of the package.
+
+
+The main classes
+----------------------------------------
+
+
+**Dataset**: :class:`pointcloudset.dataset.Dataset` based on :class:`pointcloudset.dataset_core.DatasetCore`
+
+.. image:: images/Folie2.PNG
+    :width: 600
+
+
+**PointCloud**: :class:`pointcloudset.pointcloud.PointCloud` based on :class:`pointcloudset.pointcloud_core.PointCloudCore`
+
+.. image:: images/Folie3.PNG
+    :width: 300
+
+Modules
+----------------------------------------
+
+As a common user these Classes are enough to tackle most proplems. If you want to dive deeper or contribute to
+the package than you should have a look at the other modules.
+
+ Datasets and PointCloud use the functions of the following modules:
+    * :mod:`pointcloudset.diff`
+    * :mod:`pointcloudset.filter`
+    * :mod:`pointcloudset.geometry`
+    * :mod:`pointcloudset.io`
+    * :mod:`pointcloudset.plot`
+
+For a more detailed documentation see the section below.

_sources/getting_started_contribution.rst.txt

@@ -0,0 +1,10 @@
+Getting started
+===============================
+
+* Install VS Code
+* Install the remote development extension in VS code (ms-vscode-remote.vscode-remote-extensionpack)
+* Install and run docker desktop
+* Clone the repository (you can use VS code for that as well)
+* Open the folder in VS code
+* VS code asks to open the remote development environment - say yes
+* The docker image is download on the first start, so this may take a while

_sources/guidelines.rst.txt

@@ -0,0 +1,8 @@
+Guidelines
+================================
+
+* Use Google docstrings everywhere. The documentation in "doc" is generated with sphinx with $make doc
+* Write tests for every method/function which manipulates data.
+* Have a look at the Makefile and the available make commands.
+* Use typehints when declaring a function, class or method.
+* VS code settings in the dev container take care of linting with mypy, ruff and code formatting with black.

_sources/how_to_contribute.rst.txt

@@ -0,0 +1,7 @@
+How to Contribute
+=====================================
+
+* Add issues in GitHub
+* Generate a branch and implement new features
+* Write tests for the new features
+* Make a merge request in GitHub

_sources/index.rst.txt

@@ -0,0 +1,51 @@
+Welcome to pointcloudset's documentation!
+=========================================
+
+.. include:: ../../../README.rst
+   :start-after: inclusion-marker-do-not-remove
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Tutorial
+
+   tutorial_notebooks/usage
+   tutorial_notebooks/reading_las_pcd
+   tutorial_notebooks/Working_with_kitti_dataset
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Convert ROS 1 and ROS 2 files
+
+   commandline_interface
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contribute
+
+   how_to_contribute
+   getting_started_contribution
+   guidelines
+   support
+
+.. toctree::
+   :maxdepth: 5
+   :titlesonly:
+   :caption: Python API
+
+   description_python_api
+   python-api/pointcloudset
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Changelog
+
+   changelog
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

_sources/python-api/pointcloudset.dataset.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.dataset module
+============================
+
+.. automodule:: pointcloudset.dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.dataset_core.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.dataset\_core module
+==================================
+
+.. automodule:: pointcloudset.dataset_core
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.diff.nearest.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.diff.nearest module
+=================================
+
+.. automodule:: pointcloudset.diff.nearest
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.diff.origin.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.diff.origin module
+================================
+
+.. automodule:: pointcloudset.diff.origin
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.diff.plane.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.diff.plane module
+===============================
+
+.. automodule:: pointcloudset.diff.plane
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.diff.point.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.diff.point module
+===============================
+
+.. automodule:: pointcloudset.diff.point
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.diff.pointcloud.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.diff.pointcloud module
+====================================
+
+.. automodule:: pointcloudset.diff.pointcloud
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.diff.rst.txt

@@ -0,0 +1,19 @@
+pointcloudset.diff package
+==========================
+
+.. automodule:: pointcloudset.diff
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pointcloudset.diff.nearest
+   pointcloudset.diff.origin
+   pointcloudset.diff.plane
+   pointcloudset.diff.point
+   pointcloudset.diff.pointcloud

_sources/python-api/pointcloudset.filter.rst.txt

@@ -0,0 +1,15 @@
+pointcloudset.filter package
+============================
+
+.. automodule:: pointcloudset.filter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pointcloudset.filter.stat

_sources/python-api/pointcloudset.filter.stat.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.filter.stat module
+================================
+
+.. automodule:: pointcloudset.filter.stat
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.geometry.plane.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.geometry.plane module
+===================================
+
+.. automodule:: pointcloudset.geometry.plane
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.geometry.point.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.geometry.point module
+===================================
+
+.. automodule:: pointcloudset.geometry.point
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.geometry.rst.txt

@@ -0,0 +1,16 @@
+pointcloudset.geometry package
+==============================
+
+.. automodule:: pointcloudset.geometry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pointcloudset.geometry.plane
+   pointcloudset.geometry.point

_sources/python-api/pointcloudset.io.dataset.dir.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.dataset.dir module
+===================================
+
+.. automodule:: pointcloudset.io.dataset.dir
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.dataset.pointcloud.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.dataset.pointcloud module
+==========================================
+
+.. automodule:: pointcloudset.io.dataset.pointcloud
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.dataset.ros.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.dataset.ros module
+===================================
+
+.. automodule:: pointcloudset.io.dataset.ros
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.dataset.rst.txt

@@ -0,0 +1,17 @@
+pointcloudset.io.dataset package
+================================
+
+.. automodule:: pointcloudset.io.dataset
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pointcloudset.io.dataset.dir
+   pointcloudset.io.dataset.pointcloud
+   pointcloudset.io.dataset.ros

_sources/python-api/pointcloudset.io.pointcloud.csv.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.pointcloud.csv module
+======================================
+
+.. automodule:: pointcloudset.io.pointcloud.csv
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.pointcloud.open3d.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.pointcloud.open3d module
+=========================================
+
+.. automodule:: pointcloudset.io.pointcloud.open3d
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.pointcloud.pandas.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.pointcloud.pandas module
+=========================================
+
+.. automodule:: pointcloudset.io.pointcloud.pandas
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.pointcloud.pyntcloud.rst.txt

@@ -0,0 +1,7 @@
+pointcloudset.io.pointcloud.pyntcloud module
+============================================
+
+.. automodule:: pointcloudset.io.pointcloud.pyntcloud
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/python-api/pointcloudset.io.pointcloud.rst.txt

@@ -0,0 +1,18 @@
+pointcloudset.io.pointcloud package
+===================================
+
+.. automodule:: pointcloudset.io.pointcloud
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   pointcloudset.io.pointcloud.csv
+   pointcloudset.io.pointcloud.open3d
+   pointcloudset.io.pointcloud.pandas
+   pointcloudset.io.pointcloud.pyntcloud