Skip to content

Commit d59ed4c

Browse files
author
GitHub Actions bot for SimpleITK.github.io
committed
Update Doxygen to
1 parent 9836001 commit d59ed4c

File tree

34 files changed

+509
-321
lines changed

34 files changed

+509
-321
lines changed

doxygen/latest/html/ImageGridManipulation_2ImageGridManipulation_8R-example.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,11 @@
153153
<div class="line">crop$SetLowerBoundaryCropSize( list(10, 10, 0) )</div>
154154
<div class="line">crop$SetUpperBoundaryCropSize( list(composed_image$GetWidth()-40, composed_image$GetHeight()-40, 1) )</div>
155155
<div class="line">cropped_image &lt;- crop$Execute(composed_image)</div>
156+
<div class="line"> </div>
157+
<div class="line"># Print image information to demonstrate variable usage</div>
158+
<div class="line">cat(&quot;Sliced image size:&quot;, sliced_image$GetWidth(), &quot;x&quot;, sliced_image$GetHeight(), &quot;x&quot;, sliced_image$GetDepth(), &quot;\n&quot;)</div>
159+
<div class="line">cat(&quot;Extracted image size:&quot;, extracted_image$GetWidth(), &quot;x&quot;, extracted_image$GetHeight(), &quot;x&quot;, extracted_image$GetDepth(), &quot;\n&quot;)</div>
160+
<div class="line">cat(&quot;Cropped image size:&quot;, cropped_image$GetWidth(), &quot;x&quot;, cropped_image$GetHeight(), &quot;x&quot;, cropped_image$GetDepth(), &quot;\n&quot;)</div>
156161
</div><!-- fragment --> </div><!-- contents -->
157162
<!-- HTML footer for doxygen 1.8.17-->
158163
<!-- start footer part -->

