ITK  5.1.0
Insight Toolkit
itkPeriodicBoundaryCondition.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkPeriodicBoundaryCondition_h
19 #define itkPeriodicBoundaryCondition_h
21 
22 namespace itk
23 {
37 template <typename TInputImage, typename TOutputImage = TInputImage>
38 class ITK_TEMPLATE_EXPORT PeriodicBoundaryCondition : public ImageBoundaryCondition<TInputImage, TOutputImage>
39 {
40 public:
44 
46  using PixelType = typename Superclass::PixelType;
50  using IndexType = typename Superclass::IndexType;
51  using SizeType = typename Superclass::SizeType;
54 
56 
58  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
59 
61  PeriodicBoundaryCondition() = default;
62 
64  const char *
65  GetNameOfClass() const override
66  {
67  return "itkPeriodicBoundaryCondition";
68  }
69 
72  OutputPixelType
73  operator()(const OffsetType & point_index,
74  const OffsetType & boundary_offset,
75  const NeighborhoodType * data) const override;
76 
79  OutputPixelType
80  operator()(const OffsetType & point_index,
81  const OffsetType & boundary_offset,
82  const NeighborhoodType * data,
83  const NeighborhoodAccessorFunctorType & neighborhoodAccessorFunctor) const override;
84 
99  GetInputRequestedRegion(const RegionType & inputLargestPossibleRegion,
100  const RegionType & outputRequestedRegion) const override;
101 
110  OutputPixelType
111  GetPixel(const IndexType & index, const TInputImage * image) const override;
112 };
113 } // end namespace itk
115 
116 #ifndef ITK_MANUAL_INSTANTIATION
117 # include "itkPeriodicBoundaryCondition.hxx"
118 #endif
119 
120 #endif
itk::ImageBoundaryCondition::OutputPixelType
typename TOutputImage::PixelType OutputPixelType
Definition: itkImageBoundaryCondition.h:67
itk::Index
Represent a n-dimensional index in a n-dimensional image.
Definition: itkIndex.h:66
itk::ImageBoundaryCondition::PixelType
typename TInputImage::PixelType PixelType
Definition: itkImageBoundaryCondition.h:65
itk::Size< ImageDimension >
itk::PeriodicBoundaryCondition::GetNameOfClass
const char * GetNameOfClass() const override
Definition: itkPeriodicBoundaryCondition.h:65
itk::ImageRegion
An image region represents a structured region of data.
Definition: itkImageRegion.h:69
itk::PeriodicBoundaryCondition
A function object that determines values outside of image boundaries according to periodic (wrap-arou...
Definition: itkPeriodicBoundaryCondition.h:38
itk::Neighborhood
A light-weight container object for storing an N-dimensional neighborhood of values.
Definition: itkNeighborhood.h:54
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::ImageBoundaryCondition
A virtual base object that defines an interface to a class of boundary condition objects for use by n...
Definition: itkImageBoundaryCondition.h:52
itk::ImageBoundaryCondition::NeighborhoodAccessorFunctorType
typename TInputImage::NeighborhoodAccessorFunctorType NeighborhoodAccessorFunctorType
Definition: itkImageBoundaryCondition.h:77
itkImageBoundaryCondition.h
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::Offset< ImageDimension >
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkArray.h:26
itk::ImageBoundaryCondition::PixelPointerType
typename TInputImage::InternalPixelType * PixelPointerType
Definition: itkImageBoundaryCondition.h:66