Octree structure containing a 3D triangular mesh model. To be used for ray tracing / shadow casting.
Written in C++ for speed, but exposed to Python using Cython.
Details
Pyoctree uses an adaptive structure, so it will automatically divide branches to ensure that there are no more than 200 objects per leaf.
Requirements
Python 2.7 or Python >= 3.5
Optional
vtk >= v6.2.0 or >= v7.0 (for outputting a vtk file for viewing octree structure in Paraview)
A C++ compiler for building the extension module from the provided cpp file (already cythonized). Suggested compilers are: - The Microsoft C++ Compiler for Python 2.7 if using Python 2 on Windows - Microsoft Visual C++ 2015 (14.0) if using Python 3 on Windows - gcc on Linux - Mingw32 on Windows or Linux
Cython >= v0.20 and a C++ compiler to build from source
Note that a compiler is not required if installing using the provided Python wheel.
Installation
Intersection testing uses parallel processing via OpenMP. To use more than a single processor, use the provided Python wheel or compile from source using a compiler that supports OpenMP. Then set value of environment variable OMP_NUM_THREADS to the number of desired processors.
Note that the compilers provided by the Anaconda Python distribution do not support OpenMP.
1. Building from source
To compile without OpenMP, open a command prompt, browse to the base directory containing the setup.py file and type:
python setup.py installTo compile with OpenMP, open a command prompt, browse to the base directory containing the setup.py file and type:
python setup.py install --openmp2. Installation using Python wheel
Download the python wheel from releases i.e. pyoctree-0.2.10-cp36-cp36m-win_amd64.whl for Python 3.6 on Windows 64-bit. Then, open a command prompt, browse to the download directory and type:
pip install pyoctree-0.2.10-cp36-cp36m-win_amd64.whlNote that Python wheels have been built with OpenMP.
Usage
1. Creating the octree representation of a 3D triangular mesh model
from pyoctree import pyoctree as ot
tree = ot.PyOctree(pointCoords,connectivity)where:
pointCoords is a Nx3 numpy array of floats (dtype=float) representing the 3D coordinates of the mesh points
connectivity is a Nx3 numpy array of integers (dtype=np.int32) representing the point connectivity of each tri element in the mesh
2. Finding intersection between mesh object and ray
The octree can be used to quickly find intersections between the object and a ray. For example:
import numpy as np
startPoint = [0.0,0.0,0.0]
endPoint = [0.0,0.0,1.0]
rayList = np.array([[startPoint,endPoint]],dtype=np.float32)
intersectionFound = tree.rayIntersection(rayList)Examples
Some Jupyter notebooks are provided in the Examples directory on how to use pyoctree.
Help
If help is required, please create an issue on Github.
1 maintainer
Metadata
1 maintainer
Release files for pyoctree 0.2.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyoctree-0.2.10.tar.gz | 2.3 MB | Without provenance | Details for pyoctree-0.2.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyoctree-0.2.10-cp36-cp36m-win_amd64.whl | CPython 3.6 | CPython 3.6 pymalloc | Windows x86-64 | Details for pyoctree-0.2.10-cp36-cp36m-win_amd64.whl |
Total release size: 4.7 MB
Release files / pyoctree-0.2.10.tar.gz
| Download URL | pyoctree-0.2.10.tar.gz |
|---|---|
| Size | 2.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d3654cdabe0b3bf418056f5c5fccf5618a69524a9602d332bdbb00bcd04cdbda
|
|
BLAKE2b-256 checksum How to use checksums |
ffb90000bafc6e857d0ee771b6b064e0b5933f16ab486d6439fadb773c976719
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3
|
Release files / pyoctree-0.2.10-cp36-cp36m-win_amd64.whl
| Download URL | pyoctree-0.2.10-cp36-cp36m-win_amd64.whl |
|---|---|
| Size | 2.4 MB |
| Tags | CPython 3.6 CPython 3.6 pymalloc Windows x86-64 |
|
SHA-256 checksum How to use checksums |
67ad5e7f709f5ba01d5268dd74db3d1758a47c761c46077ffe550a5debe925d4
|
|
BLAKE2b-256 checksum How to use checksums |
4b878d457f93026861c0e1926152b9f01e0a7b096fc469a04583d2a91db31d2e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3
|
Security for pyoctree 0.2.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