doxygen/latest/html/ImageGridManipulation_2ImageGridManipulation_8cs-example.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,11 @@
139139
<div class="line"> <a id="_a7" name="_a7"></a><a class="code hl_class" href="classitk_1_1simple_1_1ComposeImageFilter.html">ComposeImageFilter</a> compose = <span class="keyword">new</span> <a class="code hl_class" href="classitk_1_1simple_1_1ComposeImageFilter.html">ComposeImageFilter</a>();</div>
140140
<div class="line"> <a class="code hl_class" href="classitk_1_1simple_1_1Image.html">Image</a> composedImage = compose.<a id="a8" name="a8"></a><a class="code hl_function" href="classitk_1_1simple_1_1ComposeImageFilter.html#abc262b70f3d89a78c602558f43b1032b">Execute</a>(channel1Image, channel2Image, channel3Image);</div>
141141
<div class="line"> </div>
142+
<div class="line"> <span class="comment">// Select same subregion using image slicing operator</span></div>
143+
<div class="line"> VectorInt32 sliceStart = <span class="keyword">new</span> VectorInt32(<span class="keyword">new</span> <span class="keywordtype">int</span>[] { 10, 10, 0 });</div>
144+
<div class="line"> VectorInt32 sliceStop = <span class="keyword">new</span> VectorInt32(<span class="keyword">new</span> <span class="keywordtype">int</span>[] { 40, 40, 1 });</div>
145+
<div class="line"> <a class="code hl_class" href="classitk_1_1simple_1_1Image.html">Image</a> slicedImage = SimpleITK.Slice(composedImage, sliceStart, sliceStop);</div>
146+
<div class="line"> </div>
142147
<div class="line"> <span class="comment">// Select same subregion using ExtractImageFilter</span></div>
143148
<div class="line"> <a id="_a9" name="_a9"></a><a class="code hl_class" href="classitk_1_1simple_1_1ExtractImageFilter.html">ExtractImageFilter</a> extract = <span class="keyword">new</span> <a class="code hl_class" href="classitk_1_1simple_1_1ExtractImageFilter.html">ExtractImageFilter</a>();</div>
144149
<div class="line"> VectorUInt32 size = <span class="keyword">new</span> VectorUInt32(<span class="keyword">new</span> uint[] { 30, 30, 0 });</div>
@@ -147,6 +152,7 @@
147152
<div class="line"> extract.<a id="a11" name="a11"></a><a class="code hl_function" href="classitk_1_1simple_1_1ExtractImageFilter.html#a9c2c369c6748e429df71a7ab326c7d3b">SetIndex</a>(index);</div>
148153
<div class="line"> <a class="code hl_class" href="classitk_1_1simple_1_1Image.html">Image</a> extractedImage = extract.<a id="a12" name="a12"></a><a class="code hl_function" href="classitk_1_1simple_1_1ExtractImageFilter.html#a1f00871a1b260b2cd4fe6110e935f824">Execute</a>(composedImage);</div>
149154
<div class="line"> </div>
155+
<div class="line"> </div>
150156
<div class="line"> <span class="comment">// Select same sub-region using CropImageFilter (NOTE: CropImageFilter cannot</span></div>
151157
<div class="line"> <span class="comment">// reduce dimensions unlike ExtractImageFilter, so cropped_image is a three</span></div>
152158
<div class="line"> <span class="comment">// dimensional image with depth of 1)</span></div>
@@ -160,6 +166,13 @@
160166
<div class="line"> crop.<a id="a16" name="a16"></a><a class="code hl_function" href="classitk_1_1simple_1_1CropImageFilter.html#abdd4d4ed5eb89329787120b0bdd23d1d">SetLowerBoundaryCropSize</a>(lowerBoundary);</div>
161167
<div class="line"> crop.<a id="a17" name="a17"></a><a class="code hl_function" href="classitk_1_1simple_1_1CropImageFilter.html#a913b5c4a69271e054c31386e5b38feff">SetUpperBoundaryCropSize</a>(upperBoundary);</div>
162168
<div class="line"> <a class="code hl_class" href="classitk_1_1simple_1_1Image.html">Image</a> croppedImage = crop.<a id="a18" name="a18"></a><a class="code hl_function" href="classitk_1_1simple_1_1CropImageFilter.html#a03277b3a30741889649144c3b84d7709">Execute</a>(composedImage);</div>
169+
<div class="line"> </div>
170+
<div class="line"> Console.WriteLine(<span class="stringliteral">&quot;Sliced image size: {0}x{1}x{2}&quot;</span>,</div>
171+
<div class="line"> slicedImage.GetWidth(), slicedImage.GetHeight(), slicedImage.GetDepth());</div>
172+
<div class="line"> Console.WriteLine(<span class="stringliteral">&quot;Extracted image size: {0}x{1}x{2}&quot;</span>,</div>
173+
<div class="line"> extractedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">GetWidth</a>(), extractedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">GetHeight</a>(), extractedImage.<a id="a19" name="a19"></a><a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a0e9d6f84e457f7f6e59665c26a02cd4e">GetDepth</a>());</div>
174+
<div class="line"> Console.WriteLine(<span class="stringliteral">&quot;Cropped image size: {0}x{1}x{2}&quot;</span>,</div>
175+
<div class="line"> croppedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">GetWidth</a>(), croppedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">GetHeight</a>(), croppedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a0e9d6f84e457f7f6e59665c26a02cd4e">GetDepth</a>());</div>
163176
<div class="line"> }</div>
164177
<div class="line"> }</div>
165178
<div class="line">}</div>
@@ -174,6 +187,7 @@
174187
<div class="ttc" id="aclassitk_1_1simple_1_1ExtractImageFilter_html_a5f5b2d6a31f224d16a7cde118d97c6cc"><div class="ttname"><a href="classitk_1_1simple_1_1ExtractImageFilter.html#a5f5b2d6a31f224d16a7cde118d97c6cc">itk::simple::ExtractImageFilter::SetSize</a></div><div class="ttdeci">void SetSize(std::vector&lt; unsigned int &gt; Size)</div><div class="ttdoc">Set the size of the region to extract.</div><div class="ttdef"><b>Definition</b> <a href="sitkExtractImageFilter_8h_source.html#l00095">sitkExtractImageFilter.h:95</a></div></div>
175188
<div class="ttc" id="aclassitk_1_1simple_1_1ExtractImageFilter_html_a9c2c369c6748e429df71a7ab326c7d3b"><div class="ttname"><a href="classitk_1_1simple_1_1ExtractImageFilter.html#a9c2c369c6748e429df71a7ab326c7d3b">itk::simple::ExtractImageFilter::SetIndex</a></div><div class="ttdeci">void SetIndex(std::vector&lt; int &gt; Index)</div><div class="ttdoc">Set the starting index of the input image to extract.</div><div class="ttdef"><b>Definition</b> <a href="sitkExtractImageFilter_8h_source.html#l00113">sitkExtractImageFilter.h:113</a></div></div>
176189
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html">itk::simple::Image</a></div><div class="ttdoc">The Image class for SimpleITK.</div><div class="ttdef"><b>Definition</b> <a href="sitkImage_8h_source.html#l00076">sitkImage.h:77</a></div></div>
190+
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html_a0e9d6f84e457f7f6e59665c26a02cd4e"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html#a0e9d6f84e457f7f6e59665c26a02cd4e">itk::simple::Image::GetDepth</a></div><div class="ttdeci">unsigned int GetDepth() const</div></div>
177191
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html_a88a9572d84ae73623652bdc1ecb7cf2d"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">itk::simple::Image::GetHeight</a></div><div class="ttdeci">unsigned int GetHeight() const</div></div>
178192
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html_af7b9ca4a6cd1a0c77e8c5c713e447b3a"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">itk::simple::Image::GetWidth</a></div><div class="ttdeci">unsigned int GetWidth() const</div></div>
179193
<div class="ttc" id="aclassitk_1_1simple_1_1JoinSeriesImageFilter_html"><div class="ttname"><a href="classitk_1_1simple_1_1JoinSeriesImageFilter.html">itk::simple::JoinSeriesImageFilter</a></div><div class="ttdoc">Join N-D images into an (N+1)-D image.</div><div class="ttdef"><b>Definition</b> <a href="sitkJoinSeriesImageFilter_8h_source.html#l00052">sitkJoinSeriesImageFilter.h:52</a></div></div>

