Skip to content

Commit

Permalink
docs(master): Update docs of development line
Browse files Browse the repository at this point in the history
  • Loading branch information
nipreps-bot committed Oct 3, 2024
1 parent 47ab5c0 commit 1f28111
Show file tree
Hide file tree
Showing 15 changed files with 70 additions and 21 deletions.
Binary file modified master/_images/sdcflows-workflows-apply-registration-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 15 additions & 2 deletions master/_modules/sdcflows/workflows/apply/registration.html
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,8 @@ <h1>Source code for sdcflows.workflows.apply.registration</h1><div class="highli
<span class="kn">from</span> <span class="nn">packaging.version</span> <span class="kn">import</span> <span class="n">parse</span> <span class="k">as</span> <span class="n">parseversion</span><span class="p">,</span> <span class="n">Version</span>
<span class="kn">from</span> <span class="nn">niworkflows.interfaces.fixes</span> <span class="kn">import</span> <span class="n">FixHeaderRegistration</span> <span class="k">as</span> <span class="n">Registration</span>

<span class="kn">from</span> <span class="nn">sdcflows.interfaces</span> <span class="kn">import</span> <span class="n">brainmask</span>

<span class="n">workflow</span> <span class="o">=</span> <span class="n">Workflow</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
<span class="n">workflow</span><span class="o">.</span><span class="n">__desc__</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;</span><span class="se">\</span>
<span class="s2">The estimated *fieldmap* was then aligned with rigid-registration to the target</span>
Expand All @@ -423,6 +425,11 @@ <h1>Source code for sdcflows.workflows.apply.registration</h1><div class="highli
<span class="n">name</span><span class="o">=</span><span class="s2">&quot;outputnode&quot;</span><span class="p">,</span>
<span class="p">)</span>

<span class="c1"># Dilate only for coregistration purposes</span>
<span class="c1"># https://github.com/nipreps/sdcflows/issues/461</span>
<span class="n">dilate_target_mask</span> <span class="o">=</span> <span class="n">pe</span><span class="o">.</span><span class="n">Node</span><span class="p">(</span><span class="n">brainmask</span><span class="o">.</span><span class="n">BinaryDilation</span><span class="p">(</span><span class="n">radius</span><span class="o">=</span><span class="mi">5</span><span class="p">),</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;dilate_target_mask&quot;</span><span class="p">)</span>
<span class="n">dilate_fmap_mask</span> <span class="o">=</span> <span class="n">pe</span><span class="o">.</span><span class="n">Node</span><span class="p">(</span><span class="n">brainmask</span><span class="o">.</span><span class="n">BinaryDilation</span><span class="p">(</span><span class="n">radius</span><span class="o">=</span><span class="mi">5</span><span class="p">),</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;dilate_fmap_mask&quot;</span><span class="p">)</span>

<span class="c1"># Register the reference of the fieldmap to the reference</span>
<span class="c1"># of the target image (the one that shall be corrected)</span>
<span class="n">coregister</span> <span class="o">=</span> <span class="n">pe</span><span class="o">.</span><span class="n">Node</span><span class="p">(</span>
Expand All @@ -441,11 +448,17 @@ <h1>Source code for sdcflows.workflows.apply.registration</h1><div class="highli
<span class="c1"># fmt: off</span>
<span class="n">workflow</span><span class="o">.</span><span class="n">connect</span><span class="p">([</span>
<span class="p">(</span><span class="n">inputnode</span><span class="p">,</span> <span class="n">outputnode</span><span class="p">,</span> <span class="p">[(</span><span class="s2">&quot;fmap_coeff&quot;</span><span class="p">,</span> <span class="s2">&quot;fmap_coeff&quot;</span><span class="p">)]),</span>
<span class="p">(</span><span class="n">inputnode</span><span class="p">,</span> <span class="n">dilate_target_mask</span><span class="p">,</span> <span class="p">[(</span><span class="s2">&quot;target_mask&quot;</span><span class="p">,</span> <span class="s2">&quot;in_file&quot;</span><span class="p">)]),</span>
<span class="p">(</span><span class="n">inputnode</span><span class="p">,</span> <span class="n">dilate_fmap_mask</span><span class="p">,</span> <span class="p">[(</span><span class="s2">&quot;fmap_mask&quot;</span><span class="p">,</span> <span class="s2">&quot;in_file&quot;</span><span class="p">)]),</span>
<span class="p">(</span><span class="n">inputnode</span><span class="p">,</span> <span class="n">coregister</span><span class="p">,</span> <span class="p">[</span>
<span class="p">(</span><span class="s2">&quot;target_ref&quot;</span><span class="p">,</span> <span class="s2">&quot;moving_image&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;fmap_ref&quot;</span><span class="p">,</span> <span class="s2">&quot;fixed_image&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;target_mask&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;moving_image_mask</span><span class="si">{</span><span class="n">mask_trait_s</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;fmap_mask&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;fixed_image_mask</span><span class="si">{</span><span class="n">mask_trait_s</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">),</span>
<span class="p">]),</span>
<span class="p">(</span><span class="n">dilate_target_mask</span><span class="p">,</span> <span class="n">coregister</span><span class="p">,</span> <span class="p">[</span>
<span class="p">(</span><span class="s2">&quot;out_file&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;moving_image_mask</span><span class="si">{</span><span class="n">mask_trait_s</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="p">]),</span>
<span class="p">(</span><span class="n">dilate_fmap_mask</span><span class="p">,</span> <span class="n">coregister</span><span class="p">,</span> <span class="p">[</span>
<span class="p">(</span><span class="s2">&quot;out_file&quot;</span><span class="p">,</span> <span class="sa">f</span><span class="s2">&quot;fixed_image_mask</span><span class="si">{</span><span class="n">mask_trait_s</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="p">]),</span>
<span class="p">(</span><span class="n">coregister</span><span class="p">,</span> <span class="n">outputnode</span><span class="p">,</span> <span class="p">[</span>
<span class="p">(</span><span class="s2">&quot;warped_image&quot;</span><span class="p">,</span> <span class="s2">&quot;target_ref&quot;</span><span class="p">),</span>
Expand Down
Binary file modified master/api/sdcflows-workflows-apply-correction-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-apply-registration-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-apply-registration-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 53 additions & 17 deletions master/api/sdcflows-workflows-apply-registration-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified master/api/sdcflows-workflows-fit-fieldmap-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-fieldmap-2.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-fieldmap-3.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-pepolar-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-pepolar-2.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-syn-1.pdf
Binary file not shown.
Binary file modified master/api/sdcflows-workflows-fit-syn-2.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion master/api/sdcflows.config.html
Original file line number Diff line number Diff line change
Expand Up @@ -646,7 +646,7 @@ <h2>Other responsibilities<a class="headerlink" href="#other-responsibilities" t

<dl class="py attribute">
<dt class="sig sig-object py" id="sdcflows.config.execution.run_uuid">
<span class="sig-name descname"><span class="pre">run_uuid</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'20241003-144456_ac4792b7-5c2f-4cee-9be9-ad5ac775ff8b'</span></em><a class="headerlink" href="#sdcflows.config.execution.run_uuid" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">run_uuid</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'20241003-152636_b9fc67c4-8e4c-415f-af75-6dc00af975d5'</span></em><a class="headerlink" href="#sdcflows.config.execution.run_uuid" title="Link to this definition"></a></dt>
<dd><p>Unique identifier of this particular run.</p>
</dd></dl>

Expand Down
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 1f28111

Please sign in to comment.