Skip to content

Commit d00768f

Browse files
committed
improve docs
1 parent 1722e7f commit d00768f

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

docs/npoptix_config.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,35 @@ GPU variables related to the raytracer general configuraton are documented below
8686
rt = TkOptiX()
8787
rt.set_float("scene_epsilon", 1.0e-04)
8888
89+
- **Denoiser start frame**
90+
91+
Name: *denoiser_start*
92+
93+
Type: ``uint``
94+
95+
Default value: ``4``
96+
97+
AI denoiser is applied to output image after accumulating ``denoiser_start`` frames. Use default
98+
value for interactive work. Use higher values for final rendering, when noisy intermediate results
99+
are acceptable. In such cases the optimal configuration is to set ``denoiser_start`` value equal
100+
to ``max_accumulation_frames`` (see :meth:`plotoptix.NpOptiX.set_param`), then denoiser is applied
101+
only once, at the end of ray tracing.
102+
103+
Example:
104+
105+
.. code-block:: python
106+
107+
rt = TkOptiX()
108+
rt.set_param(min_accumulation_step=8, # update image every 8 frames
109+
max_accumulation_frames=128, # accumulate 128 frames in total
110+
)
111+
rt.set_uint("denoiser_start", 128) # denoise when the accumulation is finished
112+
113+
rt.set_float("tonemap_exposure", 0.9)
114+
rt.set_float("tonemap_gamma", 2.2)
115+
rt.add_postproc("Denoiser") # setup denoiser postprocessing
116+
117+
89118
.. automethod:: plotoptix.NpOptiX.set_param
90119
.. automethod:: plotoptix.NpOptiX.get_param
91120
.. automethod:: plotoptix.NpOptiX.set_int

plotoptix/enums.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -746,7 +746,7 @@ class Postprocessing(Enum):
746746
range: 0 (only denoiser output) to 1 (only original raytracing output)
747747
748748
- denoiser_start, uint, number of the accumulation frame after which denoiser is applied;
749-
default velue is 4.
749+
default velue is 4; see also denoiser_start in `raytracer configuration <npoptix_config.html#raytracer-configuration>`_
750750
751751
- denoiser_kind, int value of :class:`plotoptix.enums.DenoiserKind`, decides
752752
which buffers are used as denoiser inputs
@@ -772,7 +772,7 @@ class Postprocessing(Enum):
772772
range: 0 (only denoiser output) to 1 (only original raytracing output)
773773
774774
- denoiser_start, uint, number of the accumulation frame after which denoiser is applied;
775-
default velue is 4.
775+
default velue is 4; see also denoiser_start in `raytracer configuration <npoptix_config.html#raytracer-configuration>`_
776776
777777
- denoiser_kind, int value of :class:`plotoptix.enums.DenoiserKind`, decides
778778
which buffers are used as denoiser inputs
@@ -801,7 +801,7 @@ class Postprocessing(Enum):
801801
range: 0 (only denoiser output) to 1 (only original raytracing output)
802802
803803
- denoiser_start, uint, number of the accumulation frame after which denoiser is applied;
804-
default velue is 4.
804+
default velue is 4; see also denoiser_start in `raytracer configuration <npoptix_config.html#raytracer-configuration>`_
805805
806806
- denoiser_kind, int value of :class:`plotoptix.enums.DenoiserKind`, decides
807807
which buffers are used as denoiser inputs

0 commit comments

Comments
 (0)