subpixel_shift.rst

{% extends "plugin_template.rst" %}

{% block title %}Subpixel Shift{% endblock %}

{% block description %} A plugin to apply a sub-pixel correction to images. {% endblock %}

{% block parameter_yaml %}

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

x_shift:

visibility: basic dtype: float description: The shift in x for the output image in pixels. Positive values correspond to data being shifted towards larger indices. default: "0.0"

transform_module:

visibility: intermediate dtype: str description: The module to be used for image translation. Choose a method in the Skimage package or in the Scipy package. default: scipy options: "['scipy', 'skimage']"

{% endblock %}

{% block plugin_citations %}

No citations

{% endblock %}

{% block plugin_file %}../../../plugin_api/plugins.corrections.subpixel_shift.rst{% endblock %}