...
| Item | Parameter name | Parameter format | Example(s) | Comment(s) | |
|---|---|---|---|---|---|
| Parameter value | Effect | ||||
| 1 | preview | [ind_0, ind_1,... ind_n] | [ ] | NxtomoLoader to load all n-dimensional data located at data_path. | Default value. |
| [:, :, :] | NxtomoLoader to load all 3d data located at data_path. | ||||
| [:, s, :] | NxtomoLoader to load from a given 3d dataset only the data of the s-th tomography slice. | This particular interpretation applies if data are laid out in the (angle-enumeration, image_height, image_width) format. | |||
| [p, :,:] | NxtomoLoader to load from a given 3d dataset only the data of the p-th sample projection. | This particular interpretation applies if data are laid out in the (angle-enumeration, image_height, image_width) format. | |||
| 2 | image_key_path | Mandatory dataset. | |||
| 3 | name | ||||
| 4 | 3d_to_4d | ||||
| 5 | flat | [<path-to-NeXus-file>, <path-to-dataset>, <exposure-time-compensation-factor>] | [/dls/i13/data/2018/cm123-4/raw/5.nxs, entry1/instrument/detector/pco1/data, 1.25] | NxtomoLoader to load flats from a dataset located at entry1/instrument/detector/pco1/data in a NeXus scan file named /dls/i13/data/2018/cm123-4/raw/5.nxs, and then to multiply their pixel values by 1.25 (to compensate for the flat-field exposure time being 0.8 times shorter than the sample-projection exposure time). | If <path-to-NeXus-file> is not None, then flats are loaded from a dataset found at <path-to-dataset> inside the NeXus file located on the file-system at <path-to-NeXus-file>, and their pixel values are then multiplied by <exposure-time-compensation-factor>. |
| 6 | data_path | Mandatory dataset | |||
| 7 | dark | [<path-to-NeXus-file>, <path-to-dataset>, <exposure-time-compensation-factor>] | [/dls/i13/data/2018/cm123-4/raw/6.nxs, entry1/instrument/detector/pco1/data, 1] | NxtomoLoader to load darks from a dataset located at entry1/instrument/detector/pco1/data in a NeXus scan file named /dls/i13/data/2018/cm123-4/raw/6.nxs, and then to multiply their pixel values by 1. | If <path-to-NeXus-file> is not None, then darks are loaded from a dataset found at <path-to-dataset> inside the NeXus file located on the file-system at <path-to-NeXus-file>, and their pixel values are then multiplied by <exposure-time-compensation-factor>. |
| 8 | angles | ||||
| 9 | ignore_flats | [ind_1, ind_2,... ind_m] | [1, r] | NxtomoLoader to ignore the initial and the r-th batch in a series of m batches of flats (each containing however many individual flat-field images). |
|
...