annotate mesmer.xml @ 1:02abff468d60 draft

planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 374e4528db4e3ce7984e2ed2c2bae55c19c17371
author goeckslab
date Thu, 10 Nov 2022 20:38:34 +0000
parents 53240d7c1fc5
children 187918c47051
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
1 <tool id="mesmer" name="Mesmer" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="19.01">
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
2 <description>Mesmer for whole-cell segmentation of multiplexed tissue imaging data</description>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
3
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
4 <macros>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
5 <import>macros.xml</import>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
6 </macros>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
7
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
8 <expand macro="requirements"/>
1
02abff468d60 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 374e4528db4e3ce7984e2ed2c2bae55c19c17371
goeckslab
parents: 0
diff changeset
9 <expand macro="stdio"/>
0
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
10 <expand macro="version_cmd"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
11
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
13 ln -s '$nuclear_image' 'input.tif' &&
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
14 @CMD_BEGIN@
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
15 --output-directory ./
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
16 --output-name 'mask.tif'
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
17 --nuclear-image 'input.tif'
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
18 --nuclear-channel $nuclear_channel
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
19 --compartment $compartment
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
20 --image-mpp $image_mpp
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
21 $squeeze
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
22
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
23 #if $membrane_select.membrane_segment == "True":
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
24 --membrane-image '$membrane_select.membrane_image'
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
25 --membrane-channel '$membrane_select.membrane_channel'
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
26 #end if
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
27 ]]></command>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
28
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
29 <inputs>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
30 <param name="nuclear_image" type="data" format="tiff, ome.tiff" label="Image containing the nuclear marker(s)"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
31 <param name="nuclear_channel" type="integer" value="0" label="The numerical index of the channel(s) from nuclear-image"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
32 <param name="compartment" type="select" label="Compartment for segmentation prediction: ">
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
33 <option selected="true" value="whole-cell">Whole cell</option>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
34 <option value="nuclear">Nuclear</option>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
35 </param>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
36 <param name="image_mpp" type="float" value="0.5" label="Resolution of the image in microns-per-pixel"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
37 <param name="squeeze" type="boolean" truevalue="--squeeze" falsevalue="" checked="false" label="Whether to np.squeeze the outputs before saving"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
38 <conditional name="membrane_select">
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
39 <param name="membrane_segment" type="select" label="Segment with Cell Membrane">
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
40 <option selected="True" value="False">No</option>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
41 <option value="True">Yes</option>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
42 </param>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
43 <when value="True">
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
44 <param name="membrane_image" type="data" format="tiff, ome.tiff" label="The path to an image containing the membrane marker(s)"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
45 <param name="membrane_channel" type="integer" value="0" label="The numerical index of the channel(s) from membrane-image"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
46 </when>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
47 <when value="False" />
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
48 </conditional>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
49 </inputs>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
50 <outputs>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
51 <data format="tiff" name="mask" from_work_dir="mask.tif" label="${tool.name} on ${on_string}: Mask"/>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
52 </outputs>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
53 <tests>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
54 <test>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
55 <param name="nuclear_image" value="test.tiff" />
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
56 <param name="compartment" value="nuclear" />
1
02abff468d60 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 374e4528db4e3ce7984e2ed2c2bae55c19c17371
goeckslab
parents: 0
diff changeset
57 <param name="membrane_segment" value="False" />
02abff468d60 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 374e4528db4e3ce7984e2ed2c2bae55c19c17371
goeckslab
parents: 0
diff changeset
58 <param name="image_mpp" value="0.65" />
0
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
59 <param name="squeeze" value="--squeeze" />
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
60 <output name="mask" ftype="tiff">
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
61 <assert_contents>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
62 <has_size value="360000" delta="1000" />
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
63 </assert_contents>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
64 </output>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
65 </test>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
66 </tests>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
67 <help><![CDATA[
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
68 ------
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
69 Mesmer
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
70 ------
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
71
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
72 **Mesmer** is a DeepCell application that uses a pre-trained model for predicting nuclear and whole cell segmentation from multiplex tissue data.
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
73
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
74 **Inputs**
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
75 1. a multiple tissue image that includes a nuclear marker and optionally cytoplasm/membrane markers
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
76
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
77 **Outputs**
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
78 1. the nuclear or whole cell segmentation mask
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
79 ]]></help>
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
80 <expand macro="citations" />
53240d7c1fc5 planemo upload for repository https://github.com/goeckslab/tools-mti/tree/main/tools/mesmer commit 5fb6aa9066c68d9972b3cc4be13503a952f952a5
goeckslab
parents:
diff changeset
81 </tool>