itkSparseImage.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSparseImage.h,v $
  Language:  C++
  Date:      $Date: 2009-03-03 15:09:32 $
  Version:   $Revision: 1.11 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkSparseImage_h
#define __itkSparseImage_h

#include "itkImage.h"
#include "itkSparseFieldLayer.h"
#include "itkObjectStore.h"

namespace itk {
 
template <class TNode, unsigned int VImageDimension=2>
class ITK_EXPORT SparseImage : public Image <TNode*, VImageDimension>
{
public:
  typedef SparseImage                     Self;
  typedef Image <TNode*, VImageDimension> Superclass;
  typedef SmartPointer<Self>              Pointer;
  typedef SmartPointer<const Self>        ConstPointer;
  typedef WeakPointer<const Self>         ConstWeakPointer;
  
  itkNewMacro(Self);

  itkTypeMacro(SparseImage, Image);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      Superclass::ImageDimension);

  typedef TNode NodeType;

  typedef typename Superclass::IndexType IndexType;

  typedef NeighborhoodAccessorFunctor< Self > 
                                            NeighborhoodAccessorFunctorType;

  typedef typename Superclass::IOPixelType  IOPixelType;

  typedef SparseFieldLayer <NodeType> NodeListType;
  typedef ObjectStore      <NodeType> NodeStoreType;

  NeighborhoodAccessorFunctorType GetNeighborhoodAccessor() 
    { return NeighborhoodAccessorFunctorType(); }
  
  const NeighborhoodAccessorFunctorType GetNeighborhoodAccessor() const
    { return NeighborhoodAccessorFunctorType(); }
  
  NodeType *AddNode(const IndexType &index)
    {
    m_NodeList->PushFront(m_NodeStore->Borrow());
    NodeType *node = m_NodeList->Front();
    node->m_Index=index;
    this->SetPixel(index,node);
    return node;
    }

  NodeListType* GetNodeList() 
    {
    return m_NodeList;
    }

  virtual void Initialize();
  
protected:
  SparseImage();
  ~SparseImage() {};
  
  void PrintSelf(std::ostream& os, Indent indent) const;
  
private:
  typename NodeListType::Pointer     m_NodeList;
  typename NodeStoreType::Pointer    m_NodeStore;
  
  SparseImage(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
};

}// end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSparseImage.txx"
#endif

#endif