Merge pull request #322 from raysect/development

Release v0.6.0

Author: CnlPepper

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+plugins = Cython.Coverage
+source = raysect
+omit = *tests*

CHANGELOG.txt

@@ -1,6 +1,27 @@
 Raysect Changelog
 =================
 
+Release 0.6.0 (13 Nov 2019)
+---------------------------
+
+API Changes:
+* Blend material modifier now blends the surface and volume by default. Use the surface_only and volume_only options to configure.
+* Cython minimum, maximum and peak to peak methods can now cope with arbitrary strides.
+* Interpolator2DMesh and Discrete2DMesh have import has changed from raysect.core.math.interpolators to raysect.core.math.function.
+
+New:
+* Added an Add material modifier than sums the contributions from two materials.
+* Added emissivity function to BlackBody.
+* Extended Spectrum cython mathematical methods to simplify combining Spectrum objects.
+* Expanded the function framework:
+  - Constants are now autowrapped as ConstantXD objects automatically.
+  - Added PowXD, ExpXD, SinXD, CosXD, TanXD, AsinXD, AcosXD, AtanXD, Atan4QXD functions.
+  - Argument pass-through supported with ArgXD functions.
+  - Interpolation functions moved under raysect.core.math.function.
+* Improved the Multicore render engine by batching work to reduce IPC overhead. Renders with smaller amounts of work per pixel are now substantially quicker.
+* Improved multiple demos and related documentation.
+
+
 Release 0.5.6 (24 Aug 2019)
 ---------------------------
 

MANIFEST.in

@@ -1,5 +1,6 @@
 include README.md CHANGELOG.txt LICENSE.txt CONTRIBUTING.txt AUTHORS.txt MANIFEST.in setup.py .gitignore
 include raysect/VERSION
+global-exclude *.c
 recursive-include raysect *.py *.pyx *.pxd *.csv *.json
 recursive-include demos *.py *.pyx *.pxd *.csv *.obj *.rsm
 recursive-include docs *

demos/cornell_box.py

@@ -97,11 +97,13 @@
             transform=translate(0, 1, 0) * rotate(0, 90, 0),
             material=UniformSurfaceEmitter(light_spectrum, 2))
 
+# alternate light #1
 # light = Box(Point3D(-0.4, -0.4, -0.01), Point3D(0.4, 0.4, 0.0),
 #             parent=enclosure,
 #             transform=translate(0, 1, 0) * rotate(0, 90, 0),
 #             material=UniformSurfaceEmitter(d65_white, 2))
 
+# alternate light #2
 # back_light = Sphere(0.1,
 #     parent=enclosure,
 #     transform=translate(0.80, -0.85, 0.80)*rotate(0, 0, 0),
@@ -140,13 +142,13 @@
 
 pipelines = [rgb, power_unfiltered, power_green, power_red, bayer]
 
-sampler = RGBAdaptiveSampler2D(rgb, ratio=10, fraction=0.2, min_samples=500, cutoff=0.05)
+sampler = RGBAdaptiveSampler2D(rgb, ratio=10, fraction=0.2, min_samples=500, cutoff=0.01)
 
-camera = PinholeCamera((512, 512), parent=world, transform=translate(0, 0, -3.3) * rotate(0, 0, 0), pipelines=pipelines)
+camera = PinholeCamera((1024, 1024), parent=world, transform=translate(0, 0, -3.3) * rotate(0, 0, 0), pipelines=pipelines)
 camera.frame_sampler = sampler
-camera.pixel_samples = 250
-camera.spectral_bins = 15
 camera.spectral_rays = 1
+camera.spectral_bins = 15
+camera.pixel_samples = 250
 camera.ray_importance_sampling = True
 camera.ray_important_path_weight = 0.25
 camera.ray_max_depth = 500
@@ -155,21 +157,22 @@
 
 # start ray tracing
 ion()
-p = 1
+name = 'cornell_box'
+timestamp = time.strftime("%Y-%m-%d_%H-%M-%S")
+render_pass = 1
 while not camera.render_complete:
 
-    print("Rendering pass {}...".format(p))
-
+    print("Rendering pass {}...".format(render_pass))
     camera.observe()
