Skip to content

Latest commit

 

History

History
45 lines (35 loc) · 1.74 KB

File metadata and controls

45 lines (35 loc) · 1.74 KB

{% extends "plugin_template.rst" %}

{% block title %}Spectrum Crop{% endblock %}

{% block description %} Crops a spectrum to a range {% 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: "[]"

crop_range:

visibility: intermediate dtype: list description: Range to crop to. default: "[2.0, 18.0]"

axis:

visibility: intermediate dtype: str description: Axis. default: energy

{% endblock %}

{% block plugin_citations %}

No citations

{% endblock %}

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