1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
/*=========================================================================
*
* 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 itkTorusInteriorExteriorSpatialFunction_h
#define itkTorusInteriorExteriorSpatialFunction_h
#include "vnl/vnl_vector.h"
#include "itkInteriorExteriorSpatialFunction.h"
#include "itkCovariantVector.h"
namespace itk
{
/**
* \class TorusInteriorExteriorSpatialFunction
* \brief Spatial function implementation of torus symmetric about the z-axis in 3D
*
* Handle with care! May behave in strange ways when used with dimensions other than 3
*
* \ingroup SpatialFunctions
*
*
* \ingroup ITKCommon
*/
template <unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
class ITK_TEMPLATE_EXPORT TorusInteriorExteriorSpatialFunction
: public InteriorExteriorSpatialFunction<VDimension, TInput>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(TorusInteriorExteriorSpatialFunction);
/** Standard class type aliases. */
using Self = TorusInteriorExteriorSpatialFunction;
using Superclass = InteriorExteriorSpatialFunction<VDimension, TInput>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(TorusInteriorExteriorSpatialFunction);
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Input type for the function. */
using typename Superclass::InputType;
/** Output type for the function. */
using typename Superclass::OutputType;
/** Evaluates the function at a given position. */
OutputType
Evaluate(const InputType & position) const override;
/** Set/Get the origin of the torus (the point from which the major
* radius is measured). */
itkGetConstMacro(Origin, InputType);
itkSetMacro(Origin, InputType);
/** Set/Get the major radius of the torus. */
itkGetConstMacro(MajorRadius, double);
itkSetMacro(MajorRadius, double);
/** Set/Get the minor radius of the torus (radius of tube). */
itkGetConstMacro(MinorRadius, double);
itkSetMacro(MinorRadius, double);
protected:
TorusInteriorExteriorSpatialFunction() = default;
~TorusInteriorExteriorSpatialFunction() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
InputType m_Origin{};
double m_MajorRadius{ 3.0 };
double m_MinorRadius{ 1.0 };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkTorusInteriorExteriorSpatialFunction.hxx"
#endif
#endif
|