ITK  5.3.0
Insight Toolkit
itkZeroFluxNeumannBoundaryCondition.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
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 itkZeroFluxNeumannBoundaryCondition_h
19 #define itkZeroFluxNeumannBoundaryCondition_h
21 
22 namespace itk
23 {
57 template <typename TInputImage, typename TOutputImage = TInputImage>
58 class ITK_TEMPLATE_EXPORT ZeroFluxNeumannBoundaryCondition : public ImageBoundaryCondition<TInputImage, TOutputImage>
59 {
60 public:
64 
66  using PixelType = typename Superclass::PixelType;
70  using IndexType = typename Superclass::IndexType;
71  using SizeType = typename Superclass::SizeType;
74 
76 
78  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;
79 
82 
84  const char *
85  GetNameOfClass() const override
86  {
87  return "itkZeroFluxNeumannBoundaryCondition";
88  }
89 
92  OutputPixelType
93  operator()(const OffsetType & point_index,
94  const OffsetType & boundary_offset,
95  const NeighborhoodType * data) const override;
96 
99  OutputPixelType
100  operator()(const OffsetType & point_index,
101  const OffsetType & boundary_offset,
102  const NeighborhoodType * data,
103  const NeighborhoodAccessorFunctorType & neighborhoodAccessorFunctor) const override;
104 
116  RegionType
117  GetInputRequestedRegion(const RegionType & inputLargestPossibleRegion,
118  const RegionType & outputRequestedRegion) const override;
119 
127  OutputPixelType
128  GetPixel(const IndexType & index, const TInputImage * image) const override;
129 };
130 } // end namespace itk
131 
132 #ifndef ITK_MANUAL_INSTANTIATION
133 # include "itkZeroFluxNeumannBoundaryCondition.hxx"
134 #endif
135 
136 /*
137 #ifndef ITK_MANUAL_INSTANTIATION
138 #include "itkZeroFluxNeumannBoundaryCondition.hxx"
139 #endif
140 */
141 
142 #endif
itk::ImageBoundaryCondition< TSparseImageType, TSparseImageType >::OutputPixelType
typename TSparseImageType ::PixelType OutputPixelType
Definition: itkImageBoundaryCondition.h:67
itk::Index
Represent a n-dimensional index in a n-dimensional image.
Definition: itkIndex.h:66
itk::ImageBoundaryCondition< TSparseImageType, TSparseImageType >::PixelType
typename TSparseImageType ::PixelType PixelType
Definition: itkImageBoundaryCondition.h:65
itk::Size< ImageDimension >
itk::ImageRegion
An image region represents a structured region of data.
Definition: itkImageRegion.h:69
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< TSparseImageType, TSparseImageType >::NeighborhoodAccessorFunctorType
typename TSparseImageType ::NeighborhoodAccessorFunctorType NeighborhoodAccessorFunctorType
Definition: itkImageBoundaryCondition.h:77
itkImageBoundaryCondition.h
itk::ZeroFluxNeumannBoundaryCondition::GetNameOfClass
const char * GetNameOfClass() const override
Definition: itkZeroFluxNeumannBoundaryCondition.h:85
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: itkAnnulusOperator.h:24
itk::ZeroFluxNeumannBoundaryCondition
A function object that determines a neighborhood of values at an image boundary according to a Neuman...
Definition: itkZeroFluxNeumannBoundaryCondition.h:58
itk::ImageBoundaryCondition< TSparseImageType, TSparseImageType >::PixelPointerType
typename TSparseImageType ::InternalPixelType * PixelPointerType
Definition: itkImageBoundaryCondition.h:66