ITK  5.2.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
itk::DefaultVectorPixelAccessorFunctor< TImageType > Class Template Reference

#include <itkDefaultVectorPixelAccessorFunctor.h>

Classes

struct  Rebind
 

Public Types

using ExternalPixelType = typename ImageType::PixelType
 
using ImageType = TImageType
 
using InternalPixelType = typename ImageType::InternalPixelType
 
using PixelAccessorType = typename ImageType::AccessorType
 
using VectorLengthType = unsigned int
 

Public Member Functions

 DefaultVectorPixelAccessorFunctor ()=default
 
ExternalPixelType Get (const InternalPixelType &input) const
 
void Set (InternalPixelType &output, const ExternalPixelType &input) const
 
void SetBegin (const InternalPixelType *begin)
 
void SetPixelAccessor (const PixelAccessorType &accessor)
 

Static Public Member Functions

static VectorLengthType GetVectorLength (const ImageType *image)
 
static void SetVectorLength (ImageType *image, VectorLengthType length)
 

Private Attributes

InternalPixelTypem_Begin { nullptr }
 
PixelAccessorType m_PixelAccessor
 

Detailed Description

template<typename TImageType>
class itk::DefaultVectorPixelAccessorFunctor< TImageType >

This class provides a common API for pixel accessors for Image and VectorImage. (between the DefaultVectorPixelAccessor and DefaultPixelAccessor).

The pixel accessor is set with the SetPixelAccessor method. This accessor is meant to be used only for VectorImage and not for Image. Prior to use, the start of the VectorImage buffer must also be set with the SetBegin method.

See also
DefaultVectorPixelAccessor
DefaultPixelAccessor
DefaultPixelAccessorFunctor
Note
This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.

Definition at line 46 of file itkDefaultVectorPixelAccessorFunctor.h.

Member Typedef Documentation

◆ ExternalPixelType

template<typename TImageType >
using itk::DefaultVectorPixelAccessorFunctor< TImageType >::ExternalPixelType = typename ImageType::PixelType

Definition at line 51 of file itkDefaultVectorPixelAccessorFunctor.h.

◆ ImageType

template<typename TImageType >
using itk::DefaultVectorPixelAccessorFunctor< TImageType >::ImageType = TImageType

Definition at line 49 of file itkDefaultVectorPixelAccessorFunctor.h.

◆ InternalPixelType

template<typename TImageType >
using itk::DefaultVectorPixelAccessorFunctor< TImageType >::InternalPixelType = typename ImageType::InternalPixelType

Definition at line 50 of file itkDefaultVectorPixelAccessorFunctor.h.

◆ PixelAccessorType

template<typename TImageType >
using itk::DefaultVectorPixelAccessorFunctor< TImageType >::PixelAccessorType = typename ImageType::AccessorType

Definition at line 52 of file itkDefaultVectorPixelAccessorFunctor.h.

◆ VectorLengthType

template<typename TImageType >
using itk::DefaultVectorPixelAccessorFunctor< TImageType >::VectorLengthType = unsigned int

Definition at line 53 of file itkDefaultVectorPixelAccessorFunctor.h.

Constructor & Destructor Documentation

◆ DefaultVectorPixelAccessorFunctor()

template<typename TImageType >
itk::DefaultVectorPixelAccessorFunctor< TImageType >::DefaultVectorPixelAccessorFunctor ( )
default

Member Function Documentation

◆ Get()

template<typename TImageType >
ExternalPixelType itk::DefaultVectorPixelAccessorFunctor< TImageType >::Get ( const InternalPixelType input) const
inline

◆ GetVectorLength()

template<typename TImageType >
static VectorLengthType itk::DefaultVectorPixelAccessorFunctor< TImageType >::GetVectorLength ( const ImageType image)
inlinestatic

Definition at line 75 of file itkDefaultVectorPixelAccessorFunctor.h.

◆ Set()

template<typename TImageType >
void itk::DefaultVectorPixelAccessorFunctor< TImageType >::Set ( InternalPixelType output,
const ExternalPixelType input 
) const
inline

◆ SetBegin()

template<typename TImageType >
void itk::DefaultVectorPixelAccessorFunctor< TImageType >::SetBegin ( const InternalPixelType begin)
inline

Set the pointer index to the start of the buffer.

Definition at line 95 of file itkDefaultVectorPixelAccessorFunctor.h.

References itk::DefaultVectorPixelAccessorFunctor< TImageType >::m_Begin.

◆ SetPixelAccessor()

template<typename TImageType >
void itk::DefaultVectorPixelAccessorFunctor< TImageType >::SetPixelAccessor ( const PixelAccessorType accessor)
inline

Set the PixelAccessor. This is set at construction time by the image iterators. The type PixelAccessorType is obtained from the ImageType over which the iterators are templated.

Definition at line 88 of file itkDefaultVectorPixelAccessorFunctor.h.

References itk::DefaultVectorPixelAccessorFunctor< TImageType >::m_PixelAccessor.

◆ SetVectorLength()

template<typename TImageType >
static void itk::DefaultVectorPixelAccessorFunctor< TImageType >::SetVectorLength ( ImageType image,
VectorLengthType  length 
)
inlinestatic

Definition at line 69 of file itkDefaultVectorPixelAccessorFunctor.h.

Member Data Documentation

◆ m_Begin

template<typename TImageType >
InternalPixelType* itk::DefaultVectorPixelAccessorFunctor< TImageType >::m_Begin { nullptr }
private

◆ m_PixelAccessor

template<typename TImageType >
PixelAccessorType itk::DefaultVectorPixelAccessorFunctor< TImageType >::m_PixelAccessor
private

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