Skip to content

Commit c9f4cfe

Browse files
author
GitHub Actions bot for SimpleITK.github.io
committed
Update Doxygen to
1 parent 086c5ee commit c9f4cfe

11 files changed

+980
-10
lines changed

doxygen/latest/html/DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html

Lines changed: 307 additions & 0 deletions
Large diffs are not rendered by default.

doxygen/latest/html/DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html

Lines changed: 348 additions & 0 deletions
Large diffs are not rendered by default.

doxygen/latest/html/DicomSeriesFromArray_2DicomSeriesFromArray_8java-example.html

Lines changed: 291 additions & 0 deletions
Large diffs are not rendered by default.

doxygen/latest/html/build_text.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
$(function(){
2-
document.getElementById("datetime").textContent = "Sat, 19 Jul 2025 07:00:36 +0000"
2+
document.getElementById("datetime").textContent = "Tue, 22 Jul 2025 07:04:18 +0000"
33
document.getElementById("projectnumber").textContent = "3.0.0.dev"
44
});

doxygen/latest/html/classitk_1_1simple_1_1Image.html

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
<p>A fundamental concept of ITK images is that they occupy physical space where the image is defined by an origin, spacing, and direction cosine matrix. The attributes are taken into consideration when doing most operations on an image. A meta-data dictionary is also associated with the image, which may contain additional fields from reading but these attributes are not propagated by image filters.</p>
113113
<p>The SimpleITK <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> provides a single facade interface to several ITK image types. Internally, the SimpleITK <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> maintains a pointer to the ITK image class, and performs reference counting and lazy copying. This means that deep copying of an image including it's buffer is delayed until the image is modified. This removes the need to use pointers to SimpleITK <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> class, as copying and returning by value do not unnecessarily duplicate the data.</p>
114114
<dl class="section see"><dt>See also</dt><dd><a class="elRef" href="https://www.itk.org/Doxygen/html/classitk_1_1Image.html">itk::Image</a> <a class="elRef" href="https://www.itk.org/Doxygen/html/classitk_1_1VectorImage.html">itk::VectorImage</a> <a class="elRef" href="https://www.itk.org/Doxygen/html/classitk_1_1LabelMap.html">itk::LabelMap</a> <a class="elRef" href="https://www.itk.org/Doxygen/html/classitk_1_1ImageBase.html">itk::ImageBase</a> </dd></dl>
115-
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="BufferImportExport_8cxx-example.html#_a5">BufferImportExport.cxx</a>, <a class="el" href="CppCMake_2Source_2sitk_example_8cxx-example.html#_a0">CppCMake/Source/sitk_example.cxx</a>, <a class="el" href="CppInPlace_2CppInPlace_8cxx-example.html#_a0">CppInPlace/CppInPlace.cxx</a>, <a class="el" href="DemonsRegistration1_2DemonsRegistration1_8cxx-example.html#_a3">DemonsRegistration1/DemonsRegistration1.cxx</a>, <a class="el" href="DemonsRegistration2_2DemonsRegistration2_8cs-example.html#_a5">DemonsRegistration2/DemonsRegistration2.cs</a>, <a class="el" href="DemonsRegistration2_2DemonsRegistration2_8cxx-example.html#_a3">DemonsRegistration2/DemonsRegistration2.cxx</a>, <a class="el" href="DicomSeriesReader_2DicomSeriesReader_8cs-example.html#_a3">DicomSeriesReader/DicomSeriesReader.cs</a>, <a class="el" href="DicomSeriesReader_2DicomSeriesReader_8cxx-example.html#_a3">DicomSeriesReader/DicomSeriesReader.cxx</a>, <a class="el" href="FastMarchingSegmentation_2FastMarchingSegmentation_8cxx-example.html#_a0">FastMarchingSegmentation/FastMarchingSegmentation.cxx</a>, <a class="el" href="FilterProgressReporting_2FilterProgressReporting_8cs-example.html#_a6">FilterProgressReporting/FilterProgressReporting.cs</a>, <a class="el" href="FilterProgressReporting_2FilterProgressReporting_8cxx-example.html#_a5">FilterProgressReporting/FilterProgressReporting.cxx</a>, <a class="el" href="HelloWorld_2HelloWorld_8cs-example.html#_a0">HelloWorld/HelloWorld.cs</a>, <a class="el" href="HelloWorld_2HelloWorld_8cxx-example.html#_a0">HelloWorld/HelloWorld.cxx</a>, <a class="el" href="ITKIntegration_2ITKIntegration_8cxx-example.html#_a2">ITKIntegration/ITKIntegration.cxx</a>, <a class="el" href="ImageIOSelection_2ImageIOSelection_8cs-example.html#_a5">ImageIOSelection/ImageIOSelection.cs</a>, <a class="el" href="ImageIOSelection_2ImageIOSelection_8cxx-example.html#_a5">ImageIOSelection/ImageIOSelection.cxx</a>, <a class="el" href="ImageRegistrationMethod1_2ImageRegistrationMethod1_8cs-example.html#_a8">ImageRegistrationMethod1/ImageRegistrationMethod1.cs</a>, <a class="el" href="ImageRegistrationMethod1_2ImageRegistrationMethod1_8cxx-example.html#_a3">ImageRegistrationMethod1/ImageRegistrationMethod1.cxx</a>, <a class="el" href="ImageRegistrationMethod2_2ImageRegistrationMethod2_8cs-example.html#_a8">ImageRegistrationMethod2/ImageRegistrationMethod2.cs</a>, <a class="el" href="ImageRegistrationMethod2_2ImageRegistrationMethod2_8cxx-example.html#_a3">ImageRegistrationMethod2/ImageRegistrationMethod2.cxx</a>, <a class="el" href="ImageRegistrationMethodBSpline1_2ImageRegistrationMethodBSpline1_8cxx-example.html#_a3">ImageRegistrationMethodBSpline1/ImageRegistrationMethodBSpline1.cxx</a>, <a class="el" href="ImageRegistrationMethodBSpline3_2ImageRegistrationMethodBSpline3_8cxx-example.html#_a4">ImageRegistrationMethodBSpline3/ImageRegistrationMethodBSpline3.cxx</a>, <a class="el" href="ImageRegistrationMethodDisplacement1_2ImageRegistrationMethodDisplacement1_8cxx-example.html#_a3">ImageRegistrationMethodDisplacement1/ImageRegistrationMethodDisplacement1.cxx</a>, <a class="el" href="N4BiasFieldCorrection_2N4BiasFieldCorrection_8cs-example.html#_a0">N4BiasFieldCorrection/N4BiasFieldCorrection.cs</a>, <a class="el" href="N4BiasFieldCorrection_2N4BiasFieldCorrection_8cxx-example.html#_a0">N4BiasFieldCorrection/N4BiasFieldCorrection.cxx</a>, <a class="el" href="Segmentation_2ConnectedThresholdImageFilter_8cxx-example.html#_a2">Segmentation/ConnectedThresholdImageFilter.cxx</a>, <a class="el" href="Segmentation_2NeighborhoodConnectedImageFilter_8cxx-example.html#_a2">Segmentation/NeighborhoodConnectedImageFilter.cxx</a>, <a class="el" href="SimpleGaussian_2SimpleGaussian_8cs-example.html#_a2">SimpleGaussian/SimpleGaussian.cs</a>, <a class="el" href="SimpleGaussian_2SimpleGaussian_8cxx-example.html#_a2">SimpleGaussian/SimpleGaussian.cxx</a>, <a class="el" href="SimpleGaussianFunctional_8cxx-example.html#_a0">SimpleGaussianFunctional.cxx</a>, <a class="el" href="SimpleIO_2SimpleIO_8cs-example.html#_a3">SimpleIO/SimpleIO.cs</a>, <a class="el" href="SimpleIO_2SimpleIO_8cxx-example.html#_a3">SimpleIO/SimpleIO.cxx</a>, and <a class="el" href="SliceBySliceDecorator_2SliceBySliceDecorator_8cxx-example.html#_a0">SliceBySliceDecorator/SliceBySliceDecorator.cxx</a>.</dd>
115+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="BufferImportExport_8cxx-example.html#_a5">BufferImportExport.cxx</a>, <a class="el" href="CppCMake_2Source_2sitk_example_8cxx-example.html#_a0">CppCMake/Source/sitk_example.cxx</a>, <a class="el" href="CppInPlace_2CppInPlace_8cxx-example.html#_a0">CppInPlace/CppInPlace.cxx</a>, <a class="el" href="DemonsRegistration1_2DemonsRegistration1_8cxx-example.html#_a3">DemonsRegistration1/DemonsRegistration1.cxx</a>, <a class="el" href="DemonsRegistration2_2DemonsRegistration2_8cs-example.html#_a5">DemonsRegistration2/DemonsRegistration2.cs</a>, <a class="el" href="DemonsRegistration2_2DemonsRegistration2_8cxx-example.html#_a3">DemonsRegistration2/DemonsRegistration2.cxx</a>, <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#_a1">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#_a1">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>, <a class="el" href="DicomSeriesReader_2DicomSeriesReader_8cs-example.html#_a3">DicomSeriesReader/DicomSeriesReader.cs</a>, <a class="el" href="DicomSeriesReader_2DicomSeriesReader_8cxx-example.html#_a3">DicomSeriesReader/DicomSeriesReader.cxx</a>, <a class="el" href="FastMarchingSegmentation_2FastMarchingSegmentation_8cxx-example.html#_a0">FastMarchingSegmentation/FastMarchingSegmentation.cxx</a>, <a class="el" href="FilterProgressReporting_2FilterProgressReporting_8cs-example.html#_a6">FilterProgressReporting/FilterProgressReporting.cs</a>, <a class="el" href="FilterProgressReporting_2FilterProgressReporting_8cxx-example.html#_a5">FilterProgressReporting/FilterProgressReporting.cxx</a>, <a class="el" href="HelloWorld_2HelloWorld_8cs-example.html#_a0">HelloWorld/HelloWorld.cs</a>, <a class="el" href="HelloWorld_2HelloWorld_8cxx-example.html#_a0">HelloWorld/HelloWorld.cxx</a>, <a class="el" href="ITKIntegration_2ITKIntegration_8cxx-example.html#_a2">ITKIntegration/ITKIntegration.cxx</a>, <a class="el" href="ImageIOSelection_2ImageIOSelection_8cs-example.html#_a5">ImageIOSelection/ImageIOSelection.cs</a>, <a class="el" href="ImageIOSelection_2ImageIOSelection_8cxx-example.html#_a5">ImageIOSelection/ImageIOSelection.cxx</a>, <a class="el" href="ImageRegistrationMethod1_2ImageRegistrationMethod1_8cs-example.html#_a8">ImageRegistrationMethod1/ImageRegistrationMethod1.cs</a>, <a class="el" href="ImageRegistrationMethod1_2ImageRegistrationMethod1_8cxx-example.html#_a3">ImageRegistrationMethod1/ImageRegistrationMethod1.cxx</a>, <a class="el" href="ImageRegistrationMethod2_2ImageRegistrationMethod2_8cs-example.html#_a8">ImageRegistrationMethod2/ImageRegistrationMethod2.cs</a>, <a class="el" href="ImageRegistrationMethod2_2ImageRegistrationMethod2_8cxx-example.html#_a3">ImageRegistrationMethod2/ImageRegistrationMethod2.cxx</a>, <a class="el" href="ImageRegistrationMethodBSpline1_2ImageRegistrationMethodBSpline1_8cxx-example.html#_a3">ImageRegistrationMethodBSpline1/ImageRegistrationMethodBSpline1.cxx</a>, <a class="el" href="ImageRegistrationMethodBSpline3_2ImageRegistrationMethodBSpline3_8cxx-example.html#_a4">ImageRegistrationMethodBSpline3/ImageRegistrationMethodBSpline3.cxx</a>, <a class="el" href="ImageRegistrationMethodDisplacement1_2ImageRegistrationMethodDisplacement1_8cxx-example.html#_a3">ImageRegistrationMethodDisplacement1/ImageRegistrationMethodDisplacement1.cxx</a>, <a class="el" href="N4BiasFieldCorrection_2N4BiasFieldCorrection_8cs-example.html#_a0">N4BiasFieldCorrection/N4BiasFieldCorrection.cs</a>, <a class="el" href="N4BiasFieldCorrection_2N4BiasFieldCorrection_8cxx-example.html#_a0">N4BiasFieldCorrection/N4BiasFieldCorrection.cxx</a>, <a class="el" href="Segmentation_2ConnectedThresholdImageFilter_8cxx-example.html#_a2">Segmentation/ConnectedThresholdImageFilter.cxx</a>, <a class="el" href="Segmentation_2NeighborhoodConnectedImageFilter_8cxx-example.html#_a2">Segmentation/NeighborhoodConnectedImageFilter.cxx</a>, <a class="el" href="SimpleGaussian_2SimpleGaussian_8cs-example.html#_a2">SimpleGaussian/SimpleGaussian.cs</a>, <a class="el" href="SimpleGaussian_2SimpleGaussian_8cxx-example.html#_a2">SimpleGaussian/SimpleGaussian.cxx</a>, <a class="el" href="SimpleGaussianFunctional_8cxx-example.html#_a0">SimpleGaussianFunctional.cxx</a>, <a class="el" href="SimpleIO_2SimpleIO_8cs-example.html#_a3">SimpleIO/SimpleIO.cs</a>, <a class="el" href="SimpleIO_2SimpleIO_8cxx-example.html#_a3">SimpleIO/SimpleIO.cxx</a>, and <a class="el" href="SliceBySliceDecorator_2SliceBySliceDecorator_8cxx-example.html#_a0">SliceBySliceDecorator/SliceBySliceDecorator.cxx</a>.</dd>
116116
</dl>
117117

