Skip to content

Advanced Radiograph (Format Specification)

Legend

Bolded datasets / attributes are required to meet the format spec. Italicized are optional.

HDF5 Datasets

Name Description Array Shape Units
image Radiograph image M x N pixel counts
X X position of pixel centers (radiograph coordinate system1) M x N meters
Y Y position of pixel centers (radiograph coordinate system1) M x N meters
T Change-of-basis matrix (a.k.a. transition matrix) to move from x, y, z radiograph coordinate system1 to x', y', z' global coordinate system of the target chamber. [x' y' z'] = T [x y z]. 3 x 3

HDF5 Attributes

Name Description Example Units
object_type Specification of the HDF5 object type "radiograph" (always this value)
radiograph_type Specification of the radiograph sub-type "advanced" (always this value)
pradformat_version HDF5 pradformat file format version followed (see above for current version) "0.1.0"
pixel_width Physical pixel width / bin width, for the first image axis 2.50E-05 meters
pixel_width_ax2 Physical pixel width / bin width, for the second image axis (not needed if using square pixels) 2.50E-05 meters
source_object_dist Approximate distance from the particle source to the object plane (the E & M structures). Used to estimate image magnification. 0.11 meters
object_image_dist Approximate distance from the object plane (the E & M structures) to the image plane (the radiograph). Used to estimate image magnification. 1.43 meters
source_radius Approximate characteristic radius of the particle source (set as zero for a point source). Helpful in estimating image resolution. 5.0e-5 meters
label Short, identifying label for this file (with no spaces or crazy characters). This can be stamped onto plots, etc. "Feb21_shot3_layer2"
description Longer description of this file. This can be read by people trying to figure out where this file came from. "RCF radiograph (layer2) from shot 3 on the February 2021 OMEGA-EP DISC run. Based on the RCF scan "20210231-02.tiff". Sensitivities are based on March 2021 Geant4 modeling performed by Samantha. Rotated and cropped, ready to feed into inversion algorithms."
experiment_date Date of the experiment (or synthetic particle tracing), in the format "YYYY-MM-DD". "2021-02-29"
file_date Date this file was created, in the format "YYYY-MM-DD" "2021-04-06"
raw_data_filename Filename of the raw data file (e.g. CSV from MIT, Tiff from scanner, etc) from which this derivative file was created, if applicable. "20210231-02.tiff"

HDF5 Groups

Name Description
sensitivity1 Sensitivity data for a first particle species
sensitivity2 Sensitivity data for a second particle species
sensitivity3 Sensitivity data for a third particle species
.... ....
sensitivityN Sensitivity data for an Nth particle species

HDF5 Datasets within each "sensitivityN" group

Name Description Array Shape Units
energies Particle energy represented by each element of the scale_factors array n eV
scale_factors Multipliers to convert pixel counts into particle counts (wrapping in the effects of all prior layers in the detector stack) n or n x M x N particles / pixel count
prescale_factors Pre-multipliers by which to adjust the scale factors (e.g. a fudge factor to adjust for RCF batch-to-batch sensitivity differences unrelated to stopping distance) n or n x M x N none

HDF5 Attributes within each "sensitivityN" group

Name Description Example Units
group_type Specification of the HDF5 group type "sensitivity" (always this value)
spec_name Shortname for the particle species (for this group)2 "p+"
spec_mass Particle mass (for this group) 1.67E-27 kilograms
spec_charge Particle charge (for this group) 1.60E-19 Coulombs

Footnotes


  1. The convention of this format is that the image lies in the z=0 plane of the radiograph coordinate system, and that the z-axis will point towards the particle source. The image may be stored already cropped and rotated by any angle within the x-y radiograph coordinate system, which is why X and Y are specified as arrays rather than vectors. ↩↩↩

  2. For best compatibility, consider using the PlasmaPy particle symbol conventions. For example, protons can be specified as just “p+”, and electrons by "e-". Any arbitrary isotope of Hydrogen can be specified “ H-I q+” where I is the mass number and q is the charge. ↩