itkFiniteCylinderSpatialFunction.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 itkFiniteCylinderSpatialFunction_h
#define itkFiniteCylinderSpatialFunction_h
 
#include "itkInteriorExteriorSpatialFunction.h"
#include "itkConceptChecking.h"
 
namespace itk
{
 
template <unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
class ITK_TEMPLATE_EXPORT FiniteCylinderSpatialFunction : public InteriorExteriorSpatialFunction<VDimension, TInput>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(FiniteCylinderSpatialFunction);

  using Self = FiniteCylinderSpatialFunction;
  using Superclass = InteriorExteriorSpatialFunction<VDimension, TInput>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(FiniteCylinderSpatialFunction);

  itkNewMacro(Self);

  using typename Superclass::InputType;

  using typename Superclass::OutputType;

  itkGetConstMacro(Center, InputType);
  itkSetMacro(Center, InputType);

  itkGetConstMacro(AxisLength, double);
  itkSetMacro(AxisLength, double);

  itkGetConstMacro(Radius, double);
  itkSetMacro(Radius, double);

  itkGetConstMacro(Orientation, InputType);
  virtual void
  SetOrientation(const InputType _Orientation);

  OutputType
  Evaluate(const InputType & position) const override;
 
  itkConceptMacro(DimensionShouldBe3, (Concept::SameDimension<VDimension, 3u>));
  itkConceptMacro(PointDimensionShouldBe3, (Concept::SameDimension<InputType::Dimension, 3u>));
 
protected:
  FiniteCylinderSpatialFunction();
  ~FiniteCylinderSpatialFunction() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  InputType m_Center{};

  double m_AxisLength{};

  double m_Radius{};

  InputType m_Orientation{};
  InputType m_NormalizedOrientation{};
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkFiniteCylinderSpatialFunction.hxx"
#endif
 
#endif