itkPolygonSpatialObject.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.
 *
 *=========================================================================*/
#ifndef itkPolygonSpatialObject_h
#define itkPolygonSpatialObject_h
 
#include "itkPointBasedSpatialObject.h"
 
namespace itk
{
template <unsigned int TDimension = 3>
class ITK_TEMPLATE_EXPORT PolygonSpatialObject
  : public PointBasedSpatialObject<TDimension, SpatialObjectPoint<TDimension>>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PolygonSpatialObject);
 
  using Self = PolygonSpatialObject<TDimension>;
  using Superclass = PointBasedSpatialObject<TDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using PolygonPointType = SpatialObjectPoint<TDimension>;
  using PolygonPointListType = std::vector<PolygonPointType>;
 
  using typename Superclass::PointType;
  using typename Superclass::TransformType;
  using typename Superclass::SpatialObjectPointType;
 
  using ObjectDimensionType = unsigned int;
  static constexpr ObjectDimensionType ObjectDimension = TDimension;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(PolygonSpatialObject);

  void
  Clear() override;

  int
  GetOrientationInObjectSpace() const;

  itkSetMacro(ThicknessInObjectSpace, double);

  itkGetConstMacro(ThicknessInObjectSpace, double);

  itkSetMacro(IsClosed, bool);

  itkGetConstMacro(IsClosed, bool);
 
  itkBooleanMacro(IsClosed);

  double
  MeasureAreaInObjectSpace() const;

  double
  MeasureVolumeInObjectSpace() const;

  double
  MeasurePerimeterInObjectSpace() const;

  bool
  IsInsideInObjectSpace(const PointType & point) const override;
 
  /* Avoid hiding the overload that supports depth and name arguments */
  using Superclass::IsInsideInObjectSpace;
 
protected:
  PolygonSpatialObject();
  ~PolygonSpatialObject() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
  typename LightObject::Pointer
  InternalClone() const override;
 
private:
  mutable bool             m_IsClosed{};
  mutable int              m_OrientationInObjectSpace{};
  mutable ModifiedTimeType m_OrientationInObjectSpaceMTime{};
  double                   m_ThicknessInObjectSpace{};
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPolygonSpatialObject.hxx"
#endif
 
#endif // itkPolygonSpatialObject_h