3. Optical Module

• 3.1. Main Optical Classes
  • 3.1.1. Optical Rays
    • Ray
      • Ray.bins
      • Ray.copy()
      • Ray.extinction_min_depth
      • Ray.extinction_prob
      • Ray.important_path_weight
      • Ray.max_depth
      • Ray.max_wavelength
      • Ray.min_wavelength
      • Ray.new_spectrum()
      • Ray.sample()
      • Ray.spawn_daughter()
      • Ray.trace()
      • Ray.wavelength_range
  • 3.1.2. Spectral Functions
    • SpectralFunction
      • SpectralFunction.average()
      • SpectralFunction.evaluate()
      • SpectralFunction.integrate()
      • SpectralFunction.sample()
    • Spectrum
      • Spectrum.clear()
      • Spectrum.copy()
      • Spectrum.is_compatible()
      • Spectrum.is_zero()
      • Spectrum.new_spectrum()
      • Spectrum.to_photons()
      • Spectrum.total()
      • Spectrum.wavelengths
    • NumericallyIntegratedSF
    • InterpolatedSF
    • ConstantSF
    • photon_energy()
  • 3.1.3. Colours
    • raysect.optical.colour.ciexyz_x
    • raysect.optical.colour.ciexyz_y
    • raysect.optical.colour.ciexyz_z
    • raysect.optical.colour.d65_white
    • resample_ciexyz()
    • spectrum_to_ciexyz()
    • ciexyy_to_ciexyz()
    • ciexyz_to_ciexyy()
    • ciexyz_to_srgb()
    • srgb_to_ciexyz()
  • 3.1.4. Optical Scenegraph
    • World
      • World.build_importance()
      • World.has_important_primitives()
      • World.important_direction_pdf()
      • World.important_direction_sample()
• 3.2. Observers
  • _ObserverBase
    • _ObserverBase.max_wavelength
    • _ObserverBase.min_wavelength
    • _ObserverBase.observe()
    • _ObserverBase.ray_extinction_min_depth
    • _ObserverBase.ray_extinction_prob
    • _ObserverBase.ray_important_path_weight
    • _ObserverBase.ray_max_depth
    • _ObserverBase.spectral_bins
    • _ObserverBase.spectral_rays
  • 3.2.1. 0D Observers
    • Observer0D
      • Observer0D._generate_rays()
      • Observer0D.pipelines
      • Observer0D.pixel_samples
      • Observer0D.samples_per_task
    • SightLine
      • SightLine.sensitivity
    • FibreOptic
      • FibreOptic.acceptance_angle
      • FibreOptic.collection_area
      • FibreOptic.radius
      • FibreOptic.sensitivity
      • FibreOptic.solid_angle
    • Pixel
      • Pixel.collection_area
      • Pixel.sensitivity
      • Pixel.solid_angle
      • Pixel.x_width
      • Pixel.y_width
    • MeshPixel
      • MeshPixel.collection_area
      • MeshPixel.sensitivity
      • MeshPixel.solid_angle
  • 3.2.2. 1D Observers
    • Observer1D
      • Observer1D._generate_rays()
      • Observer1D.frame_sampler
      • Observer1D.pipelines
      • Observer1D.pixel_samples
      • Observer1D.pixels
    • MeshCamera
      • MeshCamera.collection_area()
      • MeshCamera.sensitivity()
      • MeshCamera.solid_angle()
  • 3.2.3. 2D Observers
    • Observer2D
      • Observer2D._generate_rays()
      • Observer2D.frame_sampler
      • Observer2D.pipelines
      • Observer2D.pixel_samples
      • Observer2D.pixels
    • PinholeCamera
      • PinholeCamera.fov
      • PinholeCamera.pixels
      • PinholeCamera.sensitivity
    • OrthographicCamera
      • OrthographicCamera.pixels
      • OrthographicCamera.sensitivity
      • OrthographicCamera.width
    • CCDArray
      • CCDArray.pixels
      • CCDArray.width
    • VectorCamera
      • VectorCamera.sensitivity
