Repository navigation
WIP: ENH: Step iterator positions with integer arithmetic at buffer markers #7111
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /*========================================================================= | ||
| * | ||
| * Copyright NumFOCUS | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0.txt | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| *=========================================================================*/ | ||
|
|
||
| #include "itkImage.h" | ||
| #include "itkImageLinearConstIteratorWithIndex.h" | ||
| #include "itkImageLinearIteratorWithIndex.h" | ||
| #include "itkImageBufferRange.h" | ||
| #include "itkGTest.h" | ||
|
|
||
| #include <algorithm> | ||
| #include <vector> | ||
|
|
||
| namespace | ||
| { | ||
| using ImageType = itk::Image<float, 3>; | ||
| using RegionType = ImageType::RegionType; | ||
|
|
||
| ImageType::Pointer | ||
| MakeImage() | ||
| { | ||
| auto image = ImageType::New(); | ||
| image->SetRegions(RegionType({ { 10, 20, 30 } }, { { 6, 5, 4 } })); | ||
| image->Allocate(); | ||
| float value = 1.0F; | ||
| for (float & pixel : itk::ImageBufferRange<ImageType>{ *image }) | ||
| { | ||
| pixel = value++; | ||
| } | ||
| return image; | ||
| } | ||
|
|
||
| // Visits every pixel of `region` once, in both orders, checking index, value and position agreement. | ||
| template <typename TIterator> | ||
| void | ||
| ExpectTraversal(ImageType * image, const RegionType & region, unsigned int direction) | ||
| { | ||
| TIterator it(image, region); | ||
| it.SetDirection(direction); | ||
| for (const bool reverse : { false, true }) | ||
| { | ||
| SCOPED_TRACE(reverse ? "reverse" : "forward"); | ||
| std::vector<unsigned int> visits(image->GetBufferedRegion().GetNumberOfPixels(), 0); | ||
| reverse ? it.GoToReverseBegin() : it.GoToBegin(); | ||
| while (!(reverse ? it.IsAtReverseEnd() : it.IsAtEnd())) | ||
| { | ||
| while (!(reverse ? it.IsAtReverseEndOfLine() : it.IsAtEndOfLine())) | ||
| { | ||
| const auto index = it.GetIndex(); | ||
| ASSERT_TRUE(region.IsInside(index)); | ||
| EXPECT_EQ(it.Get(), image->GetPixel(index)); | ||
| EXPECT_EQ(visits[image->ComputeOffset(index)]++, 0U); | ||
| reverse ? --it : ++it; | ||
| } | ||
| reverse ? it.PreviousLine() : it.NextLine(); | ||
| } | ||
| EXPECT_EQ(std::count(visits.cbegin(), visits.cend(), 1U), region.GetNumberOfPixels()); | ||
| } | ||
| } | ||
|
|
||
| const RegionType regions[] = { RegionType({ { 10, 20, 30 } }, { { 6, 5, 4 } }), | ||
| RegionType({ { 11, 21, 31 } }, { { 4, 3, 2 } }), | ||
| RegionType({ { 10, 20, 30 } }, { { 3, 2, 2 } }), | ||
| RegionType({ { 13, 23, 32 } }, { { 3, 2, 2 } }) }; | ||
| } // namespace | ||
|
|
||
| TEST(ImageLinearIteratorWithIndex, VisitsEveryPixelOnceInEveryDirection) | ||
| { | ||
| const auto image = MakeImage(); | ||
| for (const auto & region : regions) | ||
| { | ||
| for (unsigned int direction = 0; direction < 3; ++direction) | ||
| { | ||
| SCOPED_TRACE(testing::Message() << "region " << region << " direction " << direction); | ||
| ExpectTraversal<itk::ImageLinearConstIteratorWithIndex<ImageType>>(image, region, direction); | ||
| ExpectTraversal<itk::ImageLinearIteratorWithIndex<ImageType>>(image, region, direction); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| TEST(ImageLinearIteratorWithIndex, GoToBeginAndEndOfLineLandOnTheLine) | ||
| { | ||
| const auto image = MakeImage(); | ||
| const auto region = regions[1]; | ||
| itk::ImageLinearConstIteratorWithIndex<ImageType> it(image, region); | ||
| it.SetDirection(2); | ||
| it.GoToBegin(); | ||
| it.NextLine(); | ||
| it.GoToEndOfLine(); | ||
| EXPECT_EQ(it.GetIndex()[2], region.GetIndex(2) + static_cast<itk::IndexValueType>(region.GetSize(2))); | ||
| it.GoToReverseBeginOfLine(); | ||
| EXPECT_EQ(it.Get(), image->GetPixel(it.GetIndex())); | ||
| it.GoToBeginOfLine(); | ||
| EXPECT_EQ(it.GetIndex()[2], region.GetIndex(2)); | ||
| EXPECT_EQ(it.Get(), image->GetPixel(it.GetIndex())); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The step is done on the pointer's integer value so that no pointer arithmetic produces a value outside the buffer ([expr.add]/4). Measured against
mainwith the slice loop: Clang (arm64 23, x86 18) folds this back to the original pointer arithmetic, same instructions per pixel; GCC 13 keeps one extra instruction per pixel (10.3 -> 11.3) at +0% wall time on long lines and +2% to +9% on 2-pixel lines.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gdevenyi This seems like a lot of compiled away conversion to do the same math to avoid an un-observed problem.
This solution does not have the performance degredation that your PR 7032 had.