Vo Centering¶

Description¶

A plugin to calculate the centre of rotation using the Vo method

Plugin documention and guidelines on use

Parameters

in_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description:
        summary: A list of the dataset(s) to process.
        verbose: A list of strings, where each string gives the name of a dataset that was either specified by a loader plugin or created as output to a previous plugin.  The length of the list is the number of input datasets requested by the plugin.  If there is only one dataset and the list is left empty it will default to that dataset.
    default: "[]"

out_datasets:
    visibility: datasets
    dtype: "[list[],list[str]]"
    description: The default names
    default: "['cor_preview', 'cor_broadcast']"

preview:
    visibility: basic
    dtype: preview
    description: A slice list of required frames (sinograms) to use in the calculation of the centre of rotation (this will not reduce the data size for subsequent plugins).
    default: "[]"
    example: "The typical three dimensional data structure is [angles, detY, detZ], e.g. for sinogram choose [:,sliceNo,:] [angles, detZ, detY]. If the data is four dimensional, include a time parameter."

start_pixel:
    visibility: intermediate
    dtype: "[int,None]"
    description: The estimated centre of rotation. If value is None, use the horizontal centre of the image.
    default: None

search_area:
    visibility: basic
    dtype: "list[float,float]"
    description: Search area around the estimated centre of rotation
    default: "[-50, 50]"

ratio:
    visibility: intermediate
    dtype: float
    description: The ratio between the size of a sample and the field of view of a camera
    default: "0.5"

search_radius:
    visibility: intermediate
    dtype: int
    description: Use for fine searching
    default: "6"

step:
    visibility: intermediate
    dtype: float
    description: Step of fine searching
    default: "0.5"

datasets_to_populate:
    visibility: intermediate
    dtype: "[list[],list[str]]"
    description: A list of datasets which require this information
    default: "[]"

broadcast_method:
    visibility: advanced
    dtype: str
    options: "['median', 'mean', 'nearest', 'linear_fit']"
    description:
        summary: Method of broadcasting centre values calculated from preview slices to full dataset.
        options:
            median: None
            mean: None
            nearest: None
            linear_fit: None
    default: median

row_drop:
    visibility: advanced
    dtype: int
    description: Drop lines around vertical center of the mask
    default: "20"

average_radius:
    visibility: advanced
    dtype: int
    description: Averaging sinograms around a required sinogram to improve signal-to-noise ratio
    default: "5"

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