Monitor Correction

Description

Corrects the data to the monitor counts. This plugin corrects data[0] from data[1] by dividing. We allow a scale and offset due to I18’s uncalibrated ic

Parameters

in_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description: A list of the dataset(s) to process.
    default: "['to_be_corrected', 'monitor']"

out_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description:
        summary: A list of the dataset(s) to create.
        verbose: A list of strings, where each string is a name to be assigned to a dataset output by the plugin. If there is only one input dataset and one output dataset and the list is left empty, the output will take the name of the input dataset. The length of the list is the number of output datasets created by the plugin.
    default: "[]"

nominator_scale:
    visibility: intermediate
    dtype: float
    description: a
    default: "1.0"

nominator_offset:
    visibility: intermediate
    dtype: float
    description: b
    default: "0.0"

denominator_scale:
    visibility: intermediate
    dtype: float
    description: c
    default: "1.0"

denominator_offset:
    visibility: intermediate
    dtype: float
    description: d
    default: "0.0"

pattern:
    visibility: intermediate
    dtype: str
    description: The pattern to apply to it.
    default: PROJECTION

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 MonitorCorrection

get_max_frames()

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

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