biswebnode/bin/bw_butterworthfilterimage.xml

A node.js implementation of BioImage Suite Web command line tools in Javascript and WebAssembly

<?xml version="1.0" encoding="utf-8"?>
<executable>
	<category>BisWEB</category>
	<title>Butterworth Filter Image</title>
	<description>This module performs temporal Butterworth filtering to an input image. This is performed separately for each voxel</description>
	<version>1.3.0b2</version>
	<documentation-url>https://bioimagesuiteweb.github.io/bisweb-manual</documentation-url>
	<license>GPL v2</license>
	<contributor>Zach Saltzman and Xenios Papademetris</contributor>

<acknowledgements>Funding for this work was provided by the NIH Brain Initiative under grant R24 MH114805.</acknowledgements>
	<parameters>
		<label>Standard</label>
		<description>Standard Parameters</description>
		<string-enumeration>
			<name>Type</name>
			<label>Type</label>
			<description>What type of filter to apply (low, band, or high)</description>
			<longflag>--type</longflag>
			<default>band</default>
			<element>low</element>
			<element>band</element>
			<element>high</element>
		</string-enumeration>
		<double>
			<name>Low Frequency</name>
			<label>Low Frequency</label>
			<description>Lowpass cutoff frequency of filter (in Hertz)</description>
			<longflag>--low</longflag>
			<default>0.1</default>
			<constraints>
				<minimum>0</minimum>
				<maximum>10</maximum>
			</constraints>
		</double>
		<double>
			<name>High Frequency</name>
			<label>High Frequency</label>
			<description>Highpass cutoff frequency of filter (in Hertz)</description>
			<longflag>--high</longflag>
			<default>0.01</default>
			<constraints>
				<minimum>0</minimum>
				<maximum>10</maximum>
			</constraints>
		</double>
		<double>
			<name>Sample Rate (TR)</name>
			<label>Sample Rate (TR)</label>
			<description>Data time of repetition (Data TR). If <0.0 use spacing from image header</description>
			<longflag>--tr</longflag>
			<default>-1</default>
			<constraints>
				<minimum>-1</minimum>
				<maximum>5</maximum>
			</constraints>
		</double>
	</parameters>
	<parameters advanced="true">
		<label>Advanced</label>
		<description>Advanced Parameters</description>
		<string-enumeration>
			<name>Remove Mean</name>
			<label>Remove Mean</label>
			<description>Remove Mean before high pass filtering</description>
			<longflag>--removemean</longflag>
			<default>true</default>
			<element>true</element>
			<element>false</element>
		</string-enumeration>
		<string-enumeration>
			<name>Debug</name>
			<label>Debug</label>
			<description>Toggles debug logging</description>
			<longflag>--debug</longflag>
			<default>false</default>
			<element>true</element>
			<element>false</element>
		</string-enumeration>
		<string-enumeration>
			<name>SlicerProgress</name>
			<label>SlicerProgress</label>
			<description>Enables progress xml outputs for Slicer</description>
			<longflag>--slicerprogress</longflag>
			<default>true</default>
			<element>true</element>
			<element>false</element>
		</string-enumeration>
	</parameters>
	<parameters>
		<label>Inputs</label>
		<description>Input Objects</description>
		<image fileExtensions=".nii.gz,.nii">
			<name>Input Image</name>
			<label>Input Image</label>
			<description>The filename for the image to be processed</description>
			<longflag>--input</longflag>
    			<channel>input</channel>
		</image>
	</parameters>
	<parameters>
		<label>Outputs</label>
		<description>Output Objects</description>
		<image fileExtensions=".nii.gz,.nii">
			<name>Output Image</name>
			<label>Output Image</label>
			<description>The output image filename</description>
			<longflag>--output</longflag>
    			<channel>output</channel>
		</image>
	</parameters>

</executable>