biswebnode/bin/bw_maskimage.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>Mask Image</title>
	<description>This algorithm masks an image using an image mask. In regions where the mask is below a threshold, the image values are set to zero, else they maintain their original values</description>
	<version>1.3.0b2</version>
	<documentation-url>https://bioimagesuiteweb.github.io/bisweb-manual</documentation-url>
	<license>GPL v2</license>
	<contributor>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>
		<double>
			<name>Threshold</name>
			<label>Threshold</label>
			<description>The threshold (applied to the mask image) below which values in the input image will be masked out</description>
			<longflag>--threshold</longflag>
			<default>1</default>
		</double>
		<string-enumeration>
			<name>Inverse</name>
			<label>Inverse</label>
			<description>If true, mask the image where the mask is not zero</description>
			<longflag>--inverse</longflag>
			<default>false</default>
			<element>true</element>
			<element>false</element>
		</string-enumeration>
		<string-enumeration>
			<name>Minvalue</name>
			<label>Minvalue</label>
			<description>If true the masked output image regions will have value equal to the minimum intensity of the image, instead of zero</description>
			<longflag>--minvalue</longflag>
			<default>true</default>
			<element>true</element>
			<element>false</element>
		</string-enumeration>
	</parameters>
	<parameters advanced="true">
		<label>Advanced</label>
		<description>Advanced Parameters</description>
		<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 image to mask</description>
			<longflag>--input</longflag>
    			<channel>input</channel>
		</image>
		<image fileExtensions=".nii.gz,.nii">
			<name>Mask Image</name>
			<label>Mask Image</label>
			<description>The mask</description>
			<longflag>--mask</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>