Skip to content
Module for OSPRay that implements the "Particle K-D Trees" technique desribed in our 2015 IEEE Vis paper.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apps
ospray
sg
.gitignore
CMakeLists.txt
ColorMask.h
PKDConfig.h.in
README.md

README.md

OSPRay Particle-K-D Tree (PKD Tree) Module

This project is a module for the OSPRay ray tracer (http://www.ospray.org) that implements the Particle K-D Tree Technique as described in the paper I. Wald, A. Knoll, G. P. Johnson, W. Usher, V. Pascucci, M. E. Papka. “CPU Ray Tracing Large Particle Data using Particle K-D Trees,” IEEE Visweek, 2015.

This code was mostly authored by Ingo Wald and Aaron Knoll (with help by several others); this code is experimental, and is hereby release without any warranty (implied or expressed) as to correctness, performance, etcpp.

Building the PKD Tree module

To build the PKD module, you first have to have a version of OSPRay in source. Let us assume that you have already checked that out (into ~/Projects/ospray), that you already have created a cmake build directory (say, in ~/Projects/ospray/build), and that you have already properly configured and built ospray.

Now, first go to ospray's module subdirectory, and check out the pkd module into this directory:

cd ~/Projects/ospray/modules
git clone <this module>

Now, go into your ospray build directory, do a 'ccmake', enable the pkd module, and rebuild

cd ~/Projects/ospray/build
ccmake .
# enable PKD module in cmake dialog, then 'c'onfigure and 'g'enerate
make

You should now have a properly built libospray_module_pkd.so, as well as a ospPartiKD binary.

Building for LiDAR Data

To build the PKD module for LiDAR data you'll need LAStools to read LAS and LAZ files, then can enable OPTION_MODULE_PARTIKD_LIDAR in CMake. If LAStools is installed in some non-standard location you can pass -DLASTOOLS=<path to LAStools root>. Warning: This will break support for any non-LiDAR data due to how the attributes are handled.

Using the PKD Module

Once built, using the PKD module consists of two steps:

  1. converting a particle model to pkd format

  2. rendering the resulting pkd file with ospray's sample qt viewer

1) Converting a particle model to pkd format

To convert a particle model to our internal format (which includes building the tree), you use the ospPartiKD tool. PartiKD supports several file format (TODO: more doc needed here!), and is run as follows:

./ospPartiKD <inputFile> --radius <particleRadius> -o outFileName.pkd

Example: To convert the cosmic web particle data set I use

./ospPartiKD ~/cosmic_web/6k-cubed/0.000/particles/0.000xv00*dat --radius 1 -o ~/scratch/cosmic_web.pkd

This step should create two files: a cosmic_web.pkd, and a cosmic_web.pkdbin

2) Rendering a pkd file

Given a ".pkd" file (assuming ~/scratch/cosmic_web.pkd) you can render this with the ospray qt modelviewer as follows:

./ospQTViewer --module pkd ~/scratch/cosmic_web.pkd

Make sure you specify the "--module pkd", as this is required for the QT viewer to recognize the respective PKD scene graph nodes contained in the ".pkd" file.

Assuming you have an mpi install ready, can also run that mpi-parallel via

mpirun -perhost 1 -np <numprocs> -f <hostsfile> ./ospQTViewer --module pkd ~/scratch/cosmic_web.pkd --osp:mpi

More Information:

You can’t perform that action at this time.