doxygen/latest/html/ImageGridManipulation_2ImageGridManipulation_8cxx-example.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,12 @@
153153
<div class="line"> crop.<a id="a16" name="a16"></a><a class="code hl_function" href="classitk_1_1simple_1_1CropImageFilter.html#a913b5c4a69271e054c31386e5b38feff">SetUpperBoundaryCropSize</a>({ composedImage.<a id="a17" name="a17"></a><a class="code hl_function" href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">GetWidth</a>() - 40, composedImage.<a id="a18" name="a18"></a><a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">GetHeight</a>() - 40, 1 });</div>
154154
<div class="line"> <a class="code hl_class" href="classitk_1_1simple_1_1Image.html">sitk::Image</a> croppedImage = crop.<a id="a19" name="a19"></a><a class="code hl_function" href="classitk_1_1simple_1_1CropImageFilter.html#a03277b3a30741889649144c3b84d7709">Execute</a>(composedImage);</div>
155155
<div class="line"> </div>
156+
<div class="line"> <span class="comment">// Print image information to demonstrate variable usage</span></div>
157+
<div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Extracted image size: &quot;</span> &lt;&lt; extractedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">GetWidth</a>() &lt;&lt; <span class="stringliteral">&quot;x&quot;</span> &lt;&lt; extractedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">GetHeight</a>() &lt;&lt; <span class="stringliteral">&quot;x&quot;</span></div>
158+
<div class="line"> &lt;&lt; extractedImage.<a id="a20" name="a20"></a><a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a0e9d6f84e457f7f6e59665c26a02cd4e">GetDepth</a>() &lt;&lt; std::endl;</div>
159+
<div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Cropped image size: &quot;</span> &lt;&lt; croppedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">GetWidth</a>() &lt;&lt; <span class="stringliteral">&quot;x&quot;</span> &lt;&lt; croppedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">GetHeight</a>() &lt;&lt; <span class="stringliteral">&quot;x&quot;</span></div>
160+
<div class="line"> &lt;&lt; croppedImage.<a class="code hl_function" href="classitk_1_1simple_1_1Image.html#a0e9d6f84e457f7f6e59665c26a02cd4e">GetDepth</a>() &lt;&lt; std::endl;</div>
161+
<div class="line"> </div>
156162
<div class="line"> <span class="keywordflow">return</span> 0;</div>
157163
<div class="line">}</div>
158164
<div class="ttc" id="aSimpleITK_8h_html"><div class="ttname"><a href="SimpleITK_8h.html">SimpleITK.h</a></div></div>
@@ -167,6 +173,7 @@
167173
<div class="ttc" id="aclassitk_1_1simple_1_1ExtractImageFilter_html_a5f5b2d6a31f224d16a7cde118d97c6cc"><div class="ttname"><a href="classitk_1_1simple_1_1ExtractImageFilter.html#a5f5b2d6a31f224d16a7cde118d97c6cc">itk::simple::ExtractImageFilter::SetSize</a></div><div class="ttdeci">void SetSize(std::vector&lt; unsigned int &gt; Size)</div><div class="ttdoc">Set the size of the region to extract.</div><div class="ttdef"><b>Definition</b> <a href="sitkExtractImageFilter_8h_source.html#l00095">sitkExtractImageFilter.h:95</a></div></div>
168174
<div class="ttc" id="aclassitk_1_1simple_1_1ExtractImageFilter_html_a9c2c369c6748e429df71a7ab326c7d3b"><div class="ttname"><a href="classitk_1_1simple_1_1ExtractImageFilter.html#a9c2c369c6748e429df71a7ab326c7d3b">itk::simple::ExtractImageFilter::SetIndex</a></div><div class="ttdeci">void SetIndex(std::vector&lt; int &gt; Index)</div><div class="ttdoc">Set the starting index of the input image to extract.</div><div class="ttdef"><b>Definition</b> <a href="sitkExtractImageFilter_8h_source.html#l00113">sitkExtractImageFilter.h:113</a></div></div>
169175
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html">itk::simple::Image</a></div><div class="ttdoc">The Image class for SimpleITK.</div><div class="ttdef"><b>Definition</b> <a href="sitkImage_8h_source.html#l00076">sitkImage.h:77</a></div></div>
176+
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html_a0e9d6f84e457f7f6e59665c26a02cd4e"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html#a0e9d6f84e457f7f6e59665c26a02cd4e">itk::simple::Image::GetDepth</a></div><div class="ttdeci">unsigned int GetDepth() const</div></div>
170177
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html_a88a9572d84ae73623652bdc1ecb7cf2d"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html#a88a9572d84ae73623652bdc1ecb7cf2d">itk::simple::Image::GetHeight</a></div><div class="ttdeci">unsigned int GetHeight() const</div></div>
171178
<div class="ttc" id="aclassitk_1_1simple_1_1Image_html_af7b9ca4a6cd1a0c77e8c5c713e447b3a"><div class="ttname"><a href="classitk_1_1simple_1_1Image.html#af7b9ca4a6cd1a0c77e8c5c713e447b3a">itk::simple::Image::GetWidth</a></div><div class="ttdeci">unsigned int GetWidth() const</div></div>
172179
<div class="ttc" id="aclassitk_1_1simple_1_1JoinSeriesImageFilter_html"><div class="ttname"><a href="classitk_1_1simple_1_1JoinSeriesImageFilter.html">itk::simple::JoinSeriesImageFilter</a></div><div class="ttdoc">Join N-D images into an (N+1)-D image.</div><div class="ttdef"><b>Definition</b> <a href="sitkJoinSeriesImageFilter_8h_source.html#l00052">sitkJoinSeriesImageFilter.h:52</a></div></div>

