KDTree.trace¶
- KDTree.trace(self, rays, omp=True)¶
This python method provides an easy interface to trace a number of Rays through the surface.
It packages all of the ray inputs and the required output arrays automatically and dispatches to the c version of the method for efficient computation. It then packages the output into the expected structured array.
This method also translates/rotates the rays into the tree frame first, for efficiency in tracing.
Parallel processing can be turned off by setting the omp flag to False
- Parameters:
rays (Rays) – The rays to trace to the surface
omp (bool) – A boolean flag specifying whether to use parallel processing (
True
) or not
- Returns:
A length n numpy array with a data type of
INTERSECT_DTYPE
- Return type:
np.ndarray