Provenance Fields

Overview of provenance attributes collected:

Field superficial transformed PAR-REC DICOM FIF CNT
path yes yes yes yes yes yes
hostname yes yes yes yes yes yes
user yes yes yes yes yes yes
location yes yes yes yes yes yes
added yes yes yes yes yes yes
version-added yes yes yes yes yes yes
size yes yes yes yes yes yes
hash yes yes yes yes yes yes
created yes yes yes yes yes yes
transient yes yes yes yes yes yes
modality yes inherited yes yes yes yes
acquired   inherited yes yes yes yes
duration   inherited yes yes yes yes
subject   inherited yes yes yes yes
dimensions     yes maybe yes yes
project   inherited     yes  
protocol   inherited yes yes    
subject-position   inherited yes yes    
water-fat-shift   inherited yes yes    
transformation   yes        
parent   yes        
code   yes        
logtext   yes        
script   yes        
args   yes        
kwargs   yes        
sampling-frequency   inherited     yes yes
fif-type         yes  
lowpass         yes  
highpass         yes  
bad-channels         yes  
projection-description         yes  
seriesuid       yes    
filesInSeries       yes    
technique   inherited yes      
repetition-time   inherited yes      
field-of-view     yes      
epi-factor   inherited yes      
magnetization-transfer-contrast   inherited yes      
diffusion   inherited yes      
slice-thickness     yes      
slice-orientation     yes      
echo-time   inherited yes      
flip-angle   inherited yes      
inversion-time   inherited yes      

path

The last known path to the file.

hostname

Hostname of the computer on which the file resides.

user

Name of the user that created the file and/or registered its provenance.

location

A string that combines computer and filesystem path.

added

Date and time that the provenance for this file was registered.

version-added

A floating point number reflecting the niprov version used to create the provenance record.

size

File size.

hash

An MD5 hash of the file’s binary contents.

created

Last known modified date of the file as reported by the OS.

transient

Whether the file is deemed temporary.

modality

Type of data; MRI, DWI, MEG, EEG or other.

acquired

When the data was collected.

duration

Duration of the acquisition in seconds.

subject

The participant whose brain was imaged.

dimensions

Dimensions of the image. Order of dimensions dependent on format; in principle follows (where applicable); in-slice, number of slices, time. E.g. x,z,y,t.

project

The name of the research project.

protocol

The name of the pulse sequence used.

subject-position

The position and orientation of the subject during during the scan. E.g. head first supine.

water-fat-shift

Water fat shift value.

transformation

The name of the transformation applied to generate this derivative image.

parent

The file that this file is a transformed version of.

code

The command used to generate this image.

logtext

The commandline output of the transformation.

script

The path to the code file containing the transformation routine.

args

The positional arguments passed to a python-based transformation command.

kwargs

The keyword arguments passed to a python-based transformation command.

sampling-frequency

How many samples were acquired per second.

fif-type

Type of MNE fiff file. One of ‘raw’, ‘ave’, ‘epo’, ‘cov’, ‘fwd’ or ‘trans’.

lowpass

Cutoff frequency of the lowpass filter applied, in Hz.

highpass

Cutoff frequency of the highpass filter applied, in Hz.

bad-channels

Names of channels/sensors marked as bad.

projection-description

Description of projection vectors in the data file.

seriesuid

A unique identifier for files in a series. Corresponds to SeriesInstanceUID in the DICOM format.

filesInSeries

A list of paths to files that are part of this series.

technique

The imaging technique that the protocol uses.

repetition-time

Time to scan one volume

field-of-view

The extent of the observable world that is seen by the image. This is a list of three values.

epi-factor

Echo-planar-imaging factor.

magnetization-transfer-contrast

A technique that uses the transfer of nuclear spin polarization and/or spin coherence from one population of nuclei to another population of nuclei.

diffusion

Whether this is a diffusion image. Boolean.

slice-thickness

Thickness in mm of the slices. In case the file contains multiple images, this applies to the first image.

slice-orientation

Spatial orientation of the slices. In case the file contains multiple images, this applies to the first image.

echo-time

The time in milliseconds between the application of the 90° pulse and the peak of the echo signal in Spin Echo and Inversion Recovery pulse sequences.

flip-angle

The angle to which the net magnetization is rotated or tipped relative to the main magnetic field direction via the application of an RF excitation pulse.

inversion-time

The time period between the 180° inversion pulse and the 90° excitation pulse in an Inversion Recovery pulse sequence.