Welcome

Welcome to Raysect, an OOP ray-tracing framework for Python. Raysect has been built with scientific ray-tracing in mind. Some of its features include:

• Fully spectral, high precision. Supports scientific ray-tracing of spectra from physical light sources such as plasmas.

• All core loops are written in cython for speed.

• Easily extensible, written with user customisation of materials and emissive sources in mind.

• Different observer types supported such as Pinhole cameras and optical fibres.

The Raysect Development Team:

• Dr Alex Meakins

• Dr Matthew Carr

Quick Installation

The easiest way to install Raysect is using pip:

pip install raysect

For more detailed installation instructions see Downloading and Installation.

Need Help?

Please post a question on the github issue queue.

Table of Contents

• 1. Introduction
  • 1.1. What is raysect
  • 1.2. Feature set
  • 1.3. Structure/Architecture
  • 1.4. Contributions
• 2. License
• 3. Downloading and Installation
  • 3.1. Prerequisites
  • 3.2. Installation
  • 3.3. Testing
• 4. How it works
  • 4.1. What is a ray tracer?
  • 4.2. Key Concepts
  • 4.3. Process of raytracing
• 5. Quickstart Guide
  • 5.1. Create Primitives
  • 5.2. Add Observer
  • 5.3. Build Scenegraph
  • 5.4. Observe()
  • 5.5. Simulated Spectrum
• 6. Sampling and Observers
  • 6.1. Primer on Monte-Carlo Integration
  • 6.2. Observing Surfaces
  • 6.3. Material Surfaces
  • 6.4. Participating Media
• 7. Primitives
  • 7.1. Geometric Primitives
  • 7.2. CSG Operations
  • 7.3. Meshes
• 8. Materials
• 9. Conventions
• 10. References
  • 10.1. Books
  • 10.2. Papers & Reports
  • 10.3. Conference Proceedings
  • 10.4. Websites
• 11. Glossary

Demonstrations

• 1. Core Functionality
• 2. Materials
• 3. Observers
• 4. Optics

API Reference

• 1. Raysect Core
  • 1.1. Core Classes
  • 1.2. Math Module
    • 1.2.1. Points and Vectors
    • 1.2.2. Affine Matricies
    • 1.2.3. Functions and Interpolators
    • 1.2.4. Random
    • 1.2.5. Statistics Arrays
    • 1.2.6. Unit Conversions
  • 1.3. Scenegraph Module
  • 1.4. Spatial Acceleration
  • 1.5. Render Engines
  • 1.6. Utilities
    • 1.6.1. Containers
• 2. Primitives Module
  • 2.1. Geometric Primitives
  • 2.2. Meshes
  • 2.3. CSG Operations
  • 2.4. Optical Elements
    • 2.4.1. Spherical Lenses
• 3. Optical Module
  • 3.1. Main Optical Classes
    • 3.1.1. Optical Rays
    • 3.1.2. Spectral Functions
    • 3.1.3. Colours
    • 3.1.4. Optical Scenegraph
  • 3.2. Observers
    • 3.2.1. 0D Observers
    • 3.2.2. 1D Observers
    • 3.2.3. 2D Observers
  • 3.3. Frame Samples and Pipelines
    • 3.3.1. Base Classes
    • 3.3.2. RGB
    • 3.3.3. Bayer
    • 3.3.4. Power
    • 3.3.5. Radiance
    • 3.3.6. Spectral
    • 3.3.7. Frame Samplers
  • 3.4. Optical Material Base Classes
  • 3.5. Optical Surface Materials
    • 3.5.1. Absorber
    • 3.5.2. Emitters
    • 3.5.3. Lambertian
    • 3.5.4. Conductors
    • 3.5.5. Dielectrics
    • 3.5.6. Modifiers
    • 3.5.7. Debugging
  • 3.6. Optical Volume Materials

Indices and Tables

• Index

• Module Index

• Search Page