ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::SparseImage< TNode, VImageDimension > Class Template Reference

#include <itkSparseImage.h>

+ Inheritance diagram for itk::SparseImage< TNode, VImageDimension >:
+ Collaboration diagram for itk::SparseImage< TNode, VImageDimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using IndexType = typename Superclass::IndexType
 
using IOPixelType = typename Superclass::IOPixelType
 
using NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor< Self >
 
using NodeListType = SparseFieldLayer< NodeType >
 
using NodeStoreType = ObjectStore< NodeType >
 
using NodeType = TNode
 
using Pointer = SmartPointer< Self >
 
using Self = SparseImage
 
using Superclass = Image< TNode *, VImageDimension >
 
- Public Types inherited from itk::Image< TNode *, VImageDimension >
using AccessorFunctorType = DefaultPixelAccessorFunctor< Self >
 
using AccessorType = DefaultPixelAccessor< PixelType >
 
using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using DirectionType = typename Superclass::DirectionType
 
using ImageDimensionType = typename Superclass::ImageDimensionType
 
using IndexType = typename Superclass::IndexType
 
using IndexValueType = typename Superclass::IndexValueType
 
using InternalPixelType = TNode *
 
using IOPixelType = PixelType
 
using NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor< Self >
 
using OffsetType = typename Superclass::OffsetType
 
using OffsetValueType = typename Superclass::OffsetValueType
 
using PixelContainer = ImportImageContainer< SizeValueType, PixelType >
 
using PixelContainerConstPointer = typename PixelContainer::ConstPointer
 
using PixelContainerPointer = typename PixelContainer::Pointer
 
using PixelType = TNode *
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RebindImageType = itk::Image< UPixelType, NUImageDimension >
 
using RegionType = typename Superclass::RegionType
 
using Self = Image
 
using SizeType = typename Superclass::SizeType
 
using SizeValueType = typename Superclass::SizeValueType
 
using SpacingType = typename Superclass::SpacingType
 
using SpacingValueType = typename Superclass::SpacingValueType
 
using Superclass = ImageBase< VImageDimension >
 
using ValueType = TNode *
 
- Public Types inherited from itk::ImageBase< VImageDimension >
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
 
virtual const char * GetNameOfClass () const
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor () const
 
- Public Member Functions inherited from itk::Image< TNode *, VImageDimension >
void Allocate (bool initializePixels=false) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void FillBuffer (const TNode * &value)
 
TNode * & GetPixel (const IndexType &index)
 
const TNode * & GetPixel (const IndexType &index) const
 
void Initialize () override
 
TNode * & operator[] (const IndexType &index)
 
const TNode * & operator[] (const IndexType &index) const
 
void SetPixel (const IndexType &index, const TNode * &value)
 
virtual TNode * * GetBufferPointer ()
 
virtual const TNode * * GetBufferPointer () const
 
PixelContainerGetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
void SetPixelContainer (PixelContainer *container)
 
virtual void Graft (const Self *data)
 
AccessorType GetPixelAccessor ()
 
const AccessorType GetPixelAccessor () const
 
NeighborhoodAccessorFunctorType GetNeighborhoodAccessor ()
 
const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor () const
 
unsigned int GetNumberOfComponentsPerPixel () const override
 
- Public Member Functions inherited from itk::ImageBase< VImageDimension >
virtual void SetOrigin (PointType _arg)
 
virtual void SetOrigin (const double origin[VImageDimension])
 
virtual void SetOrigin (const float origin[VImageDimension])
 
virtual void SetDirection (const DirectionType &direction)
 
virtual const DirectionTypeGetDirection () const
 
virtual const DirectionTypeGetInverseDirection () const
 
virtual const SpacingTypeGetSpacing () const
 
virtual const PointTypeGetOrigin () const
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual const RegionTypeGetRequestedRegion () 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 SpacingType &spacing)
 
virtual void SetSpacing (const double spacing[VImageDimension])
 
virtual void SetSpacing (const float spacing[VImageDimension])
 
template<typename TCoordRep >
IndexType TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep >
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
template<typename TIndexRep , typename TCoordRep >
ContinuousIndex< TIndexRep, VImageDimension > TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep , typename TIndexRep >
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
template<typename TCoordRep , typename TIndexRep >
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep , typename TIndexRep >
Point< TCoordRep, VImageDimension > TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TIndexRep, VImageDimension > &index) const
 
template<typename TCoordRep >
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
template<typename TCoordRep >
Point< TCoordRep, VImageDimension > TransformIndexToPhysicalPoint (const IndexType &index) const
 
template<typename TCoordRep >
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
template<typename TVector >
TVector TransformLocalVectorToPhysicalVector (const TVector &inputGradient) const
 
template<typename TCoordRep >
void TransformPhysicalVectorToLocalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
template<typename TVector >
TVector TransformPhysicalVectorToLocalVector (const TVector &inputGradient) const
 
void CopyInformation (const DataObject *data) override
 
void UpdateOutputInformation () override
 
void UpdateOutputData () override
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
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
 
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 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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
 
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::Image< TNode *, VImageDimension >
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 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 ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageBase< VImageDimension >
static constexpr ImageDimensionType ImageDimension = VImageDimension
 
NodeListType::Pointer m_NodeList
 
NodeStoreType::Pointer m_NodeStore
 
NodeTypeAddNode (const IndexType &index)
 
NodeListTypeGetNodeList ()
 
void Initialize () override
 
 SparseImage ()
 
 ~SparseImage () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Image< TNode *, VImageDimension >
void Graft (const DataObject *data) override
 
 Image ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~Image () override=default
 
void ComputeIndexToPhysicalPointMatrices () override
 
- Protected Member Functions inherited from itk::ImageBase< VImageDimension >
 ImageBase ()
 
 ~ImageBase () override=default
 
void ComputeOffsetTable ()
 
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 ()
 
- Protected Attributes inherited from itk::ImageBase< VImageDimension >
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 TNode, unsigned int VImageDimension = 2>
class itk::SparseImage< TNode, VImageDimension >

A storage type for sparse image data.

This class is derived from the Image class. It uses the base class image data for storing pointers to variables of type TNode. The node type must have a member variable m_Index. The node data is stored using the SparseFieldLayer and ObjectStore classes to allow sequential list access to the nodes. This functionality is used in filter classes that process the SparseImage class such as FiniteDifferenceSparseImageFilter. The node type must also have members NodeType* Next and NodeType* Previous. A minimal node class which could be used to create the sparse equivalent of an itk::Image<unsigned char, 2> is shown below:
struct NodeType
{
NodeType* Next;
NodeType* Previous;
unsigned char m_Data;
};
using SparseImageType = itk::SparseImage<NodeType, 2>;
This class provides the method AddNode which allocates a node variable, associates it with the image pixel index (sets m_Index in the node variable) and returns the pointer to the node variable. It is suggested that the user call the FillBuffer method to initialize the image to null pointers before any calls to AddNode. This would allow the user later to distinguish between valid and non-valid pixels.

Definition at line 67 of file itkSparseImage.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 76 of file itkSparseImage.h.

◆ ConstWeakPointer

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::ConstWeakPointer = WeakPointer<const Self>

Definition at line 77 of file itkSparseImage.h.

◆ IndexType

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::IndexType = typename Superclass::IndexType

Types derived from the Superclass

Definition at line 92 of file itkSparseImage.h.

◆ IOPixelType

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::IOPixelType = typename Superclass::IOPixelType

Definition at line 98 of file itkSparseImage.h.

◆ NeighborhoodAccessorFunctorType

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor<Self>

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

Definition at line 96 of file itkSparseImage.h.

◆ NodeListType

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::NodeListType = SparseFieldLayer<NodeType>

The list types for storing the active pixels.

Definition at line 101 of file itkSparseImage.h.

◆ NodeStoreType

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::NodeStoreType = ObjectStore<NodeType>

Definition at line 102 of file itkSparseImage.h.

◆ NodeType

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::NodeType = TNode

The actual sparse pixel type.

Definition at line 89 of file itkSparseImage.h.

◆ Pointer

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::Pointer = SmartPointer<Self>

Definition at line 75 of file itkSparseImage.h.

◆ Self

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::Self = SparseImage

Standard type alias.

Definition at line 73 of file itkSparseImage.h.

◆ Superclass

template<typename TNode , unsigned int VImageDimension = 2>
using itk::SparseImage< TNode, VImageDimension >::Superclass = Image<TNode *, VImageDimension>

Definition at line 74 of file itkSparseImage.h.

Constructor & Destructor Documentation

◆ SparseImage()

template<typename TNode , unsigned int VImageDimension = 2>
itk::SparseImage< TNode, VImageDimension >::SparseImage ( )
protected

The variables for storing the node variables.

◆ ~SparseImage()

template<typename TNode , unsigned int VImageDimension = 2>
itk::SparseImage< TNode, VImageDimension >::~SparseImage ( )
overrideprotecteddefault

The variables for storing the node variables.

Member Function Documentation

◆ AddNode()

template<typename TNode , unsigned int VImageDimension = 2>
NodeType* itk::SparseImage< TNode, VImageDimension >::AddNode ( const IndexType index)
inline

This function should be used to allocate memory for a variable at the desired pixel location.

Definition at line 123 of file itkSparseImage.h.

◆ CreateAnother()

template<typename TNode , unsigned int VImageDimension = 2>
virtual::itk::LightObject::Pointer itk::SparseImage< TNode, 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 >.

◆ GetNameOfClass()

template<typename TNode , unsigned int VImageDimension = 2>
virtual const char* itk::SparseImage< TNode, VImageDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Image< TNode *, VImageDimension >.

◆ GetNeighborhoodAccessor() [1/2]

template<typename TNode , unsigned int VImageDimension = 2>
NeighborhoodAccessorFunctorType itk::SparseImage< TNode, VImageDimension >::GetNeighborhoodAccessor ( )
inline

Return the NeighborhoodAccessor functor. This method is called by the neighborhood iterators.

Definition at line 107 of file itkSparseImage.h.

◆ GetNeighborhoodAccessor() [2/2]

template<typename TNode , unsigned int VImageDimension = 2>
const NeighborhoodAccessorFunctorType itk::SparseImage< TNode, VImageDimension >::GetNeighborhoodAccessor ( ) const
inline

Return the NeighborhoodAccessor functor. This method is called by the neighborhood iterators.

Definition at line 115 of file itkSparseImage.h.

◆ GetNodeList()

template<typename TNode , unsigned int VImageDimension = 2>
NodeListType* itk::SparseImage< TNode, VImageDimension >::GetNodeList ( )
inline

This function returns the allocated node list which can be used to iterate through the valid nodes.

Definition at line 136 of file itkSparseImage.h.

◆ Initialize()

template<typename TNode , unsigned int VImageDimension = 2>
void itk::SparseImage< TNode, VImageDimension >::Initialize ( )
overridevirtual

This function initializes the m_NodeList and m_NodeStore variables, and calls the superclass Initialize method.

Reimplemented from itk::ImageBase< VImageDimension >.

◆ New()

template<typename TNode , unsigned int VImageDimension = 2>
static Pointer itk::SparseImage< TNode, VImageDimension >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TNode , unsigned int VImageDimension = 2>
void itk::SparseImage< TNode, VImageDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

The variables for storing the node variables.

Reimplemented from itk::ImageBase< VImageDimension >.

Member Data Documentation

◆ ImageDimension

template<typename TNode , unsigned int VImageDimension = 2>
constexpr unsigned int itk::SparseImage< TNode, VImageDimension >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Dimension of the image.

Definition at line 86 of file itkSparseImage.h.

◆ m_NodeList

template<typename TNode , unsigned int VImageDimension = 2>
NodeListType::Pointer itk::SparseImage< TNode, VImageDimension >::m_NodeList
private

The variables for storing the node variables.

Definition at line 155 of file itkSparseImage.h.

◆ m_NodeStore

template<typename TNode , unsigned int VImageDimension = 2>
NodeStoreType::Pointer itk::SparseImage< TNode, VImageDimension >::m_NodeStore
private

The variables for storing the node variables.

Definition at line 157 of file itkSparseImage.h.


The documentation for this class was generated from the following file:
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::SparseImage
A storage type for sparse image data.
Definition: itkSparseImage.h:67
itk::SparseImage::NodeType
TNode NodeType
Definition: itkSparseImage.h:89