adding unsigned char and uint8_t as possible datatypes and fix bug where DType.Byte created an SChar, which is now verbose

Author: Felix Lehner

examples/python/example01.py

@@ -1,5 +1,7 @@
-from RadFiled3D.RadFiled3D import CartesianRadiationField, FieldStore, vec3, DType, StoreVersion
+from RadFiled3D.RadFiled3D import CartesianRadiationField, vec3, DType, StoreVersion
 from RadFiled3D.metadata.v1 import Metadata
+from RadFiled3D.utils import FieldStore
+import numpy as np
 
 ## See the C++ example for more details on the API usage
 ## Also the C++ docstrings are more detailed
@@ -58,26 +60,27 @@
     print(f"Unset data: {voxel.get_data()}")
 
     # Create the metadata object for this field
-    metadata = Metadata(
-        Metadata.Header.Simulation(
-            100,                            # Primary particles
-            "SomeGeometry",                 # Geometry
-            "PhysList",                     # Used physics list
-            Metadata.Header.XRayTube(       # X-Ray tube metadata
-                vec3(0.0, 0.0, 0.0),
-                vec3(0.0, 0.0, 0.0),
-                0.0,
-                "SomeTubeID"
-            )
-        ),
-        Metadata.Header.Software(           # Software metadata
-            "SomeSoftware",
-            "SomeVersion",
-            "SomeRepository",
-            "SomeCommitID",
-            "SomeDOI"                       # Optional DOI
-        )
-    )
+    metadata = Metadata.default()
+    # Fill the metadata with some example data
+    metadata.simulation.primary_particle_count = 100
+    metadata.simulation.geometry = "SomeGeometry"
+    metadata.simulation.physics_list = "PhysList"
+
+    # remember to always set the max_energy_eV before adding a spectrum
+    # set it to 10 keV max energy (important when setting the spectrum as it will be enforced to be below this value)
+    metadata.simulation.tube.max_energy_eV = 10 * 1e3
+    metadata.simulation.tube.radiation_origin = vec3(0.0, 0.0, 0.0)
+    metadata.simulation.tube.radiation_direction = vec3(0.0, -1.0, 0.0)
+    
+    spectrum = np.empty((10, 2))
+    spectrum[:, 0] = np.arange(10) * 1e3  # Energy in eV
+    spectrum[:, 1] = np.random.rand(10)    # Relative intensity
+    spectrum /= spectrum[:, 1].sum()  # Normalize the spectrum, else we will get an error on the next line
+    metadata.simulation.tube.spectrum = spectrum
+
+    print(f"Default SW-name: {metadata.software.name}")
+    metadata.software.version = "v0.1.0"
+    metadata.software.repository = "https://github.com/Centrasis/RadFiled3D"
 
     # Store the field and metadata to a file using the file version 1
     FieldStore.store(crf, metadata, "example01.rf3", StoreVersion.V1)

examples/python/example03.py

@@ -1,31 +1,46 @@
-from RadFiled3D.RadFiled3D import FieldStore, HistogramVoxel
+from RadFiled3D.RadFiled3D import FieldShape
 from plotly import graph_objects as go
 import numpy
 import sys
 from RadFiled3D.metadata.v1 import Metadata
+from RadFiled3D.utils import FieldStore
 
 
 # This file demonstrates how to load a radiation field files metadata and which information can be extracted from it.
 
 radiation_file = sys.argv[1]
 
-metadata: Metadata = FieldStore.load_metadata(radiation_file)
-energy_eV = metadata.get_header().simulation.tube.max_energy_eV
+metadata: Metadata = FieldStore.peek_metadata(radiation_file)
+metadata = FieldStore.load_metadata(radiation_file)
+energy_eV = metadata.simulation.tube.max_energy_eV
 print(f"Energy: {energy_eV / 1e3} keV")
-direction = metadata.get_header().simulation.tube.radiation_direction
+direction = metadata.simulation.tube.radiation_direction
 print(f"Direction: {direction}")
-origin = metadata.get_header().simulation.tube.radiation_origin
+origin = metadata.simulation.tube.radiation_origin
 print(f"Origin: {origin}")
-geometry = metadata.get_header().simulation.geometry
+geometry = metadata.simulation.geometry
 print(f"Geometry: {geometry}")
-particles = metadata.get_header().simulation.primary_particle_count
+particles = metadata.simulation.primary_particle_count
 print(f"Particles: {particles}")
 dyn_data_keys = metadata.get_dynamic_metadata_keys()
 print(f"Dynamic metadata keys: {dyn_data_keys}")
 simulation_duration_s = metadata.get_dynamic_metadata("simulation_duration_s").get_data()
 print(f"Simulation duration: {simulation_duration_s} s")
-tube_spectrum: HistogramVoxel = metadata.get_dynamic_metadata("tube_spectrum")
-print(f"Tube spectrum: {tube_spectrum.get_histogram()}")
+tube_spectrum = metadata.simulation.tube.spectrum
+print(f"Tube spectrum: {tube_spectrum}")
+shape_type = metadata.simulation.tube.field_shape
+print(f"Field shape type: {shape_type}")
+if shape_type == FieldShape.CONE:
+    opening_angle_deg = metadata.simulation.tube.opening_angle_deg
+    print(f"Opening angle: {opening_angle_deg} deg")
+elif shape_type == FieldShape.RECTANGLE:
+    extends_at_origin = metadata.simulation.tube.field_rect_dimensions_m
+    print(f"Field extends at origin: {extends_at_origin} m")
+elif shape_type == FieldShape.ELLIPSIS:
+    ellipsis_opening_angles = metadata.simulation.tube.field_ellipsis_opening_angles_deg
+    print(f"Field ellipsis opening angles: {ellipsis_opening_angles} deg")
+else:
+    print("Unknown field shape type")
 
 
 # plot tube spectrum

include/RadFiled3D/helpers/Typing.hpp

@@ -24,7 +24,8 @@ namespace RadFiled3D {
 			Vec4,
 			Hist,
 			UInt64,
-			UInt32
+			UInt32,
+			Byte
 		};
 
 		class Helper {

include/RadFiled3D/storage/FieldAccessor.hpp

@@ -43,7 +43,7 @@ namespace RadFiled3D {
 					: MemoryBlockDefinition(offset, size), dtype(dtype), elements_per_voxel(elements_per_voxel) {};
 
 				TypedMemoryBlockDefinition() : MemoryBlockDefinition() {
-					this->dtype = Typing::DType::Char;
+					this->dtype = Typing::DType::Byte;
 					this->elements_per_voxel = 0;
 				}