doxygen/latest/html/ImageGridManipulation_2ImageGridManipulation_8java-example.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,12 @@
159159
<div class="line"> crop.setLowerBoundaryCropSize(lowerBoundary);</div>
160160
<div class="line"> crop.setUpperBoundaryCropSize(upperBoundary);</div>
161161
<div class="line"> Image croppedImage = crop.execute(composedImage);</div>
162+
<div class="line"> </div>
163+
<div class="line"> <span class="comment">// Print image information to demonstrate variable usage</span></div>
164+
<div class="line"> System.out.println(<span class="stringliteral">&quot;Extracted image size: &quot;</span> + extractedImage.getWidth() + <span class="stringliteral">&quot;x&quot;</span> +</div>
165+
<div class="line"> extractedImage.getHeight() + <span class="stringliteral">&quot;x&quot;</span> + extractedImage.getDepth());</div>
166+
<div class="line"> System.out.println(<span class="stringliteral">&quot;Cropped image size: &quot;</span> + croppedImage.getWidth() + <span class="stringliteral">&quot;x&quot;</span> +</div>
167+
<div class="line"> croppedImage.getHeight() + <span class="stringliteral">&quot;x&quot;</span> + croppedImage.getDepth());</div>
162168
<div class="line"> }</div>
163169
<div class="line">}</div>
164170
</div><!-- fragment --> </div><!-- contents -->

