ITK  4.13.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::VectorImage< TPixelType, VImageDimension > Class Template Reference

#include <itkImageAlgorithm.h>

+ Inheritance diagram for itk::VectorImage< TPixelType, VImageDimension >:
+ Collaboration diagram for itk::VectorImage< TPixelType, VImageDimension >:

Detailed Description

template<typename TPixelType, unsigned int VImageDimension>
class itk::VectorImage< TPixelType, VImageDimension >

Templated n-dimensional vector image class.

This class differs from Image in that it is intended to represent multiple images. Each pixel represents k measurements, each of datatype TPixel. The memory organization of the resulting image is as follows: ... Pi0 Pi1 Pi2 Pi3 P(i+1)0 P(i+1)1 P(i+1)2 P(i+1)3 P(i+2)0 ... where Pi0 represents the 0th measurement of the pixel at index i.

Conceptually, a VectorImage< TPixel, 3 > is the same as a Image< VariableLengthVector< TPixel >, 3 >. The difference lies in the memory organization. The latter results in a fragmented organization with each location in the Image holding a pointer to an VariableLengthVector holding the actual pixel. The former stores the k pixels instead of a pointer reference, which apart from avoiding fragmentation of memory also avoids storing a 8 bytes of pointer reference for each pixel. The parameter k can be set using SetVectorLength.

The API of the class is such that it returns a pixeltype VariableLengthVector< TPixel > when queried, with the data internally pointing to the buffer. (the container does not manage the memory). Similarly SetPixel calls can be made with VariableLengthVector< TPixel >.

The API of this class is similar to Image.

Caveats:
When using Iterators on this image, you cannot use the it.Value(). You must use Set/Get() methods instead.
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.
See Also
DefaultVectorPixelAccessor
DefaultVectorPixelAccessorFunctor
VectorImageToImagePixelAccessor
VectorImageToImageAdaptor
Image
ImportImageContainer
Wiki Examples:
Examples:
Examples/Filtering/DiffusionTensor3DReconstructionImageFilter.cxx, Examples/Statistics/BayesianClassifier.cxx, WikiExamples/ImageProcessing/UnaryFunctorImageFilter.cxx, WikiExamples/IO/ReadVectorImage.cxx, WikiExamples/Statistics/ImageToHistogramFilterVectorImage.cxx, WikiExamples/VectorImages/ImageToVectorImageFilter.cxx, WikiExamples/VectorImages/VectorImage.cxx, WikiExamples/VectorImages/VectorImageToImageAdaptor.cxx, WikiExamples/VectorImages/VectorIndexSelectionCastImageFilter.cxx, WikiExamples/VectorImages/VectorMagnitudeImageFilter.cxx, and WikiExamples/VectorImages/VectorNeighborhoodIterator.cxx.

Definition at line 40 of file itkImageAlgorithm.h.

Classes

struct  Rebind
 

Public Types

typedef
DefaultVectorPixelAccessorFunctor
< Self
AccessorFunctorType
 
typedef
DefaultVectorPixelAccessor
< InternalPixelType
AccessorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef Superclass::DirectionType DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::IndexValueType IndexValueType
 
typedef TPixel InternalPixelType
 
typedef InternalPixelType IOPixelType
 
typedef
VectorImageNeighborhoodAccessorFunctor
< Self
NeighborhoodAccessorFunctorType
 
typedef Superclass::OffsetType OffsetType
 
typedef Superclass::OffsetValueType OffsetValueType
 
typedef ImportImageContainer
< SizeValueType,
InternalPixelType
PixelContainer
 
typedef
PixelContainer::ConstPointer 
PixelContainerConstPointer
 
typedef PixelContainer::Pointer PixelContainerPointer
 
typedef VariableLengthVector
< TPixel > 
PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef Superclass::RegionType RegionType
 
typedef VectorImage Self
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SpacingType SpacingType
 
typedef ImageBase
< VImageDimension > 
Superclass
 
typedef PixelType ValueType
 
typedef unsigned int VectorLengthType
 
- Public Types inherited from itk::ImageBase< VImageDimension >
typedef SmartPointer< const SelfConstPointer
 
typedef Matrix
< SpacePrecisionType,
VImageDimension,
VImageDimension > 
DirectionType
 
typedef unsigned int ImageDimensionType
 
typedef Index< VImageDimension > IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef Offset< VImageDimension > OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef SmartPointer< SelfPointer
 
typedef Point< PointValueType,
VImageDimension > 
PointType
 
typedef SpacePrecisionType PointValueType
 
typedef ImageRegion
< VImageDimension > 
RegionType
 
typedef ImageBase Self
 
typedef Size< VImageDimension > SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef Vector
< SpacingValueType,
VImageDimension > 
SpacingType
 
typedef SpacePrecisionType SpacingValueType
 
typedef DataObject Superclass
 
- Public Types inherited from itk::DataObject
typedef SmartPointer< const SelfConstPointer
 
typedef std::string DataObjectIdentifierType
 
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
 
typedef SmartPointer< SelfPointer
 
typedef DataObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void Allocate (bool UseDefaultConstructor=false) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void FillBuffer (const PixelType &value)
 
virtual const char * GetNameOfClass () const
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const
NeighborhoodAccessorFunctorType 
GetNeighborhoodAccessor () const
 
virtual unsigned int GetNumberOfComponentsPerPixel () const override
 
const PixelType GetPixel (const IndexType &index) const
 
PixelType GetPixel (const IndexType &index)
 
AccessorType GetPixelAccessor (void)
 
const AccessorType GetPixelAccessor (void) const
 
PixelContainerGetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
virtual void Graft (const Self *data)
 
virtual void Initialize () override
 
PixelType operator[] (const IndexType &index)
 
const PixelType operator[] (const IndexType &index) const
 
virtual void SetNumberOfComponentsPerPixel (unsigned int n) override
 
void SetPixel (const IndexType &index, const PixelType &value)
 
void SetPixelContainer (PixelContainer *container)
 
InternalPixelTypeGetBufferPointer ()
 
const InternalPixelTypeGetBufferPointer () const
 
virtual void SetVectorLength (VectorLengthType _arg)
 
virtual const VectorLengthTypeGetVectorLength () const
 
- Public Member Functions inherited from itk::ImageBase< VImageDimension >
OffsetValueType ComputeOffset (const IndexType &ind) const
 
virtual void CopyInformation (const DataObject *data) override
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual const DirectionTypeGetDirection () const
 
virtual const DirectionTypeGetInverseDirection () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual const PointTypeGetOrigin () const
 
virtual const RegionTypeGetRequestedRegion () const
 
virtual const SpacingTypeGetSpacing () const
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual void SetDirection (const DirectionType &direction)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual void SetRegions (const SizeType &size)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegion (const DataObject *data) override
 
virtual void SetRequestedRegionToLargestPossibleRegion () override
 
template<typename TCoordRep >
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
template<typename TCoordRep , typename TIndexRep >
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
template<typename TCoordRep >
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
template<typename TCoordRep >
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
virtual void UpdateOutputData () override
 
virtual void UpdateOutputInformation () override
 
virtual bool VerifyRequestedRegion () override
 
virtual void SetOrigin (PointType _arg)
 
virtual void SetOrigin (const double origin[VImageDimension])
 
virtual void SetOrigin (const float origin[VImageDimension])
 
virtual void SetRegions (const RegionType &region)
 
const OffsetValueTypeGetOffsetTable () const
 
IndexType ComputeIndex (OffsetValueType offset) const
 
virtual void SetSpacing (const SpacingType &spacing)
 
virtual void SetSpacing (const double spacing[VImageDimension])
 
virtual void SetSpacing (const float spacing[VImageDimension])
 
template<typename TCoordRep , typename TIndexRep >
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep >
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
 
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void PrepareForNewData ()
 
virtual void PropagateRequestedRegion ()
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
virtual void Update ()
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageBase< VImageDimension >
static unsigned int GetImageDimension ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::DataObject
static bool GetGlobalReleaseDataFlag ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = VImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< VImageDimension >
static const ImageDimensionType ImageDimension = VImageDimension
 

Protected Member Functions

virtual void Graft (const DataObject *data) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorImage ()
 
virtual ~VectorImage () override
 
- Protected Member Functions inherited from itk::ImageBase< VImageDimension >
virtual void ComputeIndexToPhysicalPointMatrices ()
 
void ComputeOffsetTable ()
 
 ImageBase ()
 
virtual void InitializeBufferedRegion ()
 
 ~ImageBase () override
 
OffsetValueType FastComputeOffset (const IndexType &ind) const
 
IndexType FastComputeIndex (OffsetValueType offset) const
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
virtual void PropagateResetPipeline ()
 
virtual ~DataObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

PixelContainerPointer m_Buffer
 
VectorLengthType m_VectorLength
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageBase< VImageDimension >
DirectionType m_Direction
 
DirectionType m_IndexToPhysicalPoint
 
DirectionType m_InverseDirection
 
PointType m_Origin
 
DirectionType m_PhysicalPointToIndex
 
SpacingType m_Spacing
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TPixelType, unsigned int VImageDimension>
typedef DefaultVectorPixelAccessorFunctor< Self > itk::VectorImage< TPixelType, VImageDimension >::AccessorFunctorType

Functor to provide a common API between DefaultPixelAccessor and DefaultVectorPixelAccessor

Definition at line 120 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef DefaultVectorPixelAccessor< InternalPixelType > itk::VectorImage< TPixelType, VImageDimension >::AccessorType

Accessor type that convert data between internal and external representations.

Definition at line 116 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef SmartPointer< const Self > itk::VectorImage< TPixelType, VImageDimension >::ConstPointer

Definition at line 89 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef WeakPointer< const Self > itk::VectorImage< TPixelType, VImageDimension >::ConstWeakPointer

Definition at line 90 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::DirectionType itk::VectorImage< TPixelType, VImageDimension >::DirectionType

Direction typedef support. A matrix of direction cosines.

Definition at line 147 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::IndexType itk::VectorImage< TPixelType, VImageDimension >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 134 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::IndexValueType itk::VectorImage< TPixelType, VImageDimension >::IndexValueType

Definition at line 135 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef TPixel itk::VectorImage< TPixelType, VImageDimension >::InternalPixelType

This is the actual pixel type contained in the buffer. Each vector pixel is composed of 'm_VectorLength' contiguous InternalPixelType.

Definition at line 107 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef InternalPixelType itk::VectorImage< TPixelType, VImageDimension >::IOPixelType

Definition at line 112 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef VectorImageNeighborhoodAccessorFunctor< Self > itk::VectorImage< TPixelType, VImageDimension >::NeighborhoodAccessorFunctorType

Typedef for the functor used to access a neighborhood of pixel pointers.

Definition at line 125 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::OffsetType itk::VectorImage< TPixelType, VImageDimension >::OffsetType

Offset typedef support. An offset is used to access pixel values.

Definition at line 138 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::OffsetValueType itk::VectorImage< TPixelType, VImageDimension >::OffsetValueType

Offset typedef (relative position between indices)

Definition at line 166 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef ImportImageContainer< SizeValueType, InternalPixelType > itk::VectorImage< TPixelType, VImageDimension >::PixelContainer

Container used to store pixels in the image.

Definition at line 144 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef PixelContainer::ConstPointer itk::VectorImage< TPixelType, VImageDimension >::PixelContainerConstPointer

Definition at line 163 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef PixelContainer::Pointer itk::VectorImage< TPixelType, VImageDimension >::PixelContainerPointer

A pointer to the pixel container.

Definition at line 162 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef VariableLengthVector< TPixel > itk::VectorImage< TPixelType, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations. This is not the actual pixel type contained in the buffer, ie m_Buffer. The image exhibits an external API of an VariableLengthVector< T > and internally stores its data as type T.

Definition at line 96 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef SmartPointer< Self > itk::VectorImage< TPixelType, VImageDimension >::Pointer

Definition at line 88 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::PointType itk::VectorImage< TPixelType, VImageDimension >::PointType

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Definition at line 159 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::RegionType itk::VectorImage< TPixelType, VImageDimension >::RegionType

Region typedef support. A region is used to specify a subset of an image.

Definition at line 151 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef VectorImage itk::VectorImage< TPixelType, VImageDimension >::Self

Standard class typedefs

Definition at line 86 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::SizeType itk::VectorImage< TPixelType, VImageDimension >::SizeType

Size typedef support. A size is used to define region bounds.

Definition at line 141 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef Superclass::SpacingType itk::VectorImage< TPixelType, VImageDimension >::SpacingType

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Definition at line 155 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef ImageBase< VImageDimension > itk::VectorImage< TPixelType, VImageDimension >::Superclass

Definition at line 87 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef PixelType itk::VectorImage< TPixelType, VImageDimension >::ValueType

Typedef alias for PixelType

Definition at line 110 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
typedef unsigned int itk::VectorImage< TPixelType, VImageDimension >::VectorLengthType

Definition at line 168 of file itkVectorImage.h.

Constructor & Destructor Documentation

template<typename TPixelType, unsigned int VImageDimension>
itk::VectorImage< TPixelType, VImageDimension >::VectorImage ( )
protected
template<typename TPixelType, unsigned int VImageDimension>
virtual itk::VectorImage< TPixelType, VImageDimension >::~VectorImage ( )
inlineoverrideprotectedvirtual

Definition at line 341 of file itkVectorImage.h.

Member Function Documentation

template<typename TPixelType, unsigned int VImageDimension>
virtual void itk::VectorImage< TPixelType, VImageDimension >::Allocate ( bool  UseDefaultConstructor = false)
overridevirtual

Allocate the image memory. The size of the image must already be set, e.g. by calling SetRegions().

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
virtual::itk::LightObject::Pointer itk::VectorImage< TPixelType, VImageDimension >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
void itk::VectorImage< TPixelType, VImageDimension >::FillBuffer ( const PixelType value)

Fill the image buffer with a value. Be sure to call Allocate() first.

template<typename TPixelType, unsigned int VImageDimension>
InternalPixelType* itk::VectorImage< TPixelType, VImageDimension >::GetBufferPointer ( )
inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 277 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
const InternalPixelType* itk::VectorImage< TPixelType, VImageDimension >::GetBufferPointer ( ) const
inline

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

Definition at line 281 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
virtual const char* itk::VectorImage< TPixelType, VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
NeighborhoodAccessorFunctorType itk::VectorImage< TPixelType, VImageDimension >::GetNeighborhoodAccessor ( )
inline

Return the NeighborhoodAccessor functor

Definition at line 316 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
const NeighborhoodAccessorFunctorType itk::VectorImage< TPixelType, VImageDimension >::GetNeighborhoodAccessor ( ) const
inline

Return the NeighborhoodAccessor functor

Definition at line 322 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
virtual unsigned int itk::VectorImage< TPixelType, VImageDimension >::GetNumberOfComponentsPerPixel ( ) const
overridevirtual

Get/Set the number of components each pixel has, ie the VectorLength

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
const PixelType itk::VectorImage< TPixelType, VImageDimension >::GetPixel ( const IndexType index) const
inline

Get a pixel (read only version).

For efficiency, this function does not check that the image has actually been allocated yet. Note that the method returns a pixel on the stack.

Definition at line 231 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
PixelType itk::VectorImage< TPixelType, VImageDimension >::GetPixel ( const IndexType index)
inline

Get a "reference" to a pixel. This result cannot be used as an lvalue because the pixel is converted on the fly to a VariableLengthVector.

To use the results to modify this image, return value optimization must be relied upon.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 249 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
AccessorType itk::VectorImage< TPixelType, VImageDimension >::GetPixelAccessor ( void  )
inline

Return the Pixel Accessor object

Definition at line 310 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
const AccessorType itk::VectorImage< TPixelType, VImageDimension >::GetPixelAccessor ( void  ) const
inline

Return the Pixel Accesor object

Definition at line 313 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
PixelContainer* itk::VectorImage< TPixelType, VImageDimension >::GetPixelContainer ( )
inline

Return a pointer to the container.

Definition at line 288 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
const PixelContainer* itk::VectorImage< TPixelType, VImageDimension >::GetPixelContainer ( ) const
inline

Return a pointer to the container.

Definition at line 291 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
virtual const VectorLengthType& itk::VectorImage< TPixelType, VImageDimension >::GetVectorLength ( ) const
virtual

Set/Get macros for the length of each vector in the vector image

template<typename TPixelType, unsigned int VImageDimension>
virtual void itk::VectorImage< TPixelType, VImageDimension >::Graft ( const Self data)
virtual

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
virtual void itk::VectorImage< TPixelType, VImageDimension >::Graft ( const DataObject data)
overrideprotectedvirtual

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. Subclasses of ImageBase are responsible for copying the pixel container.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
virtual void itk::VectorImage< TPixelType, VImageDimension >::Initialize ( )
overridevirtual

Restore the data object to its initial state. This means releasing memory.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
static Pointer itk::VectorImage< TPixelType, VImageDimension >::New ( )
static

Method for creation through the object factory.

template<typename TPixelType, unsigned int VImageDimension>
PixelType itk::VectorImage< TPixelType, VImageDimension >::operator[] ( const IndexType index)
inline

Access a pixel. This result cannot be used as an lvalue because the pixel is converted on the fly to a VariableLengthVector.

To use the results to modify this image, return value optimization must be relied upon.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 267 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
const PixelType itk::VectorImage< TPixelType, VImageDimension >::operator[] ( const IndexType index) const
inline

Access a pixel.

For efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 273 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
void itk::VectorImage< TPixelType, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
virtual void itk::VectorImage< TPixelType, VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned int  int)
overridevirtual

INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.

Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage

* outputImage->SetNumberOfComponentsPerPixel(
* inputImage->GetNumberOfComponentsPerPixel() )
*
See Also
ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that in the ImageBase implementation, this always returns 1. Image returns the

returned from NumericTraits for the pixel type, and VectorImage

returns the vector length set by the user.

Reimplemented from itk::ImageBase< VImageDimension >.

template<typename TPixelType, unsigned int VImageDimension>
void itk::VectorImage< TPixelType, VImageDimension >::SetPixel ( const IndexType index,
const PixelType value 
)
inline

Set a pixel value.

Allocate() needs to have been called first – for efficiency, this function does not check that the image has actually been allocated yet.

Definition at line 216 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
void itk::VectorImage< TPixelType, VImageDimension >::SetPixelContainer ( PixelContainer container)

Set the container to use. Note that this does not cause the DataObject to be modified.

template<typename TPixelType, unsigned int VImageDimension>
virtual void itk::VectorImage< TPixelType, VImageDimension >::SetVectorLength ( VectorLengthType  _arg)
virtual

Set/Get macros for the length of each vector in the vector image

Member Data Documentation

template<typename TPixelType, unsigned int VImageDimension>
const unsigned int itk::VectorImage< TPixelType, VImageDimension >::ImageDimension = VImageDimension
static

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

Definition at line 131 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
PixelContainerPointer itk::VectorImage< TPixelType, VImageDimension >::m_Buffer
private

Memory for the current buffer.

Definition at line 351 of file itkVectorImage.h.

template<typename TPixelType, unsigned int VImageDimension>
VectorLengthType itk::VectorImage< TPixelType, VImageDimension >::m_VectorLength
private

Length of the "vector pixel"

Definition at line 345 of file itkVectorImage.h.


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