rtkBoxShape.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK 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
 *
 *         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 rtkBoxShape_h
#define rtkBoxShape_h

#include "RTKExport.h"
#include "rtkMacro.h"
#include "rtkConvexShape.h"

#include <itkImageBase.h>

namespace rtk
{

class RTK_EXPORT BoxShape : public ConvexShape
{
public:
  using Self = BoxShape;
  using Superclass = ConvexShape;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  static constexpr unsigned int Dimension = Superclass::Dimension;
  using ScalarType = Superclass::ScalarType;
  using PointType = Superclass::PointType;
  using VectorType = Superclass::VectorType;
  using RotationMatrixType = Superclass::RotationMatrixType;
  using ImageBaseType = itk::ImageBase<Dimension>;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(BoxShape);

  bool
  IsInside(const PointType & point) const override;

  bool
  IsIntersectedByRay(const PointType &  rayOrigin,
                     const VectorType & rayDirection,
                     ScalarType &       nearDist,
                     ScalarType &       farDist) const override;

  void
  Rescale(const VectorType & r) override;

  void
  Translate(const VectorType & t) override;

  void
  Rotate(const RotationMatrixType & r) override;

  itkGetConstMacro(BoxMin, PointType);
  itkSetMacro(BoxMin, PointType);

  itkGetConstMacro(BoxMax, PointType);
  itkSetMacro(BoxMax, PointType);

  itkGetConstMacro(Direction, RotationMatrixType);
  itkSetMacro(Direction, RotationMatrixType);

  itk::LightObject::Pointer
  InternalClone() const override;

  void
  SetBoxFromImage(const ImageBaseType * img, bool bWithExternalHalfPixelBorder = true);

private:
  BoxShape();

  PointType          m_BoxMin;
  PointType          m_BoxMax;
  RotationMatrixType m_Direction;
};

} // end namespace rtk

#endif