-
-    rgb.save('cornell_box_rgb_pass_{:04d}.png'.format(p))
-    power_unfiltered.save('cornell_box_unfiltered_pass_{:04d}.png'.format(p))
+    rgb.save("{}_{}_pass_{}.png".format(name, timestamp, render_pass))
+    # power_unfiltered.save('cornell_box_unfiltered_pass_{:04d}.png'.format(p))
     # power_red.save('cornell_box_red_filter_pass_{:04d}.png'.format(p))
     # power_green.save('cornell_box_green_filter_pass_{:04d}.png'.format(p))
     # bayer.save('cornell_box_bayer_pass_{:04d}.png'.format(p))
-
     print()
-    p += 1
+
+    render_pass += 1
 
 ioff()
 rgb.display()
+

demos/materials/bunny.py

@@ -1,23 +1,20 @@
-
 # External imports
 import os
 from matplotlib.pyplot import *
 import time
 
 # Internal imports
 from raysect.optical import World, translate, rotate, Point3D, d65_white, ConstantSF, Node
-from raysect.optical.observer import PinholeCamera
-from raysect.optical.material.dielectric import Sellmeier, Dielectric
+from raysect.optical.observer import PinholeCamera, RGBPipeline2D, RGBAdaptiveSampler2D
 from raysect.optical.material.emitter import UniformVolumeEmitter
 from raysect.optical.material import Lambert
 from raysect.primitive import Box, Subtract
-from raysect.primitive.mesh import Mesh, import_obj
+from raysect.primitive.mesh import import_obj
 from raysect.optical.library import schott
 
