forked from InsightSoftwareConsortium/ITK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
itkZeroFluxNeumannBoundaryCondition.h
120 lines (102 loc) · 4.35 KB
/
itkZeroFluxNeumannBoundaryCondition.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: itkZeroFluxNeumannBoundaryCondition.h
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) Insight Software Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef __itkZeroFluxNeumannBoundaryCondition_h
#define __itkZeroFluxNeumannBoundaryCondition_h
#include "itkNeighborhood.h"
#include "itkImageBoundaryCondition.h"
namespace itk
{
/** \class ZeroFluxNeumannBoundaryCondition
* \brief
* A function object that determines a neighborhood of values at an
* image boundary according to a Neumann boundary condition where first,
* upwind derivatives on the boundary are zero. This is a useful condition
* in solving some classes of differential equations.
*
* For example, invoking this function object on a 7x5 iterator that masks
* a region at an image corner (iterator is centered on the 2):
* \code
* * * * * * * *
* * * * * * * *
* * * 1 2 3 4 5 (where * denotes pixels that lie
* * * 3 3 5 5 6 outside of the image boundary)
* * * 4 4 6 7 8
* \endcode
* returns the following neighborhood of values:
* \code
* 1 1 1 2 3 4 5
* 1 1 1 2 3 4 5
* 1 1 1 2 3 4 5
* 3 3 3 3 5 5 6 (note the corner values)
* 4 4 4 4 6 7 8
* \endcode
* The input to this function object is a neighborhood iterator. This boundary
* condition object is designed to be given as a template argument to a
* NeighborhoodIterator or any of the NeighborhoodIterator
* subclasses.
*
* \ingroup DataRepresentation
* \ingroup ImageObjects
*/
template<class TImage>
class ITK_EXPORT ZeroFluxNeumannBoundaryCondition
: public ImageBoundaryCondition<TImage>
{
public:
/** Standard class typedefs. */
typedef ZeroFluxNeumannBoundaryCondition Self;
typedef ImageBoundaryCondition<TImage> Superclass;
/** Extract information from the image type. */
typedef typename Superclass::PixelType PixelType;
typedef typename Superclass::PixelPointerType PixelPointerType;
typedef typename Superclass::IndexType IndexType;
typedef typename Superclass::OffsetType OffsetType;
typedef typename Superclass::NeighborhoodType NeighborhoodType;
typedef typename Superclass::NeighborhoodAccessorFunctorType
NeighborhoodAccessorFunctorType;
/** Extract information from the image type. */
itkStaticConstMacro(ImageDimension, unsigned int,Superclass::ImageDimension);
/** Default constructor. */
ZeroFluxNeumannBoundaryCondition() {}
/** Computes and returns a neighborhood of appropriate values from
* neighborhood iterator data.. */
virtual PixelType operator()(const OffsetType& point_index,
const OffsetType& boundary_offset,
const NeighborhoodType *data) const;
/** Computes and returns the appropriate pixel value from
* neighborhood iterator data, using the functor. */
virtual PixelType operator()(
const OffsetType& point_index,
const OffsetType& boundary_offset,
const NeighborhoodType *data,
const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const;
};
} // end namespace itk
// Define instantiation macro for this template.
#define ITK_TEMPLATE_ZeroFluxNeumannBoundaryCondition(_, EXPORT, x, y) namespace itk { \
_(1(class EXPORT ZeroFluxNeumannBoundaryCondition< ITK_TEMPLATE_1 x >)) \
namespace Templates { typedef ZeroFluxNeumannBoundaryCondition< ITK_TEMPLATE_1 x > \
ZeroFluxNeumannBoundaryCondition##y; } \
}
#if ITK_TEMPLATE_EXPLICIT
# include "Templates/itkZeroFluxNeumannBoundaryCondition+-.h"
#endif
#if ITK_TEMPLATE_TXX
# include "itkZeroFluxNeumannBoundaryCondition.txx"
#endif
/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkZeroFluxNeumannBoundaryCondition.txx"
#endif
*/
#endif