Nuclear Physics Energy Spectra (NPESv2)

Type: object
JSON Schema to store nuclear physics spectrum data. Mostly used for gamma spectroscopy, but can be used for any kind of pulse height histogram data. No Additional Properties

root schemaVersion

Schema Version

Type: const
Version string of the JSON Schema used.Specific value: "NPESv2"

root data
Type: array of object
Array of data packages in order to store multiple spectra independently in the same file.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root data Data Package

Data Package

Type: object
One complete package of data that contains the spectrum and optionally device and sample info. No Additional Properties

root data Data Package deviceData
Type: object
Metadata and other information about the recording device.

root data Data Package deviceData deviceName
Type: string
The name of the recording device.
Example:

"RadiaCode-101"

root data Data Package deviceData softwareName
Type: string
The name of the software that is used for recording with some additional version information

Must be at least 1 characters long


Example:

"Gamma MCA 2023-01-22"

Additional Properties of any type are allowed.

root data Data Package deviceData additionalProperties
Type: object

root data Data Package sampleInfo
Type: object
All the data surrounding the sample itself.

root data Data Package sampleInfo name
Type: string
Name of the measured sample.

root data Data Package sampleInfo location
Type: string
Location where the sample was collected.

root data Data Package sampleInfo time
Type: stringFormat: date-time
Date and time when the sample was collected, ISO-formatted.
Example:

"2018-11-13T20:20:39+00:00"

root data Data Package sampleInfo weight
Type: number
Weight of the sample in grams; can be any float.

Value must be greater or equal to 0


Example:

25.1

root data Data Package sampleInfo volume
Type: number
Volume of the sample in cubic centimeters; can be any float.

Value must be greater or equal to 0


Example:

9.9

root data Data Package sampleInfo note
Type: string
Some other arbitrary notes on the sample.

Additional Properties of any type are allowed.

root data Data Package sampleInfo additionalProperties
Type: object

root data Data Package resultData
Type: object
The resulting measurement data from recording. No Additional Properties

root data Data Package resultData anyOf item 0
Type: object

The following properties are required:

  • energySpectrum
root data Data Package resultData anyOf item 1
Type: object

The following properties are required:

  • backgroundEnergySpectrum

root data Data Package resultData startTime
Type: stringFormat: date-time
Date and time of the recording start, ISO-formatted. Depends on 'endTime'!
Example:

"2018-11-13T20:20:39+00:00"

root data Data Package resultData endTime
Type: stringFormat: date-time
Date and time of the recording end, ISO-formatted. Depends on 'startTime'!
Example:

"2018-11-13T20:20:39+00:00"

root data Data Package resultData energySpectrum
Type: object
Contains all the data specific to the (background) energy spectrum. No Additional Properties

root data Data Package resultData energySpectrum numberOfChannels
Type: integer
The number of channels or bins in the histogram.

Value must be greater or equal to 1


Example:

4096

root data Data Package resultData energySpectrum energyCalibration
Type: object
All the data used for energy calibration of the spectrum. No Additional Properties

root data Data Package resultData energySpectrum energyCalibration polynomialOrder
Type: integer
Order of the polynomial used for calibration, e.g. order 2 for a + bx +cx^2., i.e. number of coefficients minus 1.

Value must be greater or equal to 1


Example:

2

root data Data Package resultData energySpectrum energyCalibration coefficients
Type: array of number
All the coefficients needed for the n-poly calibration, sorted from lowest to highest order.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root data Data Package resultData energySpectrum energyCalibration coefficients coefficients items
Type: number
An individual calibration coefficient; can be any float.

Example:

[
    -239,
    0.6,
    0.004
]

root data Data Package resultData energySpectrum validPulseCount
Type: integer
The number of total valid pulses in the spectrum, i.e. (total counts - invalid counts).

Value must be greater or equal to 1


Example:

1000

root data Data Package resultData energySpectrum measurementTime
Type: integer Default: 1
Total measurement time (duration) in seconds.

Value must be greater or equal to 1


Example:

60

root data Data Package resultData energySpectrum spectrum
Type: array of integer
The complete energy spectrum as an array of individual bins.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root data Data Package resultData energySpectrum spectrum spectrum items
Type: integer
A single histogram bin from the spectrum.

Value must be greater or equal to 0

root data Data Package resultData backgroundEnergySpectrum
Type: object
Contains all the data specific to the (background) energy spectrum.Same definition as energySpectrum