Mipmap

Description

A plugin to downsample multidimensional data successively by powers of 2. The output is multiple ‘mipmapped’ datasets, each a power of 2 smaller in each dimension than the previous dataset.

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: hidden
    dtype: "[list[],list[str]]"
    description: Hidden out_datasets list as this is created dynamically.
    default: "[]"

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

n_mipmaps:
    visibility: basic
    dtype: int
    description: The number of successive downsamples of powers of 2 (e.g. n_mipmaps=3 implies downsamples (of the original data) of binsize 1, 2 and 4 in each dimension).
    default: "3"

out_dataset_prefix:
    visibility: intermediate
    dtype: str
    description: The name of the dataset, to which the binsize will be appended for each instance.
    default: Mipmap

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 Mipmap

fix_transport()

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