ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Attributes | List of all members
itk::DefaultVectorPixelAccessor< TType > Class Template Reference

#include <itkDefaultVectorPixelAccessor.h>

+ Inheritance diagram for itk::DefaultVectorPixelAccessor< TType >:

Detailed Description

template<typename TType>
class itk::DefaultVectorPixelAccessor< TType >

Give access to partial aspects of a type.

DefaultVectorPixelAccessor is specifically meant to provide VectorImage with the same DefaultPixelAccessor interface that DefaultPixelAccessor provides to Image.

The template parameters is the type that is contained in by the elements of a vector.

The class also contains a m_VectorLength parameter, set with the SetVectorLength method to set the length of the vectors. This must be set before the accessor can be used. This is the length of each of the vector containers.

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 50 of file itkDefaultVectorPixelAccessor.h.

Public Types

using ExternalType = VariableLengthVector< TType >
 
using InternalType = TType
 
using VectorLengthType = unsigned int
 

Public Member Functions

 DefaultVectorPixelAccessor ()
 
 DefaultVectorPixelAccessor (VectorLengthType l)
 
ExternalType Get (const InternalType &input, const SizeValueType offset) const
 
VectorLengthType GetVectorLength () const
 
void Set (InternalType &output, const ExternalType &input, const unsigned long offset) const
 
 ~DefaultVectorPixelAccessor ()=default
 
void SetVectorLength (VectorLengthType l)
 

Private Attributes

VectorLengthType m_OffsetMultiplier {0}
 
VectorLengthType m_VectorLength {0}
 

Member Typedef Documentation

template<typename TType>
using itk::DefaultVectorPixelAccessor< TType >::ExternalType = VariableLengthVector< TType >

External type alias. It defines the external aspect that this class will exhibit. Here it is an VariableLengthVector. The container does not manage the memory. In other words it is an array reference with the contents pointing to the actual data in the image.

Definition at line 60 of file itkDefaultVectorPixelAccessor.h.

template<typename TType>
using itk::DefaultVectorPixelAccessor< TType >::InternalType = TType

Internal type alias. It defines the internal real representation of data.

Definition at line 63 of file itkDefaultVectorPixelAccessor.h.

template<typename TType>
using itk::DefaultVectorPixelAccessor< TType >::VectorLengthType = unsigned int

Definition at line 54 of file itkDefaultVectorPixelAccessor.h.

Constructor & Destructor Documentation

template<typename TType>
itk::DefaultVectorPixelAccessor< TType >::DefaultVectorPixelAccessor ( )
inline

Definition at line 96 of file itkDefaultVectorPixelAccessor.h.

template<typename TType>
itk::DefaultVectorPixelAccessor< TType >::DefaultVectorPixelAccessor ( VectorLengthType  l)
inline

Constructor to initialize VectorLength at construction time

Definition at line 99 of file itkDefaultVectorPixelAccessor.h.

template<typename TType>
itk::DefaultVectorPixelAccessor< TType >::~DefaultVectorPixelAccessor ( )
default

Member Function Documentation

template<typename TType>
ExternalType itk::DefaultVectorPixelAccessor< TType >::Get ( const InternalType input,
const SizeValueType  offset 
) const
inline
template<typename TType>
VectorLengthType itk::DefaultVectorPixelAccessor< TType >::GetVectorLength ( ) const
inline
template<typename TType>
void itk::DefaultVectorPixelAccessor< TType >::Set ( InternalType output,
const ExternalType input,
const unsigned long  offset 
) const
inline

Set output using the value in input

Definition at line 66 of file itkDefaultVectorPixelAccessor.h.

template<typename TType>
void itk::DefaultVectorPixelAccessor< TType >::SetVectorLength ( VectorLengthType  l)
inline

Member Data Documentation

template<typename TType>
VectorLengthType itk::DefaultVectorPixelAccessor< TType >::m_OffsetMultiplier {0}
private

Definition at line 109 of file itkDefaultVectorPixelAccessor.h.

template<typename TType>
VectorLengthType itk::DefaultVectorPixelAccessor< TType >::m_VectorLength {0}
private

Definition at line 108 of file itkDefaultVectorPixelAccessor.h.


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