Downsample Filter

Description

A plugin to downsample and rescale data volume including options of flipping and rotating images

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

bin_size:
    visibility: basic
    dtype: int
    description: Bin Size for the downsample.
    default: "3"

mode:
    visibility: basic
    dtype: str
    description: "One of 'mean', 'median', 'min', 'max'."
    default: mean
    options: "['mean', 'median', 'min', 'max']"

pattern:
    visibility: basic
    dtype: str
    description: "One of 'PROJECTION' or 'SINOGRAM' or 'VOLUME_XZ'."
    default: PROJECTION
    options: "['PROJECTION', 'SINOGRAM', 'VOLUME_XZ']"

num_bit:
    visibility: basic
    dtype: int
    description: Bit depth of the rescaled data (8, 16 or 32).
    default: "32"
    options: "[8, 16, 32]"

flip_updown:
    visibility: basic
    dtype: bool
    description: Flip images up-down.
    default: "True"

flip_leftright:
    visibility: basic
    dtype: bool
    description: Flip images left-right.
    default: "False"

rotate_angle:
    visibility: basic
    dtype: "[float, str, list[float], dict{int:float}]"
    description: Rotate images by a given angle (Degree).
    default: "0.0"

max:
    visibility: basic
    dtype: "[None,float]"
    description: Global max for scaling.
    default: None

min:
    visibility: basic
    dtype: "[None,float]"
    description: Global min for scaling.
    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 DownsampleFilter

fix_transport()

get_min_and_max()

get_new_shape(full_shape, data)

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

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