Skip to content

Commit 4076588

Browse files
committed
DOC: Document Frequency Iterator(image, region) initializing at begin
Explicitly specify that those constructors from iterator types of Modules/Filtering/ImageFrequency initialize the iterator at the begin of the region. Note: `FrequencyImageRegionIteratorWithIndex` and `FrequencyImageRegionConstIteratorWithIndex` are excluded from this commit, because they do not yet compile. - Follow-up to pull request #4815 commit 9eb1359 "DOC: Document Iterator(image, region) constructors initializing at begin"
1 parent 8d1b533 commit 4076588

6 files changed

+12
-12
lines changed

Modules/Filtering/ImageFrequency/include/itkFrequencyFFTLayoutImageRegionConstIteratorWithIndex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ class ITK_TEMPLATE_EXPORT FrequencyFFTLayoutImageRegionConstIteratorWithIndex
141141
this->Init();
142142
}
143143

144-
/** Constructor establishes an iterator to walk a particular image and a
145-
* particular region of that image. */
144+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
145+
* the iterator at the begin of the region. */
146146
FrequencyFFTLayoutImageRegionConstIteratorWithIndex(const TImage * ptr, const RegionType & region)
147147
: ImageRegionConstIteratorWithIndex<TImage>(ptr, region)
148148
{

Modules/Filtering/ImageFrequency/include/itkFrequencyFFTLayoutImageRegionIteratorWithIndex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ class FrequencyFFTLayoutImageRegionIteratorWithIndex
8888
: FrequencyFFTLayoutImageRegionConstIteratorWithIndex<TImage>()
8989
{}
9090

91-
/** Constructor establishes an iterator to walk a particular image and a
92-
* particular region of that image. */
91+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
92+
* the iterator at the begin of the region. */
9393
FrequencyFFTLayoutImageRegionIteratorWithIndex(TImage * ptr, const RegionType & region)
9494
: FrequencyFFTLayoutImageRegionConstIteratorWithIndex<TImage>(ptr, region)
9595
{}

Modules/Filtering/ImageFrequency/include/itkFrequencyHalfHermitianFFTLayoutImageRegionConstIteratorWithIndex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ class FrequencyHalfHermitianFFTLayoutImageRegionConstIteratorWithIndex
147147
this->Init();
148148
}
149149

150-
/** Constructor establishes an iterator to walk a particular image and a
151-
* particular region of that image. */
150+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
151+
* the iterator at the begin of the region. */
152152
FrequencyHalfHermitianFFTLayoutImageRegionConstIteratorWithIndex(const TImage * ptr, const RegionType & region)
153153
: ImageRegionConstIteratorWithIndex<TImage>(ptr, region)
154154
{

Modules/Filtering/ImageFrequency/include/itkFrequencyHalfHermitianFFTLayoutImageRegionIteratorWithIndex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ class FrequencyHalfHermitianFFTLayoutImageRegionIteratorWithIndex
8888
: FrequencyHalfHermitianFFTLayoutImageRegionConstIteratorWithIndex<TImage>()
8989
{}
9090

91-
/** Constructor establishes an iterator to walk a particular image and a
92-
* particular region of that image. */
91+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
92+
* the iterator at the begin of the region. */
9393
FrequencyHalfHermitianFFTLayoutImageRegionIteratorWithIndex(TImage * ptr, const RegionType & region)
9494
: FrequencyHalfHermitianFFTLayoutImageRegionConstIteratorWithIndex<TImage>(ptr, region)
9595
{}

Modules/Filtering/ImageFrequency/include/itkFrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ class ITK_TEMPLATE_EXPORT FrequencyShiftedFFTLayoutImageRegionConstIteratorWithI
141141
this->Init();
142142
}
143143

144-
/** Constructor establishes an iterator to walk a particular image and a
145-
* particular region of that image. */
144+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
145+
* the iterator at the begin of the region. */
146146
FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex(const TImage * ptr, const RegionType & region)
147147
: ImageRegionConstIteratorWithIndex<TImage>(ptr, region)
148148
{

Modules/Filtering/ImageFrequency/include/itkFrequencyShiftedFFTLayoutImageRegionIteratorWithIndex.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ class FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex
8888
: FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex<TImage>()
8989
{}
9090

91-
/** Constructor establishes an iterator to walk a particular image and a
92-
* particular region of that image. */
91+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
92+
* the iterator at the begin of the region. */
9393
FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex(TImage * ptr, const RegionType & region)
9494
: FrequencyShiftedFFTLayoutImageRegionConstIteratorWithIndex<TImage>(ptr, region)
9595
{}

0 commit comments

Comments
 (0)