improve docs

rnd-team-dev · Apr 27, 2023 · d00768f · d00768f
1 parent 1722e7f
commit d00768f
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 3 deletions.
diff --git a/docs/npoptix_config.rst b/docs/npoptix_config.rst
@@ -86,6 +86,35 @@ GPU variables related to the raytracer general configuraton are documented below
      rt = TkOptiX()
      rt.set_float("scene_epsilon", 1.0e-04)
 
+- **Denoiser start frame**
+
+  Name: *denoiser_start*
+
+  Type: ``uint``
+
+  Default value: ``4``
+
+  AI denoiser is applied to output image after accumulating ``denoiser_start`` frames. Use default
+  value for interactive work. Use higher values for final rendering, when noisy intermediate results
+  are acceptable. In such cases the optimal configuration is to set ``denoiser_start`` value equal
+  to ``max_accumulation_frames`` (see :meth:`plotoptix.NpOptiX.set_param`), then denoiser is applied
+  only once, at the end of ray tracing.
+
+  Example:
+
+  .. code-block:: python
+
+     rt = TkOptiX()
+     rt.set_param(min_accumulation_step=8,     # update image every 8 frames
+                  max_accumulation_frames=128, # accumulate 128 frames in total
+                 )
+     rt.set_uint("denoiser_start", 128)        # denoise when the accumulation is finished
+
+     rt.set_float("tonemap_exposure", 0.9)
+     rt.set_float("tonemap_gamma", 2.2)
+     rt.add_postproc("Denoiser")               # setup denoiser postprocessing
+
+
 .. automethod:: plotoptix.NpOptiX.set_param
 .. automethod:: plotoptix.NpOptiX.get_param
 .. automethod:: plotoptix.NpOptiX.set_int

diff --git a/plotoptix/enums.py b/plotoptix/enums.py
@@ -746,7 +746,7 @@ class Postprocessing(Enum):
       range: 0 (only denoiser output) to 1 (only original raytracing output)
 
     - denoiser_start, uint, number of the accumulation frame after which denoiser is applied;
-      default velue is 4.
+      default velue is 4; see also denoiser_start in `raytracer configuration <npoptix_config.html#raytracer-configuration>`_
 
     - denoiser_kind, int value of :class:`plotoptix.enums.DenoiserKind`, decides
       which buffers are used as denoiser inputs
@@ -772,7 +772,7 @@ class Postprocessing(Enum):
       range: 0 (only denoiser output) to 1 (only original raytracing output)
 
     - denoiser_start, uint, number of the accumulation frame after which denoiser is applied;
-      default velue is 4.
+      default velue is 4; see also denoiser_start in `raytracer configuration <npoptix_config.html#raytracer-configuration>`_
 
     - denoiser_kind, int value of :class:`plotoptix.enums.DenoiserKind`, decides
       which buffers are used as denoiser inputs
@@ -801,7 +801,7 @@ class Postprocessing(Enum):
       range: 0 (only denoiser output) to 1 (only original raytracing output)
 
     - denoiser_start, uint, number of the accumulation frame after which denoiser is applied;
-      default velue is 4.
+      default velue is 4;  see also denoiser_start in `raytracer configuration <npoptix_config.html#raytracer-configuration>`_
 
     - denoiser_kind, int value of :class:`plotoptix.enums.DenoiserKind`, decides
       which buffers are used as denoiser inputs