forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ENH: Convenience overloads for ImageBase Transform member functions
Added convenience overloads to the six `ImageBase` Transform member
functions, returning the result by value, instead of having an output
parameter:
TransformPhysicalPointToIndex
TransformPhysicalPointToContinuousIndex
TransformContinuousIndexToPhysicalPoint
TransformIndexToPhysicalPoint
TransformLocalVectorToPhysicalVector
TransformPhysicalVectorToLocalVector
These overloads allow users to have a more "functional" programming
style, or at least, place the transformation result in a `const` variable.
So instead of:
Bar bar;
image->TransformFooToBar(foo, bar);
It typically allows users to write:
const auto bar = image->TransformFooToBar(foo);
Added a unit test to itkImageBaseGTest.- Loading branch information
Showing
3 changed files
with
235 additions
and
13 deletions.
There are no files selected for viewing
This file contains 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 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 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,114 @@ | ||
| /*========================================================================= | ||
| * | ||
| * Copyright Insight Software Consortium | ||
| * | ||
| * 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 | ||
| * | ||
| * http://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. | ||
| * | ||
| *=========================================================================*/ | ||
|
|
||
| // First include the header file to be tested: | ||
| #include "itkImageBase.h" | ||
| #include "itkImage.h" | ||
|
|
||
| #include <gtest/gtest.h> | ||
| #include <type_traits> // For is_same. | ||
|
|
||
|
|
||
| namespace | ||
| { | ||
| template <typename T1, typename T2> | ||
| void Expect_same_type_and_equal_value(T1&& value1, T2&& value2) | ||
| { | ||
| static_assert(std::is_same<T1, T2>::value, "Expect the same type!"); | ||
| EXPECT_EQ(value1, value2); | ||
| } | ||
|
|
||
|
|
||
| template <typename TImage> | ||
| void Expect_by_default_Transform_result_equals_default_constructed_value( | ||
| const typename TImage::SizeType& imageSize) | ||
| { | ||
| const auto ImageDimension = TImage::ImageDimension; | ||
| const auto image = TImage::New(); | ||
| image->SetRegions(imageSize); | ||
| image->Allocate(); | ||
|
|
||
| using ImageBaseType = itk::ImageBase<ImageDimension>; | ||
| using IndexType = typename ImageBaseType::IndexType; | ||
|
|
||
| using PointType = itk::Point<double, ImageDimension>; | ||
| using ContinuousIndexType = itk::ContinuousIndex<double, ImageDimension>; | ||
|
|
||
| using FloatArrayType = itk::FixedArray<float, ImageDimension>; | ||
| using DoubleArrayType = itk::FixedArray<double, ImageDimension>; | ||
|
|
||
| const ImageBaseType& imageBase = *image; | ||
|
|
||
| Expect_same_type_and_equal_value( | ||
| imageBase.TransformPhysicalPointToIndex(PointType()), | ||
| IndexType()); | ||
|
|
||
| // For the three member functions TransformPhysicalPointToContinuousIndex, | ||
| // TransformContinuousIndexToPhysicalPoint, and TransformIndexToPhysicalPoint, | ||
| // the first template argument of the return type is expected to | ||
| // correspond with the first template argument of the member function. | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.template TransformPhysicalPointToContinuousIndex<float>(PointType()), | ||
| itk::ContinuousIndex<float, ImageDimension>()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.template TransformPhysicalPointToContinuousIndex<double>(PointType()), | ||
| itk::ContinuousIndex<double, ImageDimension>()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.template TransformContinuousIndexToPhysicalPoint<float>(ContinuousIndexType()), | ||
| itk::Point<float, ImageDimension>()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.template TransformContinuousIndexToPhysicalPoint<double>(ContinuousIndexType()), | ||
| itk::Point<double, ImageDimension>()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.template TransformIndexToPhysicalPoint<float>(IndexType()), | ||
| itk::Point<float, ImageDimension>()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.template TransformIndexToPhysicalPoint<double>(IndexType()), | ||
| itk::Point<double, ImageDimension>()); | ||
|
|
||
| // The two member functions TransformLocalVectorToPhysicalVector and | ||
| // TransformPhysicalVectorToLocalVector are expected to return an | ||
| // array of the same type as their first function argument. | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.TransformLocalVectorToPhysicalVector(FloatArrayType()), | ||
| FloatArrayType()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.TransformLocalVectorToPhysicalVector(DoubleArrayType()), | ||
| DoubleArrayType()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.TransformPhysicalVectorToLocalVector(FloatArrayType()), | ||
| FloatArrayType()); | ||
| Expect_same_type_and_equal_value( | ||
| imageBase.TransformPhysicalVectorToLocalVector(DoubleArrayType()), | ||
| DoubleArrayType()); | ||
| } | ||
|
|
||
| } // end namespace | ||
|
|
||
|
|
||
| // Tests that "by default" (when the image has a default origin and a default | ||
| // direction matrix, and the function argument is just default-constructed), the | ||
| // return value of a single-parameter Transform member function is equal to a | ||
| // default-constructed value. This is tested for all six single-parameter | ||
| // Transform member functions of ImageBase. | ||
| TEST(ImageBase, ByDefaultTransformResultEqualsDefaultConstructedValue) | ||
| { | ||
| // Test both 2D and 3D, for different pixel types and sizes: | ||
| Expect_by_default_Transform_result_equals_default_constructed_value<itk::Image<double>>({ {2, 2} }); | ||
| Expect_by_default_Transform_result_equals_default_constructed_value<itk::Image<unsigned char, 3>>({ {2, 3, 4} }); | ||
| } |