Savu Nexus Loader

Description

A class to load datasets, and associated metadata, from a Savu output nexus file. By default, the last instance of each unique dataset name will be loaded. Opt instead to load a subset of these datasets, or individual datasets by populating the parameters.

Parameters

preview:
    visibility: basic
    dtype: "[preview, dict{str:preview}, dict{}]"
    description: A slice list of required frames to apply to ALL datasets, else a dictionary of slice lists where the key is the dataset name.
    default:

datasets:
    visibility: basic
    dtype: "[list[],list[str]]"
    description: Override the default by choosing specific dataset(s) to load, by stating the NXdata name.
    default: "[]"

names:
    visibility: intermediate
    dtype: "[list[],list[str]]"
    description: Override the dataset names associated with the datasets parameter above.
    default: "[]"

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 SavuNexusLoader(name='SavuNexusLoader')

setup()

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).