118118
<p class="definition">Definition at line <a class="el" href="sitkImage_8h_source.html#l00076">76</a> of file <a class="el" href="sitkImage_8h_source.html">sitkImage.h</a>.</p>
@@ -1627,6 +1627,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0e9d6f84e457f7f6e59665c2
16271627
</table>
16281628
</div><div class="memdoc">
16291629
<p>Get the number of pixels the <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> is in the third dimension or 0 if the <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> is only 2D </p>
1630+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#a10">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, and <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#a10">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>.</dd>
1631+
</dl>
16301632

16311633
</div>
16321634
</div>
@@ -1670,6 +1672,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7bd35f108a2df5c966285405
16701672

16711673
<p>Set/Get the Direction. </p>
16721674
<p>Internally, the Direction is represented by a matrix 2x2 for a 2D and 3x3 for a 3D image. The matrix is passed as a 1D array in row-major form. </p>
1675+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#a9">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, and <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#a9">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>.</dd>
1676+
</dl>
16731677

16741678
</div>
16751679
</div>
@@ -2544,6 +2548,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a669907e56274c6ca2838be3b
25442548
</div><div class="memdoc">
25452549
<p>Get/Set the Spacing of the <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> as an std::vector .</p>
25462550
<p>The spacing describes the physical size of each pixel. The length of the vector is equal to the dimension of the <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a>. </p>
2551+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#a17">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, and <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#a17">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>.</dd>
2552+
</dl>
25472553

