Mm Loader

Description

Testing the mmloader plugin

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: "[]"

dataset_names:
    visibility: basic
    dtype: "list[str, str, str, str]"
    description: "The names assigned to each dataset in the order [fluorescence, diffraction, absorption, monitor]"
    default: "['fluo', 'xrd', 'stxm', 'monitor']"

fluo_offset:
    visibility: basic
    dtype: float
    description: fluo scale offset.
    default: "0.0"

fluo_gain:
    visibility: intermediate
    dtype: float
    description: fluo gain
    default: "0.01"

calibration_path:
    visibility: basic
    dtype: "[None,str]"
    description: Path to the calibration file
    default: None

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

add_default_params(inst, name)

final_parameter_updates()

An opportunity to update the parameters after they have been set.

separate_params(name, keys)

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