Allow to globally configure the default number of point displayed

PiperOrigin-RevId: 481617719

Author: Conchylicultor

CHANGELOG.md

@@ -23,6 +23,8 @@ Changelog follow https://keepachangelog.com/ format.
         `points.replace_fig_config(num_samples=10_000)`.
     *   Object names displayed in plotly are customizable using
         `points.replace_fig_config(name='My point cloud')`.
+    *   `v3d.fig_config.num_sample_xyz = 123` to overwrite the default number of
+        sampled rays, points,... (`None` for no subsampling)
 *   `DataclassArray.__dca_params__` can be set to `v3d.DataclassParams` to
     configure the dataclass options.
 

visu3d/dc_arrays/point.py

@@ -25,6 +25,7 @@
 from visu3d import array_dataclass
 from visu3d import plotly
 from visu3d.dc_arrays import transformation
+from visu3d.plotly import fig_config_utils
 from visu3d.utils import np_utils
 from visu3d.utils.lazy_imports import plotly_base
 
@@ -47,7 +48,11 @@ class Point3d(array_dataclass.DataclassArray):
 
   # Overwrite `v3d.DataclassArray.fig_config`.
   fig_config: plotly.TraceConfig = dataclasses.field(
-      default=plotly.TraceConfig(num_samples=10_000),
+      default=plotly.TraceConfig(
+          num_samples=fig_config_utils.LazyValue(
+              lambda: fig_config_utils.fig_config.num_samples_point3d
+          )
+      ),
       repr=False,
       init=False,
   )
@@ -105,7 +110,11 @@ class Point2d(array_dataclass.DataclassArray):
 
   # Overwrite `v3d.DataclassArray.fig_config`.
   fig_config: plotly.TraceConfig = dataclasses.field(
-      default=plotly.TraceConfig(num_samples=50_000),
+      default=plotly.TraceConfig(
+          num_samples=fig_config_utils.LazyValue(
+              lambda: fig_config_utils.fig_config.num_samples_point2d
+          )
+      ),
       repr=False,
       init=False,
   )

visu3d/dc_arrays/ray.py

@@ -25,6 +25,7 @@
 from visu3d import array_dataclass
 from visu3d import plotly
 from visu3d.dc_arrays import transformation
+from visu3d.plotly import fig_config_utils
 from visu3d.utils import np_utils
 from visu3d.utils.lazy_imports import plotly_base
 
@@ -50,7 +51,11 @@ class Ray(array_dataclass.DataclassArray):
 
   # Overwrite `v3d.DataclassArray.fig_config`.
   fig_config: plotly.TraceConfig = dataclasses.field(
-      default=plotly.TraceConfig(num_samples=500),
+      default=plotly.TraceConfig(
+          num_samples=fig_config_utils.LazyValue(
+              lambda: fig_config_utils.fig_config.num_samples_ray
+          )
+      ),
       repr=False,
       init=False,
   )

visu3d/plotly/fig_config_utils.py

@@ -17,13 +17,27 @@
 from __future__ import annotations
 
 import dataclasses
-from typing import Optional, TypeVar
+from typing import Callable, Generic, Optional, TypeVar, Union
 
 from etils import edc
 
 _T = TypeVar('_T')
 
 
+class LazyValue(Generic[_T]):
+  """Lazyly compute a value."""
+
+  def __init__(self, value_fn: Callable[[], _T]):
+    self._value_fn = value_fn
+
+  @property
+  def value(self) -> _T:
+    return self._value_fn()
+
+  def __repr__(self) -> str:
+    return f'{type(self).__name__}({self.value})'
+
+
 @edc.dataclass
 @dataclasses.dataclass
 class FigConfig:
@@ -33,14 +47,25 @@ class FigConfig:
 
   ```python
   v3d.fig_config.show_zero = False
+  v3dfig_config..num_samples_point3d = None  # Do not subsample point display
   ```
 
   Attributes:
     show_zero: Whether to show the `(0, 0, 0)` origin, otherwise the plot x, y,
       z axis adapt to the data.
+    num_samples_point3d: Max number of `v3d.Point3d` displayed by default (
+      `None` for all)
+    num_samples_point2d: Max number of `v3d.Point2d` displayed by default (
+      `None` for all)
+    num_samples_ray: Max number of `v3d.Ray` displayed by default (`None` for
+      all)
   """
 
   show_zero: bool = True
+  # TODO(epot): Currently this does not support `v3d.make_fig(num_samples_ray=)`
+  num_samples_point3d: Optional[int] = 10_000
+  num_samples_point2d: Optional[int] = 50_000
+  num_samples_ray: Optional[int] = 500
 
   def replace(self: _T, **kwargs) -> _T:
     return dataclasses.replace(self, **kwargs)
@@ -62,11 +87,9 @@ class TraceConfig:
 
   # NOTE: When adding new properties here, please also update all
   # `.replace_fig_config(` function to get type checking/auto-complete.
-  # TODO(epot): More dynamic sub-sampling controled in `v3d.make_fig` per
-  # figures (global control)
 
   name: Optional[str] = None
-  num_samples: int = -1
+  num_samples: Union[LazyValue[Optional[int]], Optional[int]] = -1
 
   def replace(self: _T, **kwargs) -> _T:
     return dataclasses.replace(self, **kwargs)

visu3d/plotly/fig_utils.py

@@ -164,9 +164,12 @@ def make_traces(
     if is_visualizable(val):
       if isinstance(val, dca.DataclassArray):
         if has_fig_config(val):
+          num_samples = val.fig_config.num_samples
+          if isinstance(num_samples, fig_config_utils.LazyValue):
+            num_samples = num_samples.value
           val = math.subsample(
               val,
-              num_samples=val.fig_config.num_samples,
+              num_samples=num_samples,
               # TODO(epot): Should likely make the seed depend on other
               # factors like class name, position in make_traces *args,...
               seed=0,