25482554
</div>
25492555
</div>
@@ -2835,6 +2841,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1663c39bf013511f30a632a6
28352841

28362842
<p>Set an entry in the meta-data dictionary. </p>
28372843
<p>Replaces or creates an entry in the image's meta-data dictionary. </p>
2844+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#a2">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, and <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#a2">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>.</dd>
2845+
</dl>
28382846

28392847
</div>
28402848
</div>
@@ -3576,6 +3584,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1b285752e1a79e123c055dc6
35763584
</div><div class="memdoc">
35773585
<p>Get/Set the Spacing of the <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a> as an std::vector .</p>
35783586
<p>The spacing describes the physical size of each pixel. The length of the vector is equal to the dimension of the <a class="el" href="classitk_1_1simple_1_1Image.html" title="The Image class for SimpleITK.">Image</a>. </p>
3587+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#a7">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, and <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#a7">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>.</dd>
3588+
</dl>
35793589

35803590
</div>
35813591
</div>
@@ -3751,6 +3761,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a87c1a1ecaa5bd379d3132c7e
37513761
</table>
37523762
</div><div class="memdoc">
37533763
<p><a class="el" href="classitk_1_1simple_1_1Transform.html" title="A simplified wrapper around a variety of ITK transforms.">Transform</a> index to physical point </p>
3764+
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cs-example.html#a3">DicomSeriesFromArray/DicomSeriesFromArray.cs</a>, and <a class="el" href="DicomSeriesFromArray_2DicomSeriesFromArray_8cxx-example.html#a3">DicomSeriesFromArray/DicomSeriesFromArray.cxx</a>.</dd>
3765+
</dl>
37543766

37553767
</div>
37563768
</div>

0 commit comments

Comments
 (0)