Yaml Converter

Description

A class to load data from a non-standard nexus/hdf5 file using descriptions loaded from a yaml file.

Parameters

preview:
    visibility: basic
    dtype: preview
    description: A slice list of required frames.
    default: "[]"

yaml_file:
    visibility: basic
    dtype: "[None,yamlfilepath]"
    description: Path to the file containing the data descriptions.
    default: None

template_param:
    visibility: hidden
    dtype: "[str,dict]"
    description: A hidden parameter to hold parameters passed in via a savu template file.
    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 YamlConverter(name='YamlConverter')

get_description(entry, name, metadata=True)

set_data(name, entry)

setup(template=False, metadata=True)

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

update_value(dObj, value, itr=0)