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 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
|
/*=========================================================================
*
* 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 itkFrustumSpatialFunction_h
#define itkFrustumSpatialFunction_h
#include "itkInteriorExteriorSpatialFunction.h"
namespace itk
{
/** \class FrustumSpatialFunctionEnums
*
* \brief enums for FrustumSpatialFunction class.
*
* \ingroup ITKCommon
*/
class FrustumSpatialFunctionEnums
{
public:
/** \class RotationPlane
* \ingroup ITKCommon
*/
enum class RotationPlane : uint8_t
{
RotateInXZPlane = 1,
RotateInYZPlane
};
};
extern ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & out, const FrustumSpatialFunctionEnums::RotationPlane value);
/**
* \class FrustumSpatialFunction
* \brief Spatial function implementation of a truncated pyramid.
*
* Implements a function that returns 0 for points inside or on the surface
* of a truncated pyramid, 1 for points outside the truncated pyramid.
*
* \ingroup SpatialFunctions
*
*
* \ingroup ITKCommon
*/
template <unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
class ITK_TEMPLATE_EXPORT FrustumSpatialFunction : public InteriorExteriorSpatialFunction<VDimension, TInput>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(FrustumSpatialFunction);
/** Standard class type aliases. */
using Self = FrustumSpatialFunction<VDimension, TInput>;
using Superclass = InteriorExteriorSpatialFunction<VDimension, TInput>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
using RotationPlaneEnum = FrustumSpatialFunctionEnums::RotationPlane;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(FrustumSpatialFunction);
/** 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;
/** Rotate the frustum in the XZ or the YZ plane. */
using FrustumRotationPlaneType = RotationPlaneEnum;
#if !defined(ITK_LEGACY_REMOVE)
// We need to expose the enum values at the class level
// for backwards compatibility
static constexpr FrustumRotationPlaneType RotateInXZPlane = RotationPlaneEnum::RotateInXZPlane;
static constexpr FrustumRotationPlaneType RotateInYZPlane = RotationPlaneEnum::RotateInYZPlane;
#endif
/** Evaluates the function at a given position. */
OutputType
Evaluate(const InputType & position) const override;
/** Set/Get the apex of the pyramid. */
itkGetConstMacro(Apex, InputType);
itkSetMacro(Apex, InputType);
/** Set/Get the angle of the pyramid axis with respect to the Z axis. */
itkGetConstMacro(AngleZ, double);
itkSetMacro(AngleZ, double);
/** Set/Get the aperture angle in the X axis. */
itkGetConstMacro(ApertureAngleX, double);
itkSetMacro(ApertureAngleX, double);
/** Set/Get the aperture angle in the Y axis. */
itkGetConstMacro(ApertureAngleY, double);
itkSetMacro(ApertureAngleY, double);
/** Set/Get the top plane distance to the apex. */
itkGetConstMacro(TopPlane, double);
itkSetMacro(TopPlane, double);
/** Set/Get the bottom plane distance to the apex. */
itkGetConstMacro(BottomPlane, double);
itkSetMacro(BottomPlane, double);
/** Set/Get the plane in which the frustum should rotate. */
itkGetConstMacro(RotationPlane, FrustumRotationPlaneType);
itkSetMacro(RotationPlane, FrustumRotationPlaneType);
protected:
FrustumSpatialFunction() = default;
~FrustumSpatialFunction() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
private:
InputType m_Apex{};
double m_AngleZ{ 0.0f };
double m_ApertureAngleX{ 0.0f };
double m_ApertureAngleY{ 0.0f };
double m_TopPlane{ 0.0f };
double m_BottomPlane{ 0.0f };
FrustumRotationPlaneType m_RotationPlane{ RotationPlaneEnum::RotateInXZPlane };
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkFrustumSpatialFunction.hxx"
#endif
#endif
|