• 3.3. Frame Samples and Pipelines
  • 3.3.1. Base Classes
    • 3.3.1.1. Frame Sampler
      • FrameSampler1D
        • FrameSampler1D.generate_tasks()
      • FrameSampler2D
        • FrameSampler2D.generate_tasks()
    • 3.3.1.2. Pipeline
      • Pipeline0D
        • Pipeline0D.finalise()
        • Pipeline0D.initialise()
        • Pipeline0D.pixel_processor()
        • Pipeline0D.update()
      • Pipeline1D
        • Pipeline1D.finalise()
        • Pipeline1D.initialise()
        • Pipeline1D.pixel_processor()
        • Pipeline1D.update()
      • Pipeline2D
        • Pipeline2D.finalise()
        • Pipeline2D.initialise()
        • Pipeline2D.pixel_processor()
        • Pipeline2D.update()
  • 3.3.2. RGB
    • RGBPipeline2D
      • RGBPipeline2D.display()
      • RGBPipeline2D.display_auto_exposure
      • RGBPipeline2D.display_sensitivity
      • RGBPipeline2D.display_unsaturated_fraction
      • RGBPipeline2D.display_update_time
      • RGBPipeline2D.save()
  • 3.3.3. Bayer
    • BayerPipeline2D
      • BayerPipeline2D.display()
      • BayerPipeline2D.display_auto_exposure
      • BayerPipeline2D.display_black_point
      • BayerPipeline2D.display_gamma
      • BayerPipeline2D.display_unsaturated_fraction
      • BayerPipeline2D.display_update_time
      • BayerPipeline2D.display_white_point
      • BayerPipeline2D.save()
  • 3.3.4. Power
    • PowerPipeline0D
    • PowerPipeline1D
    • PowerPipeline2D
      • PowerPipeline2D.display_auto_exposure
      • PowerPipeline2D.display_unsaturated_fraction
      • PowerPipeline2D.display_update_time
      • PowerPipeline2D.save()
  • 3.3.5. Radiance
    • RadiancePipeline0D
    • RadiancePipeline1D
    • RadiancePipeline2D
  • 3.3.6. Spectral
    • SpectralPowerPipeline0D
    • SpectralRadiancePipeline0D
      • SpectralRadiancePipeline0D.to_spectrum()
    • SpectralPowerPipeline1D
    • SpectralRadiancePipeline1D
      • SpectralRadiancePipeline1D.to_spectrum()
    • SpectralPowerPipeline2D
    • SpectralRadiancePipeline2D
      • SpectralRadiancePipeline2D.to_spectrum()
  • 3.3.7. Frame Samplers
    • FullFrameSampler1D
    • MonoAdaptiveSampler1D
    • SpectralAdaptiveSampler1D
    • FullFrameSampler2D
    • MonoAdaptiveSampler2D
    • SpectralAdaptiveSampler2D
    • RGBAdaptiveSampler2D
• 3.4. Optical Material Base Classes
  • Material
    • Material.evaluate_surface()
    • Material.evaluate_volume()
    • Material.importance
  • NullSurface
    • NullSurface.evaluate_surface()
  • NullVolume
    • NullVolume.evaluate_volume()
  • DiscreteBSDF
    • DiscreteBSDF.evaluate_surface()
  • ContinuousBSDF
    • ContinuousBSDF.bsdf()
    • ContinuousBSDF.evaluate_surface()
• 3.5. Optical Surface Materials
  • 3.5.1. Absorber
    • AbsorbingSurface
  • 3.5.2. Emitters
    • UnitySurfaceEmitter
    • UniformSurfaceEmitter
    • AnisotropicSurfaceEmitter
    • Checkerboard
  • 3.5.3. Lambertian
    • Lambert
  • 3.5.4. Conductors
    • Conductor
    • RoughConductor
  • 3.5.5. Dielectrics
    • Dielectric
    • Sellmeier
  • 3.5.6. Modifiers
    • Blend
    • Add
    • VolumeTransform
    • Roughen
  • 3.5.7. Debugging
    • Checkerboard
    • Light
    • PerfectReflectingSurface
• 3.6. Optical Volume Materials
  • UnityVolumeEmitter
  • UniformVolumeEmitter
  • HomogeneousVolumeEmitter
    • HomogeneousVolumeEmitter.emission_function()
  • InhomogeneousVolumeEmitter
    • InhomogeneousVolumeEmitter.emission_function()
  • VolumeIntegrator
    • VolumeIntegrator.integrate()
  • NumericalIntegrator
    • NumericalIntegrator.integrate()