ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::PeriodicBoundaryCondition< TInputImage, TOutputImage > Class Template Reference

#include <itkPeriodicBoundaryCondition.h>

+ Inheritance diagram for itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >:

Detailed Description

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

A function object that determines values outside of image boundaries according to periodic (wrap-around) conditions.

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 38 of file itkPeriodicBoundaryCondition.h.

Public Types

typedef Superclass::IndexType IndexType
 
typedef
Superclass::NeighborhoodAccessorFunctorType 
NeighborhoodAccessorFunctorType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::OutputPixelType OutputPixelType
 
typedef
Superclass::PixelPointerType 
PixelPointerType
 
typedef Superclass::PixelType PixelType
 
typedef Superclass::RegionType RegionType
 
typedef PeriodicBoundaryCondition Self
 
typedef Superclass::SizeType SizeType
 
typedef ImageBoundaryCondition
< TInputImage, TOutputImage > 
Superclass
 
- Public Types inherited from itk::ImageBoundaryCondition< TInputImage, TOutputImage >
typedef
TInputImage::NeighborhoodAccessorFunctorType 
NeighborhoodAccessorFunctorType
 
typedef Neighborhood
< PixelPointerType,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodType
 
typedef ImageBoundaryCondition Self
 
typedef TInputImage::PixelType PixelType
 
typedef
TInputImage::InternalPixelType * 
PixelPointerType
 
typedef TOutputImage::PixelType OutputPixelType
 
typedef Index
< itkGetStaticConstMacro(ImageDimension) > 
IndexType
 
typedef Size
< itkGetStaticConstMacro(ImageDimension) > 
SizeType
 
typedef Offset
< itkGetStaticConstMacro(ImageDimension) > 
OffsetType
 
typedef ImageRegion
< itkGetStaticConstMacro(ImageDimension) > 
RegionType
 

Public Member Functions

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

Static Public Attributes

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

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::IndexType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::IndexType

Definition at line 51 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::NeighborhoodAccessorFunctorType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodAccessorFunctorType

Definition at line 57 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::NeighborhoodType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::NeighborhoodType

Definition at line 54 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OffsetType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::OffsetType

Definition at line 53 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::OutputPixelType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::OutputPixelType

Definition at line 49 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::PixelPointerType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::PixelPointerType

Definition at line 48 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::PixelType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::PixelType

Extract information from the image type.

Definition at line 47 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::RegionType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::RegionType

Definition at line 50 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef PeriodicBoundaryCondition itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 43 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef Superclass::SizeType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::SizeType

Definition at line 52 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
typedef ImageBoundaryCondition< TInputImage, TOutputImage > itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::Superclass

Definition at line 44 of file itkPeriodicBoundaryCondition.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>
itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::PeriodicBoundaryCondition ( )
inline

Default constructor.

Definition at line 63 of file itkPeriodicBoundaryCondition.h.

Member Function Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual RegionType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetInputRequestedRegion ( const RegionType inputLargestPossibleRegion,
const RegionType outputRequestedRegion 
) const
virtual

Determines the necessary input region for the output region. For this boundary condition, the output region is mapped into the input image index space. If the mapped region crosses an image boundary in some dimension, then the entire size of the image in that dimension is requested. For this reason, it is most memory efficient to request regions that map to regions that do cross image boundaries.

Parameters
inputLargestPossibleRegionLargest possible region of the input image.
outputRequestedRegionThe output requested region.
Returns
The necessary input region required to determine the pixel values in the outputRequestedRegion.

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

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual const char* itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetNameOfClass ( ) const
inlinevirtual

Runtime information support.

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

Definition at line 66 of file itkPeriodicBoundaryCondition.h.

template<typename TInputImage , typename TOutputImage = TInputImage>
OutputPixelType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::GetPixel ( const IndexType index,
const TInputImage *  image 
) const
virtual

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 pixel at the desired index (modulo the size of the image) is returned.

Parameters
indexThe index of the desired pixel.
imageThe image from which pixel values should be determined.

Implements itk::ImageBoundaryCondition< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual OutputPixelType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data 
) const
virtual

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

Implements itk::ImageBoundaryCondition< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>
virtual OutputPixelType itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::operator() ( const OffsetType point_index,
const OffsetType boundary_offset,
const NeighborhoodType data,
const NeighborhoodAccessorFunctorType neighborhoodAccessorFunctor 
) const
virtual

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

Implements itk::ImageBoundaryCondition< TInputImage, TOutputImage >.

Member Data Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>
const unsigned int itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::ImageDimension = Superclass::ImageDimension
static

Extract information from the image type.

Definition at line 60 of file itkPeriodicBoundaryCondition.h.


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