pointtorch 0.1.0__tar.gz

pointtorch-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ai4trees
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pointtorch-0.1.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: pointtorch
+Version: 0.1.0
+Summary: A Python Package for Deep Learning on 3D Point Clouds Using PyTorch.
+Author-email: Josafat-Mattias Burmeister <burmeister@uni-potsdam.de>
+Maintainer-email: Josafat-Mattias Burmeister <burmeister@uni-potsdam.de>
+License: MIT License
+        
+        Copyright (c) 2024 ai4trees
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/ai4trees/pointtorch
+Project-URL: Documentation, https://ai4trees.github.io/pointtorch/
+Project-URL: Repository, https://github.com/ai4trees/pointtorch.git
+Project-URL: Issues, https://github.com/ai4trees/pointtorch/issues
+Project-URL: Changelog, https://ai4trees.github.io/pointtorch/changelog
+Keywords: point cloud,deep learning,pytorch
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: h5py<4.0.0,>=3.5.0
+Requires-Dist: laspy<3.0.0,>=2.0.0
+Requires-Dist: laszip<3.0.0,>=0.2.0
+Requires-Dist: numpy<3.0.0,>=1.21.0
+Requires-Dist: pandas<3.0.0,>=2.0.0
+Requires-Dist: tables<4.0.0,>=3.8.0
+Requires-Dist: torch<2.5.0,>=2.0.0
+Requires-Dist: torch-cluster<2.0.0,>=1.6.0
+Requires-Dist: torch-scatter<3.0.0,>=2.0.2
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: hypothesis; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pandas-stubs; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-copybutton; extra == "docs"
+Requires-Dist: sphinx-design; extra == "docs"
+Requires-Dist: sphinx-docsearch; extra == "docs"
+Requires-Dist: sphinxawesome-theme; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
+Requires-Dist: sphinxcontrib-jsmath; extra == "docs"
+Requires-Dist: sphinxcontrib-katex; extra == "docs"
+Requires-Dist: sphinxcontrib-napoleon; extra == "docs"
+Requires-Dist: sphinx_mdinclude; extra == "docs"
+
+<img src="https://github.com/ai4trees/pointtorch/blob/main/docs/assets/pointtorch-logo-color.png?raw=true" alt="pointtorch" width="328" height="93">
+
+## A Python Package for Deep Learning on 3D Point Clouds Using PyTorch.
+
+![pypi-image](https://badge.fury.io/py/pointtorch.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/ai4trees/pointtorch/actions/workflows/code-quality-main.yml/badge.svg)](https://github.com/ai4trees/pointtorch/actions/workflows/code-quality-main.yml)
+[![coverage](https://codecov.io/gh/ai4trees/pointtorch/branch/main/graph/badge.svg)](https://codecov.io/github/ai4trees/pointtorch?branch=main)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pointtorch)
+
+### Package Documentation
+
+The documentation of our package is available [here](https://ai4trees.github.io/pointtorch/stable).
+
+### Project Setup
+
+The setup of our package is described in the [documentation](https://ai4trees.github.io/pointtorch/stable#get-started).

pointtorch-0.1.0/README.md

@@ -0,0 +1,17 @@
+<img src="https://github.com/ai4trees/pointtorch/blob/main/docs/assets/pointtorch-logo-color.png?raw=true" alt="pointtorch" width="328" height="93">
+
+## A Python Package for Deep Learning on 3D Point Clouds Using PyTorch.
+
+![pypi-image](https://badge.fury.io/py/pointtorch.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/ai4trees/pointtorch/actions/workflows/code-quality-main.yml/badge.svg)](https://github.com/ai4trees/pointtorch/actions/workflows/code-quality-main.yml)
+[![coverage](https://codecov.io/gh/ai4trees/pointtorch/branch/main/graph/badge.svg)](https://codecov.io/github/ai4trees/pointtorch?branch=main)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pointtorch)
+
+### Package Documentation
+
+The documentation of our package is available [here](https://ai4trees.github.io/pointtorch/stable).
+
+### Project Setup
+
+The setup of our package is described in the [documentation](https://ai4trees.github.io/pointtorch/stable#get-started).

pointtorch-0.1.0/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = ["setuptools >=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pointtorch"
+version = "0.1.0"
+authors = [
+    {name = "Josafat-Mattias Burmeister", email = "burmeister@uni-potsdam.de"},
+]
+maintainers = [
+    {name = "Josafat-Mattias Burmeister", email = "burmeister@uni-potsdam.de"},
+]
+description = "A Python Package for Deep Learning on 3D Point Clouds Using PyTorch."
+readme = "README.md"
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+keywords = ["point cloud", "deep learning", "pytorch"]
+requires-python = ">=3.9"
+dependencies = [
+    "h5py>=3.5.0, <4.0.0",
+    "laspy>=2.0.0, <3.0.0",
+    "laszip>=0.2.0, <3.0.0",
+    "numpy>=1.21.0, <3.0.0",
+    "pandas>=2.0.0, <3.0.0",
+    "tables>=3.8.0, <4.0.0",
+    "torch>=2.0.0, <2.5.0",
+    "torch-cluster>=1.6.0, <2.0.0",
+    "torch-scatter>=2.0.2, <3.0.0"
+]
+[project.optional-dependencies]
+dev = [
+    "black",
+    "hypothesis",
+    "mypy",
+    "pandas-stubs",
+    "pylint",
+    "pytest",
+    "pytest-cov",
+]
+docs = [
+    "sphinx",
+    "sphinx-copybutton",
+    "sphinx-design",
+    "sphinx-docsearch",
+    "sphinxawesome-theme",
+    "sphinx-sitemap",
+    "sphinxcontrib-jsmath",
+    "sphinxcontrib-katex",
+    "sphinxcontrib-napoleon",
+    "sphinx_mdinclude",
+]
+
+[project.urls]
+Homepage = "https://github.com/ai4trees/pointtorch"
+Documentation = "https://ai4trees.github.io/pointtorch/"
+Repository = "https://github.com/ai4trees/pointtorch.git"
+Issues = "https://github.com/ai4trees/pointtorch/issues"
+Changelog = "https://ai4trees.github.io/pointtorch/changelog"
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version"
+]
+branch = "main"
+changelog_file = "CHANGELOG.md"
+build_command = "python -m build"
+
+[tool.setuptools.package-data]
+pointtorch = ["*.typed"]

pointtorch-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pointtorch-0.1.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

pointtorch-0.1.0/src/pointtorch/__init__.py

@@ -0,0 +1,3 @@
+""" Classes and methods that are available in the top-level namespace. """
+
+from pointtorch.core import *

pointtorch-0.1.0/src/pointtorch/config/__init__.py

@@ -0,0 +1,5 @@
+""" Utilities for configuring the package setup. """
+
+from ._optional_dependencies import *
+
+__all__ = [name for name in globals().keys() if not name.startswith("_")]

pointtorch-0.1.0/src/pointtorch/config/_optional_dependencies.py

@@ -0,0 +1,35 @@
+""" Utilities for configuring the package setup. """
+
+__all__ = ["open3d_is_available", "pytorch3d_is_available"]
+
+
+def open3d_is_available():
+    """
+    Returns: `True` if Open3D is installed and `False` otherwise.
+    """
+
+    open3d_available = False
+    try:
+        from open3d.ml import torch as _  # pylint: disable=import-outside-toplevel
+
+        open3d_available = True
+    except (ModuleNotFoundError, TypeError, Exception):  # pylint: disable=broad-exception-caught
+        pass
+
+    return open3d_available
+
+
+def pytorch3d_is_available() -> bool:
+    """
+    Returns: `True` if PyTorch3D is installed and `False` otherwise.
+    """
+
+    pytorch3d_available = False
+    try:
+        import pytorch3d as _  # pylint: disable=import-outside-toplevel
+
+        pytorch3d_available = True
+    except (ModuleNotFoundError, TypeError):
+        pass
+
+    return pytorch3d_available

pointtorch-0.1.0/src/pointtorch/core/__init__.py

@@ -0,0 +1,6 @@
+""" Core data structures for point cloud processing. """
+
+from ._point_cloud import *
+from ._read import *
+
+__all__ = [name for name in globals().keys() if not name.startswith("_")]

pointtorch-0.1.0/src/pointtorch/core/_point_cloud.py

@@ -0,0 +1,149 @@
+""" Point cloud object. """
+
+__all__ = ["PointCloud", "PointCloudSeries"]
+
+from pathlib import Path
+from typing import Dict, Hashable, Iterable, List, Optional, Union
+
+import numpy as np
+import numpy.typing as npt
+import pandas as pd
+
+from pointtorch.io import PointCloudIoData, PointCloudWriter
+
+
+class PointCloud(pd.DataFrame):
+    """Point cloud object. Subclass of
+    `pd.DataFrame <https://pd.pydata.org/docs/reference/api/pd.DataFrame.html>`_
+
+    Args:
+        identifier: Point cloud identifier. Defaults to `None`.
+        x_max_resolution: Maximum resolution of the point cloud's x-coordinates in meter. Defaults to `None`.
+        y_max_resolution: Maximum resolution of the point cloud's y-coordinates in meter. Defaults to `None`.
+        z_max_resolution: Maximum resolution of the point cloud's z-coordinates in meter. Defaults to `None`.
+
+    For a documentation of other parameters, see the documentation of \
+   `pd.DataFrame <https://pd.pydata.org/docs/reference/api/pd.DataFrame.html>`_.
+
+    Attributes:
+        identifier: Point cloud identifier.
+        x_max_resolution: Maximum resolution of the point cloud's x-coordinates in meter.
+        y_max_resolution: Maximum resolution of the point cloud's y-coordinates in meter.
+        z_max_resolution: Maximum resolution of the point cloud's z-coordinates in meter.
+    """
+
+    _metadata = ["identifier", "x_max_resolution", "y_max_resolution", "z_max_resolution"]
+
+    def __init__(  # pylint: disable=too-many-positional-arguments
+        self,
+        data: Union[npt.ArrayLike, Iterable, Dict, pd.DataFrame],
+        index: Optional[Union[pd.Index, npt.NDArray[np.int64]]] = None,
+        columns: Optional[Union[pd.Index, npt.ArrayLike, List[str]]] = None,
+        dtype: Optional[np.dtype] = None,
+        copy: Optional[bool] = True,
+        identifier: Optional[str] = None,
+        x_max_resolution: Optional[float] = None,
+        y_max_resolution: Optional[float] = None,
+        z_max_resolution: Optional[float] = None,
+    ) -> None:
+        super().__init__(data=data, index=index, columns=columns, dtype=dtype, copy=copy)  # type: ignore[call-arg]
+        self.identifier = identifier
+        self.x_max_resolution = x_max_resolution
+        self.y_max_resolution = y_max_resolution
+        self.z_max_resolution = z_max_resolution
+
+    @property
+    def _constructor(self):
+        return PointCloud
+
+    @property
+    def _constructor_sliced(self):
+        return PointCloudSeries
+
+    def xyz(self) -> npt.NDArray[np.float64]:
+        """
+        Returns:
+            x, y, and z coordinates of the points in the point cloud.
+
+        Raises:
+            RuntimeError: if "x", "y", or "z" are not in `self.columns`.
+        """
+
+        if "x" not in self.columns or "y" not in self.columns or "z" not in self.columns:
+            raise RuntimeError("The point cloud does not contain xyz coordinates.")
+
+        return self[["x", "y", "z"]].astype(np.float64).to_numpy()
+
+    def to(self, file_path: Union[str, Path], columns: Optional[List[str]] = None) -> None:
+        """
+        Writes the point cloud to a file.
+
+        Args:
+            file_path: Path of the output file.
+            columns: Point cloud columns to be written. The x, y, and z columns are always written.
+
+        Raises:
+            ValueError: If the point cloud format is not supported by the writer or if `columns` contains a column name
+                that is not existing in the point cloud.
+        """
+
+        writer = PointCloudWriter()
+        point_cloud_data = PointCloudIoData(
+            self,
+            identifier=self.identifier,
+            x_max_resolution=self.x_max_resolution,
+            y_max_resolution=self.y_max_resolution,
+            z_max_resolution=self.z_max_resolution,
+        )
+        writer.write(point_cloud_data, file_path, columns=columns)
+
+
+class PointCloudSeries(pd.Series):
+    """
+    A data series that represents a point cloud column. Subclass of
+    `pd.Series <https://pd.pydata.org/pandas-docs/stable/reference/api/pd.Series.html>`_.
+
+    Args:
+        identifier: Point cloud identifier. Defaults to `None`.
+        x_max_resolution: Maximum resolution of the point cloud's x-coordinates in meter. Defaults to `None`.
+        y_max_resolution: Maximum resolution of the point cloud's y-coordinates in meter. Defaults to `None`.
+        z_max_resolution: Maximum resolution of the point cloud's z-coordinates in meter. Defaults to `None`.
+
+    For a documentation of other parameters, see the documentation of \
+        `pd.Series <https://pd.pydata.org/pandas-docs/stable/reference/api/pd.Series.html>`_.
+
+
+    Attributes:
+        identifier: Point cloud identifier.
+        x_max_resolution: Maximum resolution of the point cloud's x-coordinates in meter.
+        y_max_resolution: Maximum resolution of the point cloud's y-coordinates in meter.
+        z_max_resolution: Maximum resolution of the point cloud's z-coordinates in meter.
+    """
+
+    _metadata = ["identifier", "x_max_resolution", "y_max_resolution", "z_max_resolution"]
+
+    def __init__(  # pylint: disable=too-many-positional-arguments
+        self,
+        data: Optional[Union[npt.ArrayLike, Iterable, Dict, int, float, str]] = None,
+        index: Optional[Union[pd.Index, npt.NDArray[np.int64]]] = None,
+        dtype: Optional[Union[str, np.dtype, pd.api.extensions.ExtensionDtype]] = None,
+        name: Optional[Hashable] = None,
+        copy: Optional[bool] = True,
+        identifier: Optional[str] = None,
+        x_max_resolution: Optional[float] = None,
+        y_max_resolution: Optional[float] = None,
+        z_max_resolution: Optional[float] = None,
+    ) -> None:
+        super().__init__(data=data, index=index, dtype=dtype, name=name, copy=copy)  # type: ignore[call-arg]
+        self.identifier = identifier
+        self.x_max_resolution = x_max_resolution
+        self.y_max_resolution = y_max_resolution
+        self.z_max_resolution = z_max_resolution
+
+    @property
+    def _constructor(self):
+        return PointCloudSeries
+
+    @property
+    def _constructor_expanddim(self):
+        return PointCloud

pointtorch-0.1.0/src/pointtorch/core/_read.py

@@ -0,0 +1,35 @@
+""" Method for reading point cloud files. """
+
+import pathlib
+from typing import List, Optional, Union
+
+from pointtorch.core._point_cloud import PointCloud
+from pointtorch.io import PointCloudReader
+
+
+def read(file_path: Union[str, pathlib.Path], columns: Optional[List[str]] = None) -> PointCloud:
+    """
+    Method for reading point cloud files.
+
+    Args:
+        file_path: Path of the point cloud file to be read.
+        columns: Name of the point cloud columns to be read. The x, y, and z columns are always read.
+
+    Returns:
+        Point cloud object.
+
+    Raises:
+        ValueError: If the point cloud format is not supported by the reader.
+    """
+
+    reader = PointCloudReader()
+    point_cloud_data = reader.read(file_path, columns=columns)
+    point_cloud = PointCloud(
+        point_cloud_data.data,
+        identifier=point_cloud_data.identifier,
+        x_max_resolution=point_cloud_data.x_max_resolution,
+        y_max_resolution=point_cloud_data.y_max_resolution,
+        z_max_resolution=point_cloud_data.z_max_resolution,
+    )
+
+    return point_cloud

pointtorch-0.1.0/src/pointtorch/io/__init__.py

@@ -0,0 +1,13 @@
+""" Tools for reading and writing point cloud files. """
+
+from ._csv_reader import *
+from ._csv_writer import *
+from ._hdf_reader import *
+from ._hdf_writer import *
+from ._las_reader import *
+from ._las_writer import *
+from ._point_cloud_io_data import *
+from ._point_cloud_reader import *
+from ._point_cloud_writer import *
+
+__all__ = [name for name in globals().keys() if not name.startswith("_")]

pointtorch-0.1.0/src/pointtorch/io/_base_point_cloud_reader.py

@@ -0,0 +1,104 @@
+""" Abstract base class for implementing point cloud file readers. """
+
+__all__ = ["BasePointCloudReader"]
+
+import abc
+import pathlib
+from typing import List, Optional, Tuple, Union
+
+import pandas as pd
+
+from ._point_cloud_io_data import PointCloudIoData
+
+
+class BasePointCloudReader(abc.ABC):
+    """Abstract base class for implementing point cloud file readers."""
+
+    @abc.abstractmethod
+    def supported_file_formats(self) -> List[str]:
+        """
+        Returns:
+            File formats supported by the point cloud file reader.
+        """
+
+    def read(self, file_path: Union[str, pathlib.Path], columns: Optional[List[str]] = None) -> PointCloudIoData:
+        """
+        Reads a point cloud file.
+
+        Args:
+            file_path: Path of the point cloud file to be read.
+            columns: Name of the point cloud columns to be read. The x, y, and z columns are always read.
+
+        Returns:
+            Point cloud object.
+
+        Raises:
+            ValueError: If the point cloud format is not supported by the reader.
+        """
+
+        if isinstance(file_path, str):
+            file_path = pathlib.Path(file_path)
+
+        file_format = file_path.suffix.lstrip(".")
+        if file_format not in self.supported_file_formats():
+            raise ValueError(f"The {file_format} format is not supported by the point cloud reader.")
+
+        identifier = self._read_identifier(file_path)
+        file_id = file_path.stem if identifier is None else identifier
+
+        if columns is not None:
+            columns = columns.copy()
+
+            # The x, y, z coordinates are always loaded.
+            for idx, coord in enumerate(["x", "y", "z"]):
+                if coord not in columns:
+                    columns.insert(idx, coord)
+
+        point_cloud_df = self._read_points(file_path, columns=columns)
+        (x_max_resolution, y_max_resolution, z_max_resolution) = self._read_max_resolutions(file_path)
+
+        return PointCloudIoData(
+            point_cloud_df,
+            identifier=file_id,
+            x_max_resolution=x_max_resolution,
+            y_max_resolution=y_max_resolution,
+            z_max_resolution=z_max_resolution,
+        )
+
+    @abc.abstractmethod
+    def _read_points(self, file_path: pathlib.Path, columns: Optional[List[str]] = None) -> pd.DataFrame:
+        """
+        Reads point data from a point cloud file. This method has to be overriden by child classes.
+
+        Args:
+            file_path: Path of the point cloud file to be read.
+            columns: Name of the point cloud columns to be read.
+
+        Returns:
+            Point cloud data.
+        """
+
+    @staticmethod
+    @abc.abstractmethod
+    def _read_max_resolutions(file_path: pathlib.Path) -> Tuple[Optional[float], Optional[float], Optional[float]]:
+        """
+        Reads the maximum resolution for each coordinate dimension from the point cloud file.
+
+        Args:
+            file_path: Path of the point cloud file to be read.
+
+        Returns:
+            Maximum resolution of the x-, y-, and z-coordinates of the point cloud.
+        """
+
+    @staticmethod
+    def _read_identifier(file_path: pathlib.Path) -> Optional[str]:  # pylint: disable=unused-argument
+        """
+        Reads the point cloud identifier from the point cloud file. Storing a file identifier is not supported by all
+        file formats and :code:`None` may be returned when no file identifier is stored in a file.
+
+        Returns:
+            Point cloud identifier.
+        """
+
+        return None