itkSparseImage.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkSparseImage_h
#define itkSparseImage_h

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

namespace itk
{
template< typename TNode, unsigned int VImageDimension = 2 >
class ITK_TEMPLATE_EXPORT SparseImage:public Image< TNode *, VImageDimension >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(SparseImage);

  using Self = SparseImage;
  using Superclass = Image< TNode *, VImageDimension >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using ConstWeakPointer = WeakPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(SparseImage, Image);

  static constexpr unsigned int ImageDimension = Superclass::ImageDimension;

  using NodeType = TNode;

  using IndexType = typename Superclass::IndexType;

  using NeighborhoodAccessorFunctorType = NeighborhoodAccessorFunctor<Self>;

  using IOPixelType = typename Superclass::IOPixelType;

  using NodeListType = SparseFieldLayer< NodeType >;
  using NodeStoreType = ObjectStore< NodeType >;

  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;
  }

  void Initialize() override;

protected:
  SparseImage();
  ~SparseImage() override = default;

  void PrintSelf(std::ostream & os, Indent indent) const override;

private:
  typename NodeListType::Pointer m_NodeList;

  typename NodeStoreType::Pointer m_NodeStore;

};
} // end namespace itk

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

#endif