-
 """
-A Diamond Stanford Bunny on an Illuminated Glass Pedestal
----------------------------------------------------------
+A Glass Stanford Bunny on an Illuminated Glass Pedestal
+-------------------------------------------------------
 
 Bunny model source:
   Stanford University Computer Graphics Laboratory
@@ -33,41 +30,68 @@
 mesh = import_obj(os.path.join(base_path, "../resources/stanford_bunny.obj"), parent=world,
                       transform=translate(0, 0, 0)*rotate(165, 0, 0), material=schott("N-BK7"))
 
-
 # LIGHT BOX
 padding = 1e-5
 enclosure_thickness = 0.001 + padding
 glass_thickness = 0.003
 
 light_box = Node(parent=world)
 
-enclosure_outer = Box(Point3D(-0.10 - enclosure_thickness, -0.02 - enclosure_thickness, -0.10 - enclosure_thickness),
-                      Point3D(0.10 + enclosure_thickness, 0.0, 0.10 + enclosure_thickness))
-enclosure_inner = Box(Point3D(-0.10 - padding, -0.02 - padding, -0.10 - padding),
-                      Point3D(0.10 + padding, 0.001, 0.10 + padding))
+enclosure_outer = Box(
+    Point3D(-0.10 - enclosure_thickness, -0.02 - enclosure_thickness, -0.10 - enclosure_thickness),
+    Point3D(0.10 + enclosure_thickness, 0.0, 0.10 + enclosure_thickness)
+)
+
+enclosure_inner = Box(
+    Point3D(-0.10 - padding, -0.02 - padding, -0.10 - padding),
+    Point3D(0.10 + padding, 0.001, 0.10 + padding)
+)
+
 enclosure = Subtract(enclosure_outer, enclosure_inner, material=Lambert(ConstantSF(0.2)), parent=light_box)
 
-glass_outer = Box(Point3D(-0.10, -0.02, -0.10),
-                  Point3D(0.10, 0.0, 0.10))
-glass_inner = Box(Point3D(-0.10 + glass_thickness, -0.02 + glass_thickness, -0.10 + glass_thickness),
-                  Point3D(0.10 - glass_thickness, 0.0 - glass_thickness, 0.10 - glass_thickness))
+glass_outer = Box(
+    Point3D(-0.10, -0.02, -0.10),
+    Point3D(0.10, 0.0, 0.10)
+)
+
+glass_inner = Box(
+    Point3D(-0.10 + glass_thickness, -0.02 + glass_thickness, -0.10 + glass_thickness),
+    Point3D(0.10 - glass_thickness, 0.0 - glass_thickness, 0.10 - glass_thickness)
+)
+
 glass = Subtract(glass_outer, glass_inner, material=schott("N-BK7"), parent=light_box)
 
-emitter = Box(Point3D(-0.10 + glass_thickness + padding, -0.02 + glass_thickness + padding, -0.10 + glass_thickness + padding),
-              Point3D(0.10 - glass_thickness - padding, 0.0 - glass_thickness - padding, 0.10 - glass_thickness - padding),
-              material=UniformVolumeEmitter(d65_white, 50), parent=light_box)
+emitter = Box(
+    Point3D(-0.10 + glass_thickness + padding, -0.02 + glass_thickness + padding, -0.10 + glass_thickness + padding),
+    Point3D(0.10 - glass_thickness - padding, 0.0 - glass_thickness - padding, 0.10 - glass_thickness - padding),
+    material=UniformVolumeEmitter(d65_white, 50),
+    parent=light_box
+)
 
 # CAMERA
-ion()
-camera = PinholeCamera((256, 256), fov=40, parent=world, transform=translate(0, 0.16, -0.4) * rotate(0, -12, 0))
-camera.pixel_samples = 50
+rgb = RGBPipeline2D(display_unsaturated_fraction=0.96, name="sRGB")
+sampler = RGBAdaptiveSampler2D(rgb, ratio=10, fraction=0.2, min_samples=2000, cutoff=0.01)
+camera = PinholeCamera((1024, 1024), parent=world, transform=translate(0, 0.16, -0.4) * rotate(0, -12, 0), pipelines=[rgb], frame_sampler=sampler)
 camera.spectral_rays = 15
 camera.spectral_bins = 15
-camera.observe()
+camera.pixel_samples = 250
+camera.ray_max_depth = 500
+camera.ray_extinction_min_depth = 3
+camera.ray_extinction_prob = 0.01
 
-ioff()
-rgb = camera.pipelines[0]
-rgb.save("stanford_bunny_{}.png".format(time.strftime("%Y-%m-%d_%H-%M-%S")))
+# RAY TRACE
+ion()
+name = 'standford_bunny'
+timestamp = time.strftime("%Y-%m-%d_%H-%M-%S")
+render_pass = 1
+while not camera.render_complete:
+
+    print("Rendering pass {}...".format(render_pass))
+    camera.observe()
+    rgb.save("{}_{}_pass_{}.png".format(name, timestamp, render_pass))
+    print()
 
-show()
+    render_pass += 1
 
+ioff()
+rgb.display()

demos/materials/diamond.py

@@ -11,7 +11,7 @@
 
 
 # DIAMOND MATERIAL
-diamond_material = Dielectric(Sellmeier(0.3306, 4.3356, 0.0, 0.1750**2, 0.1060**2, 0.0), ConstantSF(1))
+diamond_material = Dielectric(Sellmeier(0.3306, 4.3356, 0.0, 0.1750**2, 0.1060**2, 0.0), ConstantSF(0.998))
 diamond_material.importance = 2
 
 world = World()
@@ -32,24 +32,30 @@
 Sphere(10, world, transform=translate(7, 20, 20), material=UniformSurfaceEmitter(d65_white, 0.15))
 
 # camera
-rgb_pipeline = RGBPipeline2D(display_update_time=15, display_unsaturated_fraction=0.998)
-sampler = RGBAdaptiveSampler2D(rgb_pipeline, min_samples=400, fraction=0.1)
-camera = PinholeCamera((1024, 1024), parent=world, transform=translate(0, 4, -3.5) * rotate(0, -46, 0), pipelines=[rgb_pipeline], frame_sampler=sampler)
-camera.spectral_bins = 18
-camera.spectral_rays = 9
-camera.pixel_samples = 200
-
+rgb = RGBPipeline2D(display_update_time=15, display_unsaturated_fraction=0.995)
+sampler = RGBAdaptiveSampler2D(rgb, min_samples=1000, fraction=0.1, cutoff=0.01)
+camera = PinholeCamera((1024, 1024), parent=world, transform=translate(0, 4, -3.5) * rotate(0, -46, 0), pipelines=[rgb], frame_sampler=sampler)
+camera.spectral_bins = 21
+camera.spectral_rays = 21
+camera.pixel_samples = 250
+camera.ray_max_depth = 10000
+camera.ray_extinction_min_depth = 3
+camera.ray_extinction_prob = 0.002
 
 # start ray tracing
 ion()
+name = 'diamond'
 timestamp = time.strftime("%Y-%m-%d_%H-%M-%S")
-for p in range(1, 1000):
-    print("Rendering pass {}...".format(p))
+render_pass = 1
+while not camera.render_complete:
+
+    print("Rendering pass {}...".format(render_pass))
     camera.observe()
-    rgb_pipeline.save("demo_diamond_{}_pass_{}.png".format(timestamp, p))
+    rgb.save("{}_{}_pass_{}.png".format(name, timestamp, render_pass))
     print()
 
-# display final result
+    render_pass += 1
+
 ioff()
-rgb_pipeline.display()
-show()
+rgb.display()
+