-
-
Notifications
You must be signed in to change notification settings - Fork 663
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ENH: Added policy for constant NeighborhoodRange values outside image
Added ConstantBoundaryImageNeighborhoodPixelAccessPolicy - a policy to get a specified constant value from ShapedImageNeighborhoodRange when a pixel value outside the image is queried. Equivalent to itk::ConstantBoundaryCondition with itk::ConstNeighborhoodIterator. Adapted ShapedImageNeighborhoodRange to allow the user to specify an optional pixel access parameter. This parameter allows specifying the constant value for this policy. Change-Id: I5a1ae9f918a31d03a4dd3d84ceedd4385ab4ec7d
- Loading branch information
1 parent
0bfb0b5
commit def5d12
Showing
4 changed files
with
376 additions
and
19 deletions.
There are no files selected for viewing
159 changes: 159 additions & 0 deletions
159
Modules/Core/Common/include/itkConstantBoundaryImageNeighborhoodPixelAccessPolicy.h
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,159 @@ | ||
| /*========================================================================= | ||
| * | ||
| * 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. | ||
| * | ||
| *=========================================================================*/ | ||
|
|
||
| #ifndef itkConstantBoundaryImageNeighborhoodPixelAccessPolicy_h | ||
| #define itkConstantBoundaryImageNeighborhoodPixelAccessPolicy_h | ||
|
|
||
| #include "itkIndex.h" | ||
| #include "itkOffset.h" | ||
| #include "itkSize.h" | ||
|
|
||
| namespace itk | ||
| { | ||
| namespace Experimental | ||
| { | ||
|
|
||
| /** | ||
| * \class ConstantBoundaryImageNeighborhoodPixelAccessPolicy | ||
| * ImageNeighborhoodPixelAccessPolicy class for ShapedImageNeighborhoodRange. | ||
| * Allows getting and setting the value of a pixel, located in a specified | ||
| * neighborhood location, at a specified offset. Uses a constant as value | ||
| * for pixels outside the image border. | ||
| * | ||
| * \see ShapedNeighborhoodIterator | ||
| * \see ConstantBoundaryCondition | ||
| * \ingroup ImageIterators | ||
| * \ingroup ITKCommon | ||
| */ | ||
| template <typename TImage> | ||
| class ConstantBoundaryImageNeighborhoodPixelAccessPolicy final | ||
| { | ||
| private: | ||
| using NeighborhoodAccessorFunctorType = typename TImage::NeighborhoodAccessorFunctorType; | ||
| using PixelType = typename TImage::PixelType; | ||
| using InternalPixelType = typename TImage::InternalPixelType; | ||
|
|
||
| using ImageDimensionType = typename TImage::ImageDimensionType; | ||
| static constexpr ImageDimensionType ImageDimension = TImage::ImageDimension; | ||
|
|
||
| using IndexType = Index<ImageDimension>; | ||
| using OffsetType = Offset<ImageDimension>; | ||
| using ImageSizeType = Size<ImageDimension>; | ||
| using ImageSizeValueType = SizeValueType; | ||
|
|
||
| // Index value to the image buffer, indexing the current pixel. -1 is used to indicate out-of-bounds. | ||
| const IndexValueType m_PixelIndexValue; | ||
|
|
||
| // A reference to the accessor of the image. | ||
| const NeighborhoodAccessorFunctorType& m_NeighborhoodAccessor; | ||
|
|
||
| // The constant whose value is returned a pixel value outside the image is queried. | ||
| const PixelType m_Constant; | ||
|
|
||
|
|
||
| // Private helper function. Tells whether the pixel at 'pixelIndex' is inside the image. | ||
| static bool IsInside( | ||
| const IndexType& pixelIndex, | ||
| const ImageSizeType& imageSize) ITK_NOEXCEPT | ||
| { | ||
| bool result = true; | ||
|
|
||
| for (ImageDimensionType i = 0; i < ImageDimension; ++i) | ||
| { | ||
| const IndexValueType indexValue = pixelIndex[i]; | ||
|
|
||
| // Note: Do not 'quickly' break or return out of the for-loop when the | ||
| // result is false! For performance reasons (loop unrolling, etc.) it | ||
| // appears preferable to complete the for-loop iteration in this case! | ||
| result = result && | ||
| (indexValue >= 0) && | ||
| (static_cast<ImageSizeValueType>(indexValue) < imageSize[i]); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
|
|
||
| // Private helper function. Calculates and returns the index value of the | ||
| // current pixel within the image buffer. | ||
| static IndexValueType CalculatePixelIndexValue( | ||
| const OffsetType& offsetTable, | ||
| const IndexType& pixelIndex) ITK_NOEXCEPT | ||
| { | ||
| IndexValueType result = 0; | ||
|
|
||
| for (ImageDimensionType i = 0; i < ImageDimension; ++i) | ||
| { | ||
| result += pixelIndex[i] * offsetTable[i]; | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| public: | ||
| // Deleted member functions: | ||
| ConstantBoundaryImageNeighborhoodPixelAccessPolicy() = delete; | ||
| ConstantBoundaryImageNeighborhoodPixelAccessPolicy& operator=(const ConstantBoundaryImageNeighborhoodPixelAccessPolicy&) = delete; | ||
|
|
||
| // Explicitly-defaulted functions: | ||
| ~ConstantBoundaryImageNeighborhoodPixelAccessPolicy() = default; | ||
| ConstantBoundaryImageNeighborhoodPixelAccessPolicy( | ||
| const ConstantBoundaryImageNeighborhoodPixelAccessPolicy&) = default; | ||
|
|
||
| /** Constructor called directly by the pixel proxy of | ||
| * ShapedImageNeighborhoodRange. */ | ||
| ConstantBoundaryImageNeighborhoodPixelAccessPolicy( | ||
| const ImageSizeType& imageSize, | ||
| const OffsetType& offsetTable, | ||
| const NeighborhoodAccessorFunctorType& neighborhoodAccessor, | ||
| const IndexType& pixelIndex, | ||
| const PixelType constant = {}) ITK_NOEXCEPT | ||
| : | ||
| m_PixelIndexValue | ||
| { | ||
| IsInside(pixelIndex, imageSize) ? CalculatePixelIndexValue(offsetTable, pixelIndex) : -1 | ||
| }, | ||
| m_NeighborhoodAccessor(neighborhoodAccessor), | ||
| m_Constant{constant} | ||
| { | ||
| } | ||
|
|
||
|
|
||
| /** Retrieves the pixel value from the image buffer, at the current | ||
| * index. When the index is out of bounds, it returns the constant | ||
| * value specified during construction. */ | ||
| PixelType GetPixelValue(const InternalPixelType* const imageBufferPointer) const ITK_NOEXCEPT | ||
| { | ||
| return (m_PixelIndexValue < 0) ? | ||
| m_Constant : | ||
| m_NeighborhoodAccessor.Get(imageBufferPointer + m_PixelIndexValue); | ||
| } | ||
|
|
||
| /** Sets the value of the image buffer at the current index value to the | ||
| * specified value. */ | ||
| void SetPixelValue(InternalPixelType* const imageBufferPointer, const PixelType& pixelValue) const ITK_NOEXCEPT | ||
| { | ||
| if (m_PixelIndexValue >= 0) | ||
| { | ||
| m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| } // namespace Experimental | ||
| } // namespace itk | ||
|
|
||
| #endif |
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
Oops, something went wrong.