itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage > Class Template Reference

#include <itkZeroFluxNeumannBoundaryCondition.h>

Detailed Description

template<typename TInputImage, typename TOutputImage = TInputImage>
class itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >

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):

* * * * * *
* * * * * *
* 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

returns the following neighborhood of values:

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

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.

Definition at line 58 of file itkZeroFluxNeumannBoundaryCondition.h.

Inheritance diagram for itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >:

Collaboration diagram for itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >:

Public Types
using	IndexType
using	NeighborhoodAccessorFunctorType
using	NeighborhoodType
using	OffsetType
using	OutputPixelType
using	PixelPointerType
using	PixelType
using	RegionType
using	Self = ZeroFluxNeumannBoundaryCondition
using	SizeType
using	Superclass = ImageBoundaryCondition<TInputImage, TOutputImage>
Public Types inherited from itk::ImageBoundaryCondition< TInputImage, TInputImage >
using	IndexType
using	InputImageType
using	NeighborhoodAccessorFunctorType
using	NeighborhoodType
using	OffsetType
using	OutputImageType
using	OutputPixelType
using	PixelPointerType
using	PixelType
using	RegionType
using	Self
using	SizeType

Public Member Functions
RegionType	GetInputRequestedRegion (const RegionType &inputLargestPossibleRegion, const RegionType &outputRequestedRegion) const override
const char *	GetNameOfClass () const override
OutputPixelType	GetPixel (const IndexType &index, const TInputImage *image) const override
OutputPixelType	operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data) const override
OutputPixelType	operator() (const OffsetType &point_index, const OffsetType &boundary_offset, const NeighborhoodType *data, const NeighborhoodAccessorFunctorType &neighborhoodAccessorFunctor) const override
	ZeroFluxNeumannBoundaryCondition ()=default
Public Member Functions inherited from itk::ImageBoundaryCondition< TInputImage, TInputImage >
	ImageBoundaryCondition ()=default
virtual void	Print (std::ostream &os, Indent i=0) const
virtual bool	RequiresCompleteNeighborhood ()
virtual	~ImageBoundaryCondition ()=default

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::ImageBoundaryCondition< TInputImage, TInputImage >
static constexpr unsigned int	ImageDimension

Member Typedef Documentation

IndexType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::IndexType

Definition at line 68 of file itkImageBoundaryCondition.h.

NeighborhoodAccessorFunctorType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodAccessorFunctorType

Functor used to access pixels from a neighborhood of pixel pointers

Definition at line 77 of file itkImageBoundaryCondition.h.

NeighborhoodType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodType

Type of the data container passed to this function object.

Definition at line 74 of file itkImageBoundaryCondition.h.

OffsetType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::OffsetType

Definition at line 70 of file itkImageBoundaryCondition.h.

OutputPixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::OutputPixelType

Definition at line 67 of file itkImageBoundaryCondition.h.

PixelPointerType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::PixelPointerType

Definition at line 66 of file itkImageBoundaryCondition.h.

PixelType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::PixelType

Definition at line 65 of file itkImageBoundaryCondition.h.

RegionType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::RegionType

Definition at line 71 of file itkImageBoundaryCondition.h.

Self

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::Self = ZeroFluxNeumannBoundaryCondition

Standard class type aliases.

Definition at line 62 of file itkZeroFluxNeumannBoundaryCondition.h.

SizeType

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ImageBoundaryCondition< TInputImage, TOutputImage >::SizeType

Definition at line 69 of file itkImageBoundaryCondition.h.

Superclass

template<typename TInputImage, typename TOutputImage = TInputImage>

using itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::Superclass = ImageBoundaryCondition<TInputImage, TOutputImage>

Definition at line 63 of file itkZeroFluxNeumannBoundaryCondition.h.

Constructor & Destructor Documentation

ZeroFluxNeumannBoundaryCondition()

template<typename TInputImage, typename TOutputImage = TInputImage>

itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::ZeroFluxNeumannBoundaryCondition ( )

default

Default constructor.

Member Function Documentation

GetInputRequestedRegion()

template<typename TInputImage, typename TOutputImage = TInputImage>

RegionType itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion ( const RegionType & inputLargestPossibleRegion, const RegionType & outputRequestedRegion ) const

overridevirtual

Determines the necessary input region for the output region. For this boundary condition, only the intersection of the largest possible image region and the output requested region is needed. If the intersection is empty, then a one-pixel layer of the image from the side closest to the output requested region is needed.

Parameters

inputLargestPossibleRegion	Largest possible region of the input image.
outputRequestedRegion	The output requested region.

Returns

The necessary input region required to determine the pixel values in the outputRequestedRegion.

Reimplemented from itk::ImageBoundaryCondition< TInputImage, TInputImage >.

GetNameOfClass()

template<typename TInputImage, typename TOutputImage = TInputImage>

const char * itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ImageBoundaryCondition< TInputImage, TInputImage >.

GetPixel()

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::GetPixel ( const IndexType & index, const TInputImage * image ) const

overridevirtual

Returns a value for a given pixel at an index. If the index is inside the bounds of the input image, then the pixel value is obtained from the input image. Otherwise, the nearest pixel value is returned.

Parameters

index	The index of the desired pixel.
image	The image from which pixel values should be determined.

Implements itk::ImageBoundaryCondition< TInputImage, TInputImage >.

operator()() [1/2]

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType & point_index, const OffsetType & boundary_offset, const NeighborhoodType * data ) const

overridevirtual

Computes and returns a neighborhood of appropriate values from neighborhood iterator data..

Implements itk::ImageBoundaryCondition< TInputImage, TInputImage >.

operator()() [2/2]

template<typename TInputImage, typename TOutputImage = TInputImage>

OutputPixelType itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType & point_index, const OffsetType & boundary_offset, const NeighborhoodType * data, const NeighborhoodAccessorFunctorType & neighborhoodAccessorFunctor ) const

overridevirtual

Computes and returns the appropriate pixel value from neighborhood iterator data, using the functor.

Implements itk::ImageBoundaryCondition< TInputImage, TInputImage >.

Member Data Documentation

ImageDimension

template<typename TInputImage, typename TOutputImage = TInputImage>

unsigned int itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Extract information from the image type.

Definition at line 81 of file itkZeroFluxNeumannBoundaryCondition.h.

---

The documentation for this class was generated from the following file:

• itkZeroFluxNeumannBoundaryCondition.h