diff options
Diffstat (limited to 'src/python/doc/point_cloud.rst')
| -rw-r--r-- | src/python/doc/point_cloud.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/src/python/doc/point_cloud.rst b/src/python/doc/point_cloud.rst new file mode 100644 index 00000000..473b303f --- /dev/null +++ b/src/python/doc/point_cloud.rst @@ -0,0 +1,52 @@ +:orphan: + +.. To get rid of WARNING: document isn't included in any toctree + +============================ +Point cloud utilities manual +============================ + +File Readers +------------ + +.. autofunction:: gudhi.read_points_from_off_file + +.. autofunction:: gudhi.read_lower_triangular_matrix_from_csv_file + +File Writers +------------ + +.. autofunction:: gudhi.write_points_to_off_file + +Subsampling +----------- + +:Requires: `Eigen <installation.html#eigen>`_ :math:`\geq` 3.1.0 and `CGAL <installation.html#cgal>`_ :math:`\geq` 4.11.0 + +.. automodule:: gudhi.subsampling + :members: + :special-members: + :show-inheritance: + +Time Delay Embedding +-------------------- + +.. autoclass:: gudhi.point_cloud.timedelay.TimeDelayEmbedding + :members: + :special-members: __call__ + +K nearest neighbors +------------------- + +.. automodule:: gudhi.point_cloud.knn + :members: + :undoc-members: + :special-members: __init__ + +Distance to measure +------------------- + +.. automodule:: gudhi.point_cloud.dtm + :members: + :undoc-members: + :special-members: __init__ |