DOC: Document Iterator(image, region) constructors initializing at begin

N-Dekker · dzenanz · commit 9eb13596cef6 · 2024-08-28T14:33:42.000-04:00
Explicitly specify that those constructors initialize the iterator at the begin
of the region.
diff --git a/Modules/Core/Common/include/itkImageConstIterator.h b/Modules/Core/Common/include/itkImageConstIterator.h
@@ -163,8 +163,8 @@ class ITK_TEMPLATE_EXPORT ImageConstIterator
     m_PixelAccessorFunctor.SetBegin(m_Buffer);
   }
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageConstIterator(const ImageType * ptr, const RegionType & region)
   {
     m_Image = ptr;
diff --git a/Modules/Core/Common/include/itkImageConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageConstIteratorWithIndex.h
@@ -144,8 +144,8 @@ class ITK_TEMPLATE_EXPORT ImageConstIteratorWithIndex
    * handle to the image is properly reference counted. */
   ImageConstIteratorWithIndex(const Self & it);
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageConstIteratorWithIndex(const TImage * ptr, const RegionType & region);
 
   /** Default Destructor. */
diff --git a/Modules/Core/Common/include/itkImageConstIteratorWithOnlyIndex.h b/Modules/Core/Common/include/itkImageConstIteratorWithOnlyIndex.h
@@ -128,8 +128,8 @@ class ITK_TEMPLATE_EXPORT ImageConstIteratorWithOnlyIndex
    * provide a copy constructor. */
   ImageConstIteratorWithOnlyIndex() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageConstIteratorWithOnlyIndex(const TImage * ptr, const RegionType & region);
 
   /** Default Destructor. */
diff --git a/Modules/Core/Common/include/itkImageIterator.h b/Modules/Core/Common/include/itkImageIterator.h
@@ -98,8 +98,8 @@ class ITK_TEMPLATE_EXPORT ImageIterator : public ImageConstIterator<TImage>
   /** Default Destructor */
   ~ImageIterator() override = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageIterator(TImage * ptr, const RegionType & region);
 
   /** Set the pixel value */
diff --git a/Modules/Core/Common/include/itkImageIteratorWithIndex.h b/Modules/Core/Common/include/itkImageIteratorWithIndex.h
@@ -101,8 +101,8 @@ class ITK_TEMPLATE_EXPORT ImageIteratorWithIndex : public ImageConstIteratorWith
   /** Default Destructor */
   ~ImageIteratorWithIndex() override = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageIteratorWithIndex(TImage * ptr, const RegionType & region);
 
   /** Set the pixel value */
diff --git a/Modules/Core/Common/include/itkImageLinearConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageLinearConstIteratorWithIndex.h
@@ -135,8 +135,8 @@ class ITK_TEMPLATE_EXPORT ImageLinearConstIteratorWithIndex : public ImageConstI
 
   {}
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageLinearConstIteratorWithIndex(const ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageLinearIteratorWithIndex.h b/Modules/Core/Common/include/itkImageLinearIteratorWithIndex.h
@@ -86,8 +86,8 @@ class ITK_TEMPLATE_EXPORT ImageLinearIteratorWithIndex : public ImageLinearConst
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageLinearIteratorWithIndex() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageLinearIteratorWithIndex(ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageRegionConstIterator.h b/Modules/Core/Common/include/itkImageRegionConstIterator.h
@@ -146,8 +146,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIterator : public ImageConstIterator<T
     m_SpanEndOffset = 0;
   }
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionConstIterator(const ImageType * ptr, const RegionType & region)
     : ImageConstIterator<TImage>(ptr, region)
   {
diff --git a/Modules/Core/Common/include/itkImageRegionConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageRegionConstIteratorWithIndex.h
@@ -155,8 +155,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIteratorWithIndex : public ImageConstI
     : ImageConstIteratorWithIndex<TImage>()
   {}
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionConstIteratorWithIndex(const TImage * ptr, const RegionType & region)
     : ImageConstIteratorWithIndex<TImage>(ptr, region)
   {}
diff --git a/Modules/Core/Common/include/itkImageRegionConstIteratorWithOnlyIndex.h b/Modules/Core/Common/include/itkImageRegionConstIteratorWithOnlyIndex.h
@@ -151,8 +151,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIteratorWithOnlyIndex : public ImageCo
     : ImageConstIteratorWithOnlyIndex<TImage>()
   {}
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionConstIteratorWithOnlyIndex(const TImage * ptr, const RegionType & region)
     : ImageConstIteratorWithOnlyIndex<TImage>(ptr, region)
   {}
diff --git a/Modules/Core/Common/include/itkImageRegionExclusionConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageRegionExclusionConstIteratorWithIndex.h
@@ -150,8 +150,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionExclusionConstIteratorWithIndex : public Im
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageRegionExclusionConstIteratorWithIndex() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionExclusionConstIteratorWithIndex(const ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageRegionConstIteratorWithIndex
diff --git a/Modules/Core/Common/include/itkImageRegionExclusionIteratorWithIndex.h b/Modules/Core/Common/include/itkImageRegionExclusionIteratorWithIndex.h
@@ -87,8 +87,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionExclusionIteratorWithIndex
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageRegionExclusionIteratorWithIndex() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionExclusionIteratorWithIndex(ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageRegionIterator.h b/Modules/Core/Common/include/itkImageRegionIterator.h
@@ -99,8 +99,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionIterator : public ImageRegionConstIterator<
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageRegionIterator() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionIterator(ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageRegionIteratorWithIndex.h b/Modules/Core/Common/include/itkImageRegionIteratorWithIndex.h
@@ -92,8 +92,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionIteratorWithIndex : public ImageRegionConst
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageRegionIteratorWithIndex() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionIteratorWithIndex(TImage * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageRegionReverseConstIterator.h b/Modules/Core/Common/include/itkImageRegionReverseConstIterator.h
@@ -153,8 +153,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionReverseConstIterator : public ImageReverseC
     m_SpanEndOffset = 0;
   }
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionReverseConstIterator(const ImageType * ptr, const RegionType & region)
     : Superclass(ptr, region)
   {
diff --git a/Modules/Core/Common/include/itkImageRegionReverseIterator.h b/Modules/Core/Common/include/itkImageRegionReverseIterator.h
@@ -88,8 +88,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionReverseIterator : public ImageRegionReverse
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageRegionReverseIterator() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageRegionReverseIterator(ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageConstIterator to an
diff --git a/Modules/Core/Common/include/itkImageReverseConstIterator.h b/Modules/Core/Common/include/itkImageReverseConstIterator.h
@@ -166,8 +166,8 @@ class ITK_TEMPLATE_EXPORT ImageReverseConstIterator
     m_PixelAccessorFunctor.SetBegin(m_Buffer);
   }
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageReverseConstIterator(const ImageType * ptr, const RegionType & region)
   {
     SizeValueType offset;
diff --git a/Modules/Core/Common/include/itkImageReverseIterator.h b/Modules/Core/Common/include/itkImageReverseIterator.h
@@ -84,8 +84,8 @@ class ITK_TEMPLATE_EXPORT ImageReverseIterator : public ImageRegionReverseConstI
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageReverseIterator() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageReverseIterator(ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageScanlineConstIterator.h b/Modules/Core/Common/include/itkImageScanlineConstIterator.h
@@ -101,8 +101,8 @@ class ITK_TEMPLATE_EXPORT ImageScanlineConstIterator : public ImageConstIterator
     m_SpanEndOffset = 0;
   }
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageScanlineConstIterator(const TImage * ptr, const RegionType & region)
     : ImageConstIterator<TImage>(ptr, region)
   {
diff --git a/Modules/Core/Common/include/itkImageScanlineIterator.h b/Modules/Core/Common/include/itkImageScanlineIterator.h
@@ -61,8 +61,8 @@ class ITK_TEMPLATE_EXPORT ImageScanlineIterator : public ImageScanlineConstItera
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageScanlineIterator() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageScanlineIterator(TImage * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an
diff --git a/Modules/Core/Common/include/itkImageSliceConstIteratorWithIndex.h b/Modules/Core/Common/include/itkImageSliceConstIteratorWithIndex.h
@@ -134,8 +134,8 @@ class ITK_TEMPLATE_EXPORT ImageSliceConstIteratorWithIndex : public ImageConstIt
     : ImageConstIteratorWithIndex<TImage>()
   {}
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageSliceConstIteratorWithIndex(const ImageType * ptr, const RegionType & region)
     : ImageConstIteratorWithIndex<TImage>(ptr, region)
     , m_PixelJump(0)
diff --git a/Modules/Core/Common/include/itkImageSliceIteratorWithIndex.h b/Modules/Core/Common/include/itkImageSliceIteratorWithIndex.h
@@ -88,8 +88,8 @@ class ITK_TEMPLATE_EXPORT ImageSliceIteratorWithIndex : public ImageSliceConstIt
   /** Default constructor. Needed since we provide a cast constructor. */
   ImageSliceIteratorWithIndex() = default;
 
-  /** Constructor establishes an iterator to walk a particular image and a
-   * particular region of that image. */
+  /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
+   * the iterator at the begin of the region. */
   ImageSliceIteratorWithIndex(ImageType * ptr, const RegionType & region);
 
   /** Constructor that can be used to cast from an ImageIterator to an

Original file line number	Diff line number	Diff line change
`@@ -163,8 +163,8 @@ class ITK_TEMPLATE_EXPORT ImageConstIterator`
`163`	`163`	`m_PixelAccessorFunctor.SetBegin(m_Buffer);`
`164`	`164`	`}`
`165`	`165`
`166`		`- /** Constructor establishes an iterator to walk a particular image and a`
`167`		`- * particular region of that image. */`
	`166`	`+ /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes`
	`167`	`+ * the iterator at the begin of the region. */`
`168`	`168`	`ImageConstIterator(const ImageType * ptr, const RegionType & region)`
`169`	`169`	`{`
`170`	`170`	`m_Image = ptr;`
Original file line number	Diff line number	Diff line change
`@@ -146,8 +146,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIterator : public ImageConstIterator<T`
`146`	`146`	`m_SpanEndOffset = 0;`
`147`	`147`	`}`
`148`	`148`
`149`		`- /** Constructor establishes an iterator to walk a particular image and a`
`150`		`- * particular region of that image. */`
	`149`	`+ /** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes`
	`150`	`+ * the iterator at the begin of the region. */`
`151`	`151`	`ImageRegionConstIterator(const ImageType * ptr, const RegionType & region)`
`152`	`152`	`: ImageConstIterator<TImage>(ptr, region)`
`153`	`153`	`{`