From 9f9f4452ce89aa3f9e1372555908356b0b288313 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Thu, 16 Jan 2025 15:28:22 +0100 Subject: [PATCH] chore(docs): improve --- differt/src/differt/geometry/_paths.py | 5 +++++ differt/src/differt/scene/_triangle_scene.py | 8 ++++++++ 2 files changed, 13 insertions(+) diff --git a/differt/src/differt/geometry/_paths.py b/differt/src/differt/geometry/_paths.py index 106b9fe3..03e96b65 100644 --- a/differt/src/differt/geometry/_paths.py +++ b/differt/src/differt/geometry/_paths.py @@ -202,6 +202,11 @@ def mask_duplicate_objects(self, axis: int = -1) -> Self: Args: axis: The batch axis along which the unique values are computed. + It defaults to the last axis, which is the axis where + different path candidates are stored when generating + paths with + :meth:`TriangleScene.compute_paths`. + Returns: A new paths instance with masked duplicate objects. diff --git a/differt/src/differt/scene/_triangle_scene.py b/differt/src/differt/scene/_triangle_scene.py index 74a16604..c1467b52 100644 --- a/differt/src/differt/scene/_triangle_scene.py +++ b/differt/src/differt/scene/_triangle_scene.py @@ -863,6 +863,14 @@ def compute_paths( # noqa: C901 The paths, as class wrapping path vertices, object indices, and a masked identify valid paths. + The returned paths have the following batch dimensions: + + * ``[*transmitters_batch *receivers_batch num_path_candidates]``, + * ``[*transmitters_batch *receivers_batch chunk_size]``, + * or ``[*transmitters_batch *receivers_batch num_rays]``, + + depending on the method used. + Raises: ValueError: If neither ``order`` nor ``path_candidates`` has been provided, or if both have been provided simultaneously.