doxygen/latest/html/ImageGridManipulation_2ImageGridManipulation_8py-example.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,11 @@
150150
<div class="line"><span class="lineno"> 67</span> [composed_image.GetWidth() - 40, composed_image.GetHeight() - 40, 1]</div>
151151
<div class="line"><span class="lineno"> 68</span>)</div>
152152
<div class="line"><span class="lineno"> 69</span>cropped_image = crop.Execute(composed_image)</div>
153+
<div class="line"><span class="lineno"> 70</span> </div>
154+
<div class="line"><span class="lineno"> 71</span><span class="comment"># Print image information to demonstrate variable usage</span></div>
155+
<div class="line"><span class="lineno"> 72</span>print(f<span class="stringliteral">&quot;Sliced image size: {sliced_image.GetWidth()}x{sliced_image.GetHeight()}x{sliced_image.GetDepth()}&quot;</span>)</div>
156+
<div class="line"><span class="lineno"> 73</span>print(f<span class="stringliteral">&quot;Extracted image size: {extracted_image.GetWidth()}x{extracted_image.GetHeight()}x{extracted_image.GetDepth()}&quot;</span>)</div>
157+
<div class="line"><span class="lineno"> 74</span>print(f<span class="stringliteral">&quot;Cropped image size: {cropped_image.GetWidth()}x{cropped_image.GetHeight()}x{cropped_image.GetDepth()}&quot;</span>)</div>
153158
<div class="ttc" id="aclassitk_1_1simple_1_1ComposeImageFilter_html"><div class="ttname"><a href="classitk_1_1simple_1_1ComposeImageFilter.html">itk::simple::ComposeImageFilter</a></div><div class="ttdoc">ComposeImageFilter combine several scalar images into a multicomponent image.</div><div class="ttdef"><b>Definition</b> <a href="sitkComposeImageFilter_8h_source.html#l00064">sitkComposeImageFilter.h:64</a></div></div>
154159
<div class="ttc" id="aclassitk_1_1simple_1_1CropImageFilter_html"><div class="ttname"><a href="classitk_1_1simple_1_1CropImageFilter.html">itk::simple::CropImageFilter</a></div><div class="ttdoc">Decrease the image size by cropping the image by an itk::Size at both the upper and lower bounds of t...</div><div class="ttdef"><b>Definition</b> <a href="sitkCropImageFilter_8h_source.html#l00046">sitkCropImageFilter.h:46</a></div></div>
155160
<div class="ttc" id="aclassitk_1_1simple_1_1ExtractImageFilter_html"><div class="ttname"><a href="classitk_1_1simple_1_1ExtractImageFilter.html">itk::simple::ExtractImageFilter</a></div><div class="ttdoc">Decrease the image size by cropping the image to the selected region bounds.</div><div class="ttdef"><b>Definition</b> <a href="sitkExtractImageFilter_8h_source.html#l00072">sitkExtractImageFilter.h:73</a></div></div>

0 commit comments

Comments
 (0)