Stage Motion

Description

A Plugin to calculate stage motion from motion positions.

Parameters

in_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description: Create a list of the dataset(s)
    default: "['pmean']"

out_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description: Create a list of the dataset(s)
    default: "['qmean']"

use_min_max:
    visibility: intermediate
    dtype: bool
    description: Also use the min and max datasets including all combinations of min, mean and max.
    default: "False"

extra_in_datasets:
    visibility: intermediate
    dtype: list
    description: The extra datasets to use as input for min and max.
    default: "['pmin', 'pmax']"

extra_out_datasets:
    visibility: intermediate
    dtype: list
    description: The extra datasets to use as output for min and max.
    default: "['qmin', 'qmax']"

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 StageMotion

MEAN_INDEX = 0

NUM_DATASETS = 1

NUM_OUTPUT_Q_VARS = 9

nInput_datasets()

The number of datasets required as input to the plugin

Returns

Number of input datasets

nOutput_datasets()

The number of datasets created by the plugin

Returns

Number of output datasets

post_process()

This method is called after the process function in the pipeline framework as a post-processing step. All processes will have finished performing the main processing at this stage.

Parameters

exp (experiment class instance) – An experiment object, holding input and output datasets

pre_process()

This method is called immediately after base_pre_process().

process_frames(data)

This method is called after the plugin has been created by the pipeline framework and forms the main processing step

Parameters

data (list(np.array)) – A list of numpy arrays for each input dataset.

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