Skip to main content

Raytrace module

Project description

Chromatic Confocal Sensor Ray Tracer

Specialized ray tracing engine designed for simulating and optimizing chromatic confocal sensors. This repository provides a powerful toolset for researchers and engineers working on precise optical measurement systems, enabling the accurate modeling of light interactions within chromatic confocal setups.

Defining the setup

The optical setup is defined inside the setup.py file. If, for example, an achromatic doublet is defined each face of both lenses should be defined as follows:

doublet = {
    "AC500-150-A-ML_1": {
        "Front Face": dict(
            curvature=96.85, konic=0, z_0=0, aperture_radius=50 / 2
        ),
        "Back Face": dict(
            curvature=-73.74,
            konic=0,
            z_0=9.5,
            aperture_radius=50 / 2,
        ),
        "Material": "BAK4",
        "Calibration": False,
    },
    "AC500-150-A-ML_2": {
        "Front Face": dict(
            curvature=-73.74, konic=0, z_0=9.5, aperture_radius=50 / 2
        ),
        "Back Face": dict(
            curvature=-241.63,
            konic=0,
            z_0=13.5,
            aperture_radius=50 / 2,
        ),
        "Material": "SF10",
        "Calibration": False,
    },
    "AC500-150-A-ML_1_R": {
        "Front Face": dict(
            curvature=241.63,
            konic=0,
            z_0=0,
            aperture_radius=50 / 2,
        ),
        "Back Face": dict(
            curvature=73.74, konic=0, z_0=4, aperture_radius=50 / 2
        ),
        "Material": "BAK4",
        "Calibration": False,
    },
    "AC500-150-A-ML_2_R": {
        "Front Face": dict(
            curvature=73.74,
            konic=0,
            z_0=4,
            aperture_radius=50 / 2,
        ),
        "Back Face": dict(
            curvature=-96.85, konic=0, z_0=13.5, aperture_radius=50 / 2
        ),
        "Material": "SF10",
        "Calibration": False,
    },
    "Sensor": {
        "Front Face": dict(
            curvature=float("inf"),
            konic=0,
            z_0=170,
            aperture_radius=100,
        ),
        "Back Face": dict(
            curvature=float("inf"),
            konic=0,
            z_0=170,
            aperture_radius=100,
        ),
        "Material": "SF2",
        "Calibration": False,
    },
}

Lens materials

The materials available with their refractive indexes should be specified in a CSV file in the data folder as follows:

wl_nm intensity n_BK7 n_SF2 n_SF5 n_BAF10 n_SF10 n_BAK4 n_SF57
500.5 0.0851431638 1.5213856439764 1.6587264318676913 1.6847781738090497 1.67825 1.74315 1.57468 1.86746
500.7 0.08645302802 1.5213723632237195 1.6586929033319964 1.6847437966326086 1.6782202524647911 1.7430968741556505 1.574659846238762 1.8673847333525386
500.8 0.08502408117 1.5213657288620468 1.658676166909398 1.684726608044388 1.6782055071330022 1.7430704823647605 1.5746498284981434 1.8673473595993073
501.0 0.08721513301 1.5213524721680336 1.6586427497546976 1.6846922308679468 1.6781762683497092 1.7430180354906653 1.5746299095672376 1.86727312240276
501.1 0.08640539646 1.5213458498356942 1.658626069022597 1.684675042279726 1.6781617729016662 1.7429919781855066 1.5746200076850838 1.867236255427011

Example usage


from confocal_raytracer.simulation.raytrace import RayTrace
from confocal_raytracer.simulation.setup import chromatic_confocal
from confocal_raytracer.simulation._utils import plotter
from confocal_raytracer.load_data import n_data
import numpy as np
import matplotlib.pyplot as plt
import time
import warnings

warnings.filterwarnings("ignore")
n_data["n_absorb"] = np.inf
n_data = n_data[::5]

optical_data = chromatic_confocal
PINHOLE_SIZE = 25 / 1000  # milimeters
N_RAYS = 3
LIGHT_SOURCE_RADIUS = 0 / 1000  # milimeters
THETA = 6.0  # Degrees
N_RAYS_HEIGHT = 1
Z0 = -33.4  # Light source position same as
# back focal length of the achormatic doublet

fig, ax = plt.subplots()

raytrace = RayTrace(
    optical_data=optical_data,
    n_data=n_data,
    light_source_radius=LIGHT_SOURCE_RADIUS,
    n_rays=N_RAYS,
    theta=THETA,
    z0=Z0,
    n_rays_height=N_RAYS_HEIGHT,
)

t0 = time.perf_counter()
frays = raytrace.intersect_full_system()
print("Elapsed time (s): ", time.perf_counter() - t0)

# Plot setup
fig, ax = plotter(optical_data=optical_data, final_rays=frays, fig=fig, ax=ax)
plt.plot(
    [
        optical_data["Sensor"]["Front Face"]["z_0"],
        optical_data["Sensor"]["Front Face"]["z_0"],
    ],
    [-PINHOLE_SIZE / 2, PINHOLE_SIZE / 2],
    c="r",
)
ax.set(xlabel="z-position (mm)", ylabel="y-position (mm)")
axins = ax.inset_axes([0.25, 0.1, 0.35, 0.35])
plotter(optical_data=optical_data, final_rays=frays, fig=fig, ax=axins)
axins.plot(
    [
        optical_data["Sensor"]["Front Face"]["z_0"],
        optical_data["Sensor"]["Front Face"]["z_0"],
    ],
    [-PINHOLE_SIZE / 2, PINHOLE_SIZE / 2],
    c="r",
    lw=3,
    label="PINHOLE",
)
x1, x2, y1, y2 = (
    optical_data["Sensor"]["Front Face"]["z_0"] - 0.1,
    optical_data["Sensor"]["Front Face"]["z_0"] + 0.1,
    -0.1,
    0.1,
)
axins.legend()
axins.set_xlim(x1, x2)
axins.set_ylim(y1, y2)
plt.gca().indicate_inset_zoom(axins, edgecolor="black")
plt.tight_layout()
plt.show()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

confocal_raytracer-0.1.29.tar.gz (300.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

confocal_raytracer-0.1.29-py3-none-any.whl (292.9 kB view details)

Uploaded Python 3

File details

Details for the file confocal_raytracer-0.1.29.tar.gz.

File metadata

  • Download URL: confocal_raytracer-0.1.29.tar.gz
  • Upload date:
  • Size: 300.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.9.13 Windows/10

File hashes

Hashes for confocal_raytracer-0.1.29.tar.gz
Algorithm Hash digest
SHA256 f7362eb0b7e7424c099ff333259c6f10132926303be38ad8f1ffa5f4d9d3c874
MD5 dcb43108b172dc96dc449072aec1d9d4
BLAKE2b-256 45cb25658db444a9fe8d784fa04e857593d3ad277f65620e31e05e2c8cf46a06

See more details on using hashes here.

File details

Details for the file confocal_raytracer-0.1.29-py3-none-any.whl.

File metadata

File hashes

Hashes for confocal_raytracer-0.1.29-py3-none-any.whl
Algorithm Hash digest
SHA256 f08c478672663d85c63224b686c8b6df981d8514480dbd9a3e693f3fbf33c5bb
MD5 66d82ab8f876d1cb75473749e1c7fdf7
BLAKE2b-256 d994c5577f9775fee9bb4d8a459f0beed35a86cc06871e8ebb830ee2fcac1270

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page