Skip to main content

Ray Tracing Monte Carlo photon propagator and column density calculator

Project description

A fast library for calculating intersections of a line with many spheres or inhomogeneous material.

Introduction

https://johannesbuchner.github.io/LightRayRider/_static/logo.png

This small library computes line integrals through various three-dimensional geometric bodies. For example, millions of rays can be sent through millions of spheres of various sizes and densities. Three-dimensional uniform grids representing arbitrary density fields are also supported, as well as voronoi tesselation of points.

The library was developed for X-ray ray tracing with XARS <https://github.com/JohannesBuchner/xars/>. A point source can be obscured by a gas distribution along the line-of-sight. For hydrodynamic simulations which produce such a gas distribution, this code can compute the total density along a arbitrary ray. The output is a column density, also known as “N_H” if hydrogen gas is irradiated.

https://img.shields.io/pypi/v/lightrayrider.svg Documentation Status https://github.com/JohannesBuchner/LightRayRider/actions/workflows/tests.yml/badge.svg https://coveralls.io/repos/github/JohannesBuchner/LightRayRider/badge.svg?branch=master

Line/Sphere cutting

Input:

  • Points in space representing sphere centres.

  • Sphere radii and densities.

  • One or more arbitrary lines from the origin.

Output:

  • This computes the total length / column density cut.

  • From distance 0 or another chosen minimal distance (or multiple).

Method:

  • Simple quadratic equations.

Voronoi cutting

Input:

  • Points in space.

  • Densities.

  • One or more arbitrary lines from the origin

Output:

  • This computes the total length along the line, where every point on the line is assigned the density from the nearest point (Voronoi segmentation).

  • From distance 0 or another chosen minimal distance (or multiple).

Method:

  • Segmentation of the line where points become equi-distant. Performs approximately linearly with number of points.

Grid cutting

Input:

  • 3D Grid with densities at each location

  • One or more arbitrary lines from a point

Output:

  • This computes the total length along the line, where every point on the line is assigned the density from the grid cell it passes through.

  • From distance 0 or another chosen minimal distance (or multiple).

Method:

  • Finding intersections of the cell borders (planes) with the lines, and checking which cell to consider next.

Usage

To use from Python, use raytrace.py:

from lightrayrider import *

You can find the declaration of how to call these functions on the `API documentation page <https://johannesbuchner.github.io/LightRayRider/modules.html>`.

Essentially, pass the coordinates of your objects, the associated densities and the starting point and direction of your raytracing.

Example usage is demonstrated in irradiate.py. This was used for Illustris and EAGLE particle in the associated paper. There are additional unit test examples in test/.

Parallel processing

LightRayRider supports multiple processors through OpenMP. Set the variable OMP_NUM_THREADS to the number of processors you want to use, and the parallel library ray-parallel.so will be loaded.

License and Acknowledgements

If you use this code, please cite “Galaxy gas as obscurer: II. Separating the galaxy-scale and nuclear obscurers of Active Galactic Nuclei”, by Buchner & Bauer (2017), https://arxiv.org/abs/1610.09380

Bibcode:

@ARTICLE{2017MNRAS.465.4348B,
   author = {{Buchner}, J. and {Bauer}, F.~E.},
    title = "{Galaxy gas as obscurer - II. Separating the galaxy-scale and nuclear obscurers of active galactic nuclei}",
  journal = {\mnras},
archivePrefix = "arXiv",
   eprint = {1610.09380},
 primaryClass = "astro-ph.HE",
 keywords = {dust, extinction, ISM: general, galaxies: active, galaxies: general, galaxies: ISM, X-rays: ISM},
     year = 2017,
    month = mar,
   volume = 465,
    pages = {4348-4362},
      doi = {10.1093/mnras/stw2955},
   adsurl = {http://adsabs.harvard.edu/abs/2017MNRAS.465.4348B},
  adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

The code is licensed under AGPLv3 (see LICENSE file).

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

lightrayrider-2.0.6.tar.gz (14.5 MB view details)

Uploaded Source

File details

Details for the file lightrayrider-2.0.6.tar.gz.

File metadata

  • Download URL: lightrayrider-2.0.6.tar.gz
  • Upload date:
  • Size: 14.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.3

File hashes

Hashes for lightrayrider-2.0.6.tar.gz
Algorithm Hash digest
SHA256 ce4939627178f79532b65cb8291f6bef7ff47fc281f40509f8c19dcb7f587244
MD5 56adb9acc062794eab6cd9656b6b6b17
BLAKE2b-256 b742ca4531ae73d9e469c2d6617c338a5a7d86bcf632132c1940bac7c2f1730e

See more details on using hashes here.

Supported by

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