itkPointSetBase.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://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 itkPointSetBase_h
#define itkPointSetBase_h
 
#include "itkDataObject.h"
#include "itkVectorContainer.h"
#include <vector>
 
namespace itk
{

 
template <typename TPointsContainer>
class ITK_TEMPLATE_EXPORT PointSetBase : public DataObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PointSetBase);

  using Self = PointSetBase;
  using Superclass = DataObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(PointSetBase);
 
  itkCloneMacro(Self);

  using PointType = typename TPointsContainer::Element;
  using CoordinateType = typename PointType::CoordinateType;
#ifndef ITK_FUTURE_LEGACY_REMOVE
  using CoordRepType ITK_FUTURE_DEPRECATED(
    "ITK 6 discourages using `CoordRepType`. Please use `CoordinateType` instead!") = CoordinateType;
#endif
  using PointIdentifier = typename TPointsContainer::ElementIdentifier;
  using PointsContainer = TPointsContainer;

  using PointsVectorContainer = typename itk::VectorContainer<PointIdentifier, CoordinateType>;
  using PointsVectorContainerPointer = typename PointsVectorContainer::Pointer;

  static constexpr unsigned int PointDimension = PointType::PointDimension;

  using PointsContainerPointer = typename PointsContainer::Pointer;
  using PointsContainerConstPointer = typename PointsContainer::ConstPointer;

  using PointsContainerConstIterator = typename PointsContainer::ConstIterator;
  using PointsContainerIterator = typename PointsContainer::Iterator;

  using RegionType = long;

  itkGetConstMacro(MaximumNumberOfRegions, RegionType);
 
protected:
  PointsContainerPointer m_PointsContainer{};
 
public:
  void
  PassStructure(Self * inputPointSet);

  void
  Initialize() override;

  static constexpr unsigned int
  GetPointDimension()
  {
    return PointDimension;
  }

  PointIdentifier
  GetNumberOfPoints() const;

  void
  SetPoints(PointsContainer *);

  void
  SetPoints(PointsVectorContainer *);

  void
  SetPointsByCoordinates(const std::vector<CoordinateType> & coordinates);

  PointsContainer *
  GetPoints();

  const PointsContainer *
  GetPoints() const;

  void SetPoint(PointIdentifier, PointType);

  bool
  GetPoint(PointIdentifier, PointType *) const;

  PointType GetPoint(PointIdentifier) const;

  void
  UpdateOutputInformation() override;
 
  void
  SetRequestedRegionToLargestPossibleRegion() override;
 
  void
  CopyInformation(const DataObject * data) override;
 
  bool
  RequestedRegionIsOutsideOfTheBufferedRegion() override;
 
  bool
  VerifyRequestedRegion() override;

  void
  SetRequestedRegion(const DataObject * data) override;

  virtual void
  SetRequestedRegion(const RegionType & region);
 
  itkGetConstMacro(RequestedRegion, RegionType);

  virtual void
  SetBufferedRegion(const RegionType & region);
 
  itkGetConstMacro(BufferedRegion, RegionType);
 
protected:
  PointSetBase() = default;

  ~PointSetBase() override = 0;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  LightObject::Pointer
  InternalClone() const override;
 
  // 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{ 1 };
  RegionType m_NumberOfRegions{ 1 };
  RegionType m_RequestedNumberOfRegions{};
  RegionType m_BufferedRegion{ -1 };
  RegionType m_RequestedRegion{ -1 };
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPointSetBase.hxx"
#endif
 
#endif