Multi Nxtomo Loader¶
Description¶
A class to load multiple scans in Nexus format into one dataset.
Parameters
preview:
visibility: basic
dtype: preview
description: A slice list of required frames.
default: "[]"
file_name:
visibility: basic
dtype: "[str,None]"
description: The shared part of the name of each file (not including .nxs).
default: None
dark:
visibility: basic
dtype: "[list[filepath, h5path, float], list[None, None, float]]"
description: Optional path to the dark field data file, nxs path and scale value.
default: "['None', 'None', 1]"
flat:
visibility: basic
dtype: "[list[filepath, h5path, float],list[None,None,float]]"
description: Optional path to the flat field data file, nxs path and scale value.
default: "['None', 'None', 1]"
range:
visibility: basic
dtype: "list[int,int]"
description: The start and end of file numbers
default: "[0, 10]"
angles:
visibility: basic
dtype: "[str, int, None]"
description: If this is 4D data stored in 3D then pass an integer value equivalent to the number of projections per 180 degree scan. If the angles parameter is set to None, then values from default dataset used.
default: None
name:
visibility: intermediate
dtype: str
description: The name assigned to the dataset.
default: tomo
data_path:
visibility: intermediate
dtype: h5path
description: Path to the data inside the file.
default: entry1/tomo_entry/data/data
stack_or_cat:
visibility: intermediate
dtype: str
description: Stack or concatenate the data (4D and 3D respectively)
default: stack
stack_or_cat_dim:
visibility: intermediate
dtype: int
description: Dimension to stack or concatenate.
default: "3"
axis_label:
visibility: intermediate
dtype: str
description: "New axis label, if required, in the form 'name.units'"
default: scan.number
Key
visibility: The visibility level of the parameter
dtype: The type of data
description: A short explanation of the parameter
default: The default value
options: A list of permitted values
dependency: The name of the parameter and value which this parameter depends upon
range: A guide for the range of the parameter
Citations
No citations
API
-
class
MultiNxtomoLoader
(name='MultiNxtomoLoader')[source] -
get_dark_flat_slice_list
(data_obj)[source]
-
setup
()[source] This method is first to be called after the plugin has been created. It determines input/output datasets and plugin specific dataset information such as the pattern (e.g. sinogram/projection).
-