Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 1.97 KB

strip_background.rst

File metadata and controls

61 lines (48 loc) · 1.97 KB

{% extends "plugin_template.rst" %}

{% block title %}Strip Background{% endblock %}

{% block description %} 1D background removal. PyMca magic function {% 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: A list of the dataset(s) to process. default: "['in_datasets[0]', 'background']"

iterations:

visibility: basic dtype: int description: Number of iterations. default: "100"

window:

visibility: basic dtype: int description: Half width of the rolling window. default: "10"

SG_filter_iterations:

visibility: intermediate dtype: int description: How many iterations until smoothing occurs. default: "5"

SG_width:

visibility: intermediate dtype: int description: Whats the savitzgy golay window. default: "35"

SG_polyorder:

visibility: intermediate dtype: int description: Whats the savitzgy-golay poly order. default: "5"

{% endblock %}

{% block plugin_citations %}

No citations

{% endblock %}

{% block plugin_file %}../../../plugin_api/plugins.filters.strip_background.rst{% endblock %}