move work distribution to camera props

Author: robertsulej

examples/1_basics/16_work_distribution.ipynb

@@ -287,17 +287,12 @@ def _load_optix_win():
     optix.set_coordinates_geom.argtypes = [c_int, c_float]
     optix.set_coordinates_geom.restype = c_bool
 
-    optix.get_work_distribution.restype = c_int
-
-    optix.set_work_distribution.argtypes = [c_int]
-    optix.set_work_distribution.restype = c_bool
-
     optix.get_noise_threshold.restype = c_float
 
     optix.set_noise_threshold.argtypes = [c_float]
     optix.set_noise_threshold.restype = c_bool
 
-    optix.setup_camera.argtypes = [c_wchar_p, c_int, c_void_p, c_void_p, c_void_p, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_bool, c_wchar_p, c_bool]
+    optix.setup_camera.argtypes = [c_wchar_p, c_int, c_int, c_void_p, c_void_p, c_void_p, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_float, c_bool, c_wchar_p, c_bool]
     optix.setup_camera.restype = c_int
 
     optix.update_camera.argtypes = [c_wchar_p, c_void_p, c_void_p, c_void_p, c_float, c_float, c_float, c_float, c_float, c_float, c_float]
@@ -941,16 +936,12 @@ def delete_geometry(self, name): return self._optix.delete_geometry(name)
 
     def set_coordinates_geom(self, mode, thickness): return self._optix.set_coordinates_geom(mode, thickness)
 
-    def get_work_distribution(self): return self._optix.get_work_distribution()
-
-    def set_work_distribution(self, mode): return self._optix.set_work_distribution(mode)
-
     def get_noise_threshold(self): return self._optix.get_noise_threshold()
 
     def set_noise_threshold(self, thr): return self._optix.set_noise_threshold(thr)
 
-    def setup_camera(self, name, camera_type, eye, target, up, aperture_r, aperture_fract, focal_scale, chroma_l, chroma_t, fov, rxy, cx, cy, sensor_height, blur, glock, textures, make_current):
-        return self._optix.setup_camera_ptr(name, camera_type,
+    def setup_camera(self, name, camera_type, work_distribution, eye, target, up, aperture_r, aperture_fract, focal_scale, chroma_l, chroma_t, fov, rxy, cx, cy, sensor_height, blur, glock, textures, make_current):
+        return self._optix.setup_camera_ptr(name, camera_type, work_distribution,
                                             IntPtr.__overloads__[Int64](eye),
                                             IntPtr.__overloads__[Int64](target),
                                             IntPtr.__overloads__[Int64](up),
@@ -1715,16 +1706,12 @@ def delete_geometry(self, name): return self._optix.delete_geometry(name)
 
     def set_coordinates_geom(self, mode, thickness): return self._optix.set_coordinates_geom(mode, float(thickness))
 
-    def get_work_distribution(self): return self._optix.get_work_distribution()
-
-    def set_work_distribution(self, mode): return self._optix.set_work_distribution(mode)
-
     def get_noise_threshold(self): return self._optix.get_noise_threshold()
 
     def set_noise_threshold(self, thr): return self._optix.set_noise_threshold(thr)
 
-    def setup_camera(self, name, camera_type, eye, target, up, aperture_r, aperture_fract, focal_scale, chroma_l, chroma_t, fov, rxy, cx, cy, sensor_height, blur, glock, textures, make_current):
-        return self._optix.setup_camera_ptr(name, camera_type,
+    def setup_camera(self, name, camera_type, work_distribution, eye, target, up, aperture_r, aperture_fract, focal_scale, chroma_l, chroma_t, fov, rxy, cx, cy, sensor_height, blur, glock, textures, make_current):
+        return self._optix.setup_camera_ptr(name, camera_type, work_distribution,
                                             IntPtr(eye),
                                             IntPtr(target),
                                             IntPtr(up),

plotoptix/_load_lib.py

@@ -458,7 +458,15 @@ class WorkDistribution(Enum):
     """
 
     NoiseBalanced = 1
-    """More rays towards noisy pixels.
+    """More rays towards pixels with a higher relative noise, same as.
+    """
+    
+    RelNoiseBalanced = 1
+    """More rays towards pixels a higher relative noise.
+    """
+    
+    AbsNoiseBalanced = 2
+    """More rays towards pixels a higher absolute noise.
     """
 
 class Camera(Enum):

plotoptix/bin/RnD.SharpOptiX.dll

@@ -2144,15 +2144,6 @@ def set_param(self, **kwargs) -> None:
           names ``"Hard"`` and ``"Soft"`` are accepted.
         
           Set mode before adding lights.
-        
-        - ``work_distribution``: how rays per pixel are distributed
-
-          Default value is :attr:`plotoptix.enums.WorkDistribution.Uniform`,
-          shooting constant number of rays per pixel (though no. of rays may
-          differ vor various materials of the primary hit).
-
-          Use :attr:`plotoptix.enums.WorkDistribution.NoiseBalanced` for dynamic
-          distribution of rays based on the estimated per pixel noise.
 
         - ``max_accumulation_frames``
         
@@ -2205,12 +2196,6 @@ def set_param(self, **kwargs) -> None:
                 elif key == "max_accumulation_frames":
                     self._optix.set_max_accumulation_frames(int(value))
 
-                elif key == "work_distribution":
-                    if isinstance(value, str): mode = WorkDistribution[value]
-                    else: mode = value
-
-                    self._optix.set_work_distribution(mode.value)
-
                 elif key == "noise_threshold":
                     self._optix.set_noise_threshold(float(value))
 
@@ -2758,6 +2743,7 @@ def setup_camera(self, name: str,
                      target: Optional[Any] = None,
                      up: Optional[Any] = None,
                      cam_type: Union[Camera, str] = Camera.Pinhole,
+                     work_distribution: Union[WorkDistribution, str] = WorkDistribution.Uniform,
                      aperture_radius: float = -1,
                      aperture_fract: float = 0.15,
                      focal_scale: float = -1,
@@ -2794,6 +2780,12 @@ def setup_camera(self, name: str,
         cam_type : Camera enum or string, optional
             Type (pinhole, depth of field, ...), see :class:`plotoptix.enums.Camera`.
             Cannot be changed after construction.
+        work_distribution :
+            How rays per pixel are distributed. Default value is :attr:`plotoptix.enums.WorkDistribution.Uniform`,
+            shooting constant number of rays per pixel (though no. of rays may
+            differ vor various materials of the primary hit).
+            See :class:`plotoptix.enums.WorkDistribution` for dynamic
+            distribution of rays based on the estimated per pixel noise.        
         aperture_radius : float, optional
             Aperture radius (increases focus blur for depth of field cameras). Default
             `-1` is internally reset to `0.1`.
@@ -2837,6 +2829,7 @@ def setup_camera(self, name: str,
 
         if not isinstance(name, str): name = str(name)
         if isinstance(cam_type, str): cam_type = Camera[cam_type]
+        if isinstance(work_distribution, str): work_distribution = WorkDistribution[work_distribution]
 
         if name in self.camera_handles:
             self.update_camera(name=name, eye=eye, target=target, up=up,
@@ -2896,7 +2889,7 @@ def setup_camera(self, name: str,
         tex_list = ""
         if textures is not None: tex_list = ";".join(textures)
 
-        h = self._optix.setup_camera(name, cam_type.value,
+        h = self._optix.setup_camera(name, cam_type.value, work_distribution.value,
                                      eye_ptr, target_ptr, up.ctypes.data,
                                      aperture_radius, aperture_fract,
                                      focal_scale, chroma_l, chroma_t,