Commit 11c5e9e7 authored by johannes.maul's avatar johannes.maul
Browse files

Update README.md

parent aabe418d
...@@ -15,7 +15,7 @@ e-mail: [johannes.maul@kit.edu](mailto:johannes.maul@kit.edu) ...@@ -15,7 +15,7 @@ e-mail: [johannes.maul@kit.edu](mailto:johannes.maul@kit.edu)
Interfaces:<br/> Interfaces:<br/>
nv_ray_tracing_basic: mex-interface for kernel call.<br/> nv_ray_tracing_basic: mex-interface for kernel call.
- Input: detectorPositionCoordinates: x,y,z coordinates of the detector as row vector. Format (n,3) where 1 = x, 2, = y, 3 = z and n diffrent detector positions<br/> - Input: detectorPositionCoordinates: x,y,z coordinates of the detector as row vector. Format (n,3) where 1 = x, 2, = y, 3 = z and n diffrent detector positions<br/>
faces: IDs of the vertices from triangle. IDs refer to nodes which have the proper coordinates. Both together create the surfaces. Faces also save the region. The region safes the material information. Format: (n,4)<br/> faces: IDs of the vertices from triangle. IDs refer to nodes which have the proper coordinates. Both together create the surfaces. Faces also save the region. The region safes the material information. Format: (n,4)<br/>
nodes: Coordinates for triangle vertices. Format (n,3) where 1 = x, 2, = y, 3 = z<br/> nodes: Coordinates for triangle vertices. Format (n,3) where 1 = x, 2, = y, 3 = z<br/>
...@@ -29,7 +29,7 @@ nv_ray_tracing_basic: mex-interface for kernel call.<br/> ...@@ -29,7 +29,7 @@ nv_ray_tracing_basic: mex-interface for kernel call.<br/>
//debugMiss would be possible //debugMiss would be possible
attenuationCalculationWrapper: should be called for proper Beer-Lambert-calculation, because kernel does not execute exponantiell function, because it just offers single precision.<br/> attenuationCalculationWrapper: should be called for proper Beer-Lambert-calculation, because kernel does not execute exponantiell function, because it just offers single precision.
- Input: detectorPositionCoordinates: equal to kernel nv_ray_tracing_basic<br/> - Input: detectorPositionCoordinates: equal to kernel nv_ray_tracing_basic<br/>
faces: equal to kernel nv_ray_tracing_basic<br/> faces: equal to kernel nv_ray_tracing_basic<br/>
nodes: equal to kernel nv_ray_tracing_basic<br/> nodes: equal to kernel nv_ray_tracing_basic<br/>
...@@ -42,14 +42,14 @@ attenuationCalculationWrapper: should be called for proper Beer-Lambert-calculat ...@@ -42,14 +42,14 @@ attenuationCalculationWrapper: should be called for proper Beer-Lambert-calculat
attenuationPicture: attenuation values in format of picutre. Picture has the same size as defined with detectorSizeUint<br/> attenuationPicture: attenuation values in format of picutre. Picture has the same size as defined with detectorSizeUint<br/>
easyExample: small example with projection image as result. It shows the process from voxel data to image. <br/> easyExample: small example with projection image as result. It shows the process from voxel data to image.
- Input: exampleType: string which example should be shown. "test", "easy", "real"<br/> - Input: exampleType: string which example should be shown. "test", "easy", "real"<br/>
buildDefault: is a build needed before? 0 = no build, 1 = build with default settings, see raytracingBuilderWrapper.<br/> buildDefault: is a build needed before? 0 = no build, 1 = build with default settings, see raytracingBuilderWrapper.<br/>
- Output: figure with projection pops up <br/> - Output: figure with projection pops up <br/>
raytracingBuilder: build for raytracing functions and shader. If vulkan is installed and the files has same relativ position, the build works from alone and raytracingBuilderWrapper can be used.<br/> raytracingBuilder: build for raytracing functions and shader. If vulkan is installed and the files has same relativ position, the build works from alone and raytracingBuilderWrapper can be used.
- Input: cSourceFilesPath <br/> - Input: cSourceFilesPath <br/>
cHeadersFilesPath <br/> cHeadersFilesPath <br/>
vulkanIncludePath <br/> vulkanIncludePath <br/>
...@@ -60,7 +60,7 @@ raytracingBuilder: build for raytracing functions and shader. If vulkan is insta ...@@ -60,7 +60,7 @@ raytracingBuilder: build for raytracing functions and shader. If vulkan is insta
- Output: generated files in the expected folder <br/> - Output: generated files in the expected folder <br/>
raytracingBuilderWrapper: starts raytracingBuilder with default settings. If vulkan is installed and the files has same relativ position, the build works from alone, else use raytracingBuilder and set parameters manually <br/> raytracingBuilderWrapper: starts raytracingBuilder with default settings. If vulkan is installed and the files has same relativ position, the build works from alone, else use raytracingBuilder and set parameters manually.
- Input: none <br/> - Input: none <br/>
- Output: generated files in the expected folder (equal to raytracingBuilder) <br/> - Output: generated files in the expected folder (equal to raytracingBuilder) <br/>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment