itkPointSet.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef __itkPointSet_h
#define __itkPointSet_h

#include "itkDataObject.h"
#include "itkDefaultStaticMeshTraits.h"
#include <vector>
#include <set>

namespace itk
{
template< typename TPointSet >
struct GetPointSetDimension {
  itkStaticConstMacro(PointDimension, unsigned int,  TPointSet::PointDimension);
};

template<
  typename TPixelType,
  unsigned int VDimension = 3,
  typename TMeshTraits = DefaultStaticMeshTraits< TPixelType, VDimension, VDimension >
  >
class ITK_EXPORT PointSet:public DataObject
{
public:
  typedef PointSet                   Self;
  typedef DataObject                 Superclass;
  typedef SmartPointer< Self >       Pointer;
  typedef SmartPointer< const Self > ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(PointSet, Object);

  typedef TMeshTraits                    MeshTraits;
  typedef typename MeshTraits::PixelType PixelType;

  typedef typename MeshTraits::CoordRepType       CoordRepType;
  typedef typename MeshTraits::PointIdentifier    PointIdentifier;
  typedef typename MeshTraits::PointType          PointType;
  typedef typename MeshTraits::PointsContainer    PointsContainer;
  typedef typename MeshTraits::PointDataContainer PointDataContainer;

  itkStaticConstMacro(PointDimension, unsigned int,
                      TMeshTraits::PointDimension);

  typedef typename PointsContainer::Pointer         PointsContainerPointer;
  typedef typename PointsContainer::ConstPointer    PointsContainerConstPointer;
  typedef typename PointDataContainer::Pointer      PointDataContainerPointer;
  typedef typename PointDataContainer::ConstPointer PointDataContainerConstPointer;

  typedef typename PointsContainer::ConstIterator    PointsContainerConstIterator;
  typedef typename PointsContainer::Iterator         PointsContainerIterator;
  typedef typename PointDataContainer::ConstIterator PointDataContainerIterator;

  typedef long RegionType;

  itkGetConstMacro(MaximumNumberOfRegions, RegionType);
protected:

  PointsContainerPointer m_PointsContainer;

  PointDataContainerPointer m_PointDataContainer;

public:
  void PassStructure(Self *inputPointSet);

  virtual void Initialize(void);

  PointIdentifier GetNumberOfPoints(void) const;

  void SetPoints(PointsContainer *);

  PointsContainer * GetPoints(void);

  const PointsContainer * GetPoints(void) const;

  void SetPointData(PointDataContainer *);

  PointDataContainer * GetPointData(void);

  const PointDataContainer * GetPointData(void) const;

  void SetPoint(PointIdentifier, PointType);
  bool GetPoint(PointIdentifier, PointType *) const;
  PointType GetPoint(PointIdentifier) const;

  void SetPointData(PointIdentifier, PixelType);
  bool GetPointData(PointIdentifier, PixelType *) const;

  virtual void UpdateOutputInformation();

  virtual void SetRequestedRegionToLargestPossibleRegion();

  virtual void CopyInformation(const DataObject *data);

  virtual void Graft(const DataObject *data);

  virtual bool RequestedRegionIsOutsideOfTheBufferedRegion();

  virtual bool VerifyRequestedRegion();

  virtual void SetRequestedRegion(const DataObject *data);

  virtual void SetRequestedRegion(const RegionType & region);

  itkGetConstMacro(RequestedRegion, RegionType);

  virtual void SetBufferedRegion(const RegionType & region);

  itkGetConstMacro(BufferedRegion, RegionType);
protected:
  PointSet();
  ~PointSet() {}
  virtual void PrintSelf(std::ostream & os, Indent indent) const;

  // If the RegionType is ITK_UNSTRUCTURED_REGION, then the following
  // variables represent the maximum number of region that the data
  // object can be broken into, which region out of how many is
  // currently in the buffered region, and the number of regions and
  // the specific region requested for the update. Data objects that
  // do not support any division of the data can simply leave the
  // MaximumNumberOfRegions as 1. The RequestedNumberOfRegions and
  // RequestedRegion are used to define the currently requested
  // region. The LargestPossibleRegion is always requested region = 0
  // and number of regions = 1;
  RegionType m_MaximumNumberOfRegions;
  RegionType m_NumberOfRegions;
  RegionType m_RequestedNumberOfRegions;
  RegionType m_BufferedRegion;
  RegionType m_RequestedRegion;
private:
  PointSet(const Self &);       //purposely not implemented
  void operator=(const Self &); //purposely not implemented
};                              // End Class: PointSet
} // end namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_PointSet(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                            \
  {                                                        \
  _( 2 ( class EXPORT PointSet< ITK_TEMPLATE_2 TypeX > ) ) \
  namespace Templates                                      \
  {                                                        \
  typedef PointSet< ITK_TEMPLATE_2 TypeX >                 \
  PointSet##TypeY;                                       \
  }                                                        \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkPointSet+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkPointSet.hxx"
#endif

/*
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPointSet.hxx"
#endif
*/

#endif