ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::VectorImageToImageAdaptor< TPixelType, Dimension > Class Template Reference

#include <itkVectorImageToImageAdaptor.h>

+ Inheritance diagram for itk::VectorImageToImageAdaptor< TPixelType, Dimension >:
+ Collaboration diagram for itk::VectorImageToImageAdaptor< TPixelType, Dimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IOPixelType = typename Superclass::IOPixelType
 
using PixelContainer = typename Superclass::PixelContainer
 
using PixelContainerConstPointer = typename Superclass::PixelContainerConstPointer
 
using PixelContainerPointer = typename Superclass::PixelContainerPointer
 
using Pointer = SmartPointer< Self >
 
using Self = VectorImageToImageAdaptor
 
using Superclass = ImageAdaptor< VectorImageType, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
 
using VectorImageType = VectorImage< TPixelType, Dimension >
 
using VectorLengthType = typename VectorImageType::VectorLengthType
 
- Public Types inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
using AccessorFunctorType = typename InternalImageType::AccessorFunctorType::template Rebind< Self >::Type
 
using AccessorType = Accessor::VectorImageToImagePixelAccessor< TPixelType >
 
using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using DirectionType = typename Superclass::DirectionType
 
using IndexType = typename Superclass::IndexType
 
using IndexValueType = typename IndexType::IndexValueType
 
using InternalImageType = VectorImage< TPixelType, Dimension >
 
using InternalPixelPointerType = InternalPixelType *
 
using InternalPixelType = typename Accessor::VectorImageToImagePixelAccessor< TPixelType > ::InternalType
 
using IOPixelType = PixelType
 
using OffsetType = typename Superclass::OffsetType
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelContainer = typename VectorImage< TPixelType, Dimension > ::PixelContainer
 
using PixelContainerConstPointer = typename VectorImage< TPixelType, Dimension > ::PixelContainerConstPointer
 
using PixelContainerPointer = typename VectorImage< TPixelType, Dimension > ::PixelContainerPointer
 
using PixelType = typename Accessor::VectorImageToImagePixelAccessor< TPixelType > ::ExternalType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RebindImageType = itk::Image< UPixelType, NUImageDimension >
 
using RegionType = typename Superclass::RegionType
 
using Self = ImageAdaptor
 
using SizeType = typename Superclass::SizeType
 
using SizeValueType = typename SizeType::SizeValueType
 
using SpacingType = typename Superclass::SpacingType
 
using Superclass = ImageBase< Self::ImageDimension >
 
- Public Types inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = Matrix< SpacePrecisionType, VImageDimension, VImageDimension >
 
using ImageDimensionType = unsigned int
 
using IndexType = Index< VImageDimension >
 
using IndexValueType = typename IndexType::IndexValueType
 
using OffsetType = Offset< VImageDimension >
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< PointValueType, VImageDimension >
 
using PointValueType = SpacePrecisionType
 
using RegionType = ImageRegion< VImageDimension >
 
using Self = ImageBase
 
using SizeType = Size< VImageDimension >
 
using SizeValueType = typename SizeType::SizeValueType
 
using SpacingType = Vector< SpacingValueType, VImageDimension >
 
using SpacingValueType = SpacePrecisionType
 
using Superclass = DataObject
 
- Public Types inherited from itk::DataObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = std::string
 
using DataObjectPointerArraySizeType = std::vector< Pointer >::size_type
 
using Pointer = SmartPointer< Self >
 
using Self = DataObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
VectorLengthType GetExtractComponentIndex () const
 
virtual const char * GetNameOfClass () const
 
void SetExtractComponentIndex (VectorLengthType componentIdx)
 
- Public Member Functions inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
void Allocate (bool initialize=false) override
 
IndexType ComputeIndex (OffsetValueType offset) const
 
void CopyInformation (const DataObject *data) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
const RegionTypeGetBufferedRegion () const override
 
InternalPixelTypeGetBufferPointer ()
 
const InternalPixelTypeGetBufferPointer () const
 
const DirectionTypeGetDirection () const override
 
const RegionTypeGetLargestPossibleRegion () const override
 
ModifiedTimeType GetMTime () const override
 
const OffsetValueTypeGetOffsetTable () const
 
const PointTypeGetOrigin () const override
 
PixelType GetPixel (const IndexType &index) const
 
AccessorTypeGetPixelAccessor ()
 
const AccessorTypeGetPixelAccessor () const
 
PixelContainerPointer GetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
const RegionTypeGetRequestedRegion () const override
 
const SpacingTypeGetSpacing () const override
 
virtual void Graft (const Self *imgData)
 
void Initialize () override
 
void Modified () const override
 
PixelType operator[] (const IndexType &index) const
 
void PropagateRequestedRegion () override
 
void SetBufferedRegion (const RegionType &region) override
 
void SetDirection (const DirectionType &direction) override
 
virtual void SetImage (VectorImage< TPixelType, Dimension > *)
 
void SetLargestPossibleRegion (const RegionType &region) override
 
void SetOrigin (const double *values) override
 
void SetOrigin (const float *values) override
 
void SetOrigin (const PointType values) override
 
void SetPixel (const IndexType &index, const PixelType &value)
 
void SetPixelAccessor (const AccessorType &accessor)
 
void SetPixelContainer (PixelContainer *container)
 
void SetRequestedRegion (const DataObject *data) override
 
void SetRequestedRegion (const RegionType &region) override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
void SetSpacing (const double *values) override
 
void SetSpacing (const float *values) override
 
void SetSpacing (const SpacingType &values) override
 
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, Self::ImageDimension > &index, Point< TCoordRep, Self::ImageDimension > &point) const
 
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, Self::ImageDimension > &point) const
 
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, Self::ImageDimension > &inputGradient, FixedArray< TCoordRep, Self::ImageDimension > &outputGradient) const
 
TVector TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const
 
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, Self::ImageDimension > &point, ContinuousIndex< TCoordRep, Self::ImageDimension > &index) const
 
bool TransformPhysicalPointToIndex (const Point< TCoordRep, Self::ImageDimension > &point, IndexType &index) const
 
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, Self::ImageDimension > &inputGradient, FixedArray< TCoordRep, Self::ImageDimension > &outputGradient) const
 
TVector TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const
 
void Update () override
 
void UpdateOutputData () override
 
void UpdateOutputInformation () override
 
bool VerifyRequestedRegion () override
 
- Public Member Functions inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
virtual void SetOrigin (const double origin[VImageDimension])
 
virtual void SetOrigin (const float origin[VImageDimension])
 
virtual const DirectionTypeGetInverseDirection () const
 
virtual void SetRegions (const RegionType &region)
 
virtual void SetRegions (const SizeType &size)
 
const OffsetValueTypeGetOffsetTable () const
 
OffsetValueType ComputeOffset (const IndexType &ind) const
 
IndexType ComputeIndex (OffsetValueType offset) const
 
virtual void SetSpacing (const double spacing[VImageDimension])
 
virtual void SetSpacing (const float spacing[VImageDimension])
 
IndexType TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point) const
 
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
ContinuousIndex< TIndexRep, VImageDimension > TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point) const
 
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
Point< TCoordRep, VImageDimension > TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
Point< TCoordRep, VImageDimension > TransformIndexToPhysicalPoint (const IndexType &index) const
 
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
TVector TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const
 
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
TVector TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual unsigned int GetNumberOfComponentsPerPixel () const
 
virtual void SetNumberOfComponentsPerPixel (unsigned int)
 
- Public Member Functions inherited from itk::DataObject
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
void SetReleaseDataFlag (bool flag)
 
bool ShouldIReleaseData () const
 
void SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual void PrepareForNewData ()
 
virtual void DataHasBeenGenerated ()
 
- 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 const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
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 Pointer New ()
 
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 ()
 

Protected Member Functions

 VectorImageToImageAdaptor ()=default
 
 ~VectorImageToImageAdaptor () override=default
 
- Protected Member Functions inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
void Graft (const DataObject *data) override
 
 ImageAdaptor ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageAdaptor () override=default
 
- Protected Member Functions inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
 ImageBase ()
 
 ~ImageBase () override=default
 
void ComputeOffsetTable ()
 
virtual void ComputeIndexToPhysicalPointMatrices ()
 
virtual void InitializeBufferedRegion ()
 
OffsetValueType FastComputeOffset (const IndexType &ind) const
 
IndexType FastComputeIndex (OffsetValueType offset) const
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
 ~DataObject () override
 
virtual void PropagateResetPipeline ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
static constexpr ImageDimensionType ImageDimension
 
- Protected Attributes inherited from itk::ImageBase< VectorImage< TPixelType, Dimension > ::ImageDimension >
SpacingType m_Spacing
 
PointType m_Origin
 
DirectionType m_Direction
 
DirectionType m_InverseDirection
 
DirectionType m_IndexToPhysicalPoint
 
DirectionType m_PhysicalPointToIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TPixelType, unsigned int Dimension>
class itk::VectorImageToImageAdaptor< TPixelType, Dimension >

Presents a VectorImage and extracts a component from it into an image.

The class is expected to be templated over a pixel type and dimension. These are the pixel types and dimension of the VectorImage.

The component to extract is set with SetExtractComponentIdx() method.

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.
ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/ImageAdaptors/ViewComponentVectorImageAsScaleImage/Code.cxx.

Definition at line 148 of file itkVectorImageToImageAdaptor.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::ConstPointer = SmartPointer<const Self>

Definition at line 160 of file itkVectorImageToImageAdaptor.h.

◆ IOPixelType

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::IOPixelType = typename Superclass::IOPixelType

Definition at line 173 of file itkVectorImageToImageAdaptor.h.

◆ PixelContainer

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::PixelContainer = typename Superclass::PixelContainer

PixelContainer type alias support Used to construct a container for the pixel data.

Definition at line 170 of file itkVectorImageToImageAdaptor.h.

◆ PixelContainerConstPointer

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::PixelContainerConstPointer = typename Superclass::PixelContainerConstPointer

Definition at line 172 of file itkVectorImageToImageAdaptor.h.

◆ PixelContainerPointer

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::PixelContainerPointer = typename Superclass::PixelContainerPointer

Definition at line 171 of file itkVectorImageToImageAdaptor.h.

◆ Pointer

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::Pointer = SmartPointer<Self>

Definition at line 159 of file itkVectorImageToImageAdaptor.h.

◆ Self

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::Self = VectorImageToImageAdaptor

Standard class type aliases.

Definition at line 155 of file itkVectorImageToImageAdaptor.h.

◆ Superclass

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::Superclass = ImageAdaptor<VectorImageType, Accessor::VectorImageToImagePixelAccessor<TPixelType> >

Definition at line 157 of file itkVectorImageToImageAdaptor.h.

◆ VectorImageType

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::VectorImageType = VectorImage<TPixelType, Dimension>

Definition at line 156 of file itkVectorImageToImageAdaptor.h.

◆ VectorLengthType

template<typename TPixelType , unsigned int Dimension>
using itk::VectorImageToImageAdaptor< TPixelType, Dimension >::VectorLengthType = typename VectorImageType::VectorLengthType

Typedef for the length of vectors in the VectorImage.

Definition at line 176 of file itkVectorImageToImageAdaptor.h.

Constructor & Destructor Documentation

◆ VectorImageToImageAdaptor()

template<typename TPixelType , unsigned int Dimension>
itk::VectorImageToImageAdaptor< TPixelType, Dimension >::VectorImageToImageAdaptor ( )
protecteddefault

◆ ~VectorImageToImageAdaptor()

template<typename TPixelType , unsigned int Dimension>
itk::VectorImageToImageAdaptor< TPixelType, Dimension >::~VectorImageToImageAdaptor ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TPixelType , unsigned int Dimension>
virtual::itk::LightObject::Pointer itk::VectorImageToImageAdaptor< TPixelType, Dimension >::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::Object.

◆ GetExtractComponentIndex()

template<typename TPixelType , unsigned int Dimension>
VectorLengthType itk::VectorImageToImageAdaptor< TPixelType, Dimension >::GetExtractComponentIndex ( ) const
inline

◆ GetNameOfClass()

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

◆ New()

template<typename TPixelType , unsigned int Dimension>
static Pointer itk::VectorImageToImageAdaptor< TPixelType, Dimension >::New ( )
static

Method for creation through the object factory.

◆ SetExtractComponentIndex()

template<typename TPixelType , unsigned int Dimension>
void itk::VectorImageToImageAdaptor< TPixelType, Dimension >::SetExtractComponentIndex ( VectorLengthType  componentIdx)
inline

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