ITK  5.4.0
Insight Toolkit
itkTorusInteriorExteriorSpatialFunction.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * https://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkTorusInteriorExteriorSpatialFunction_h
19 #define itkTorusInteriorExteriorSpatialFunction_h
20 
21 #include "vnl/vnl_vector.h"
23 #include "itkCovariantVector.h"
24 
25 namespace itk
26 {
39 template <unsigned int VDimension = 3, typename TInput = Point<double, VDimension>>
40 class ITK_TEMPLATE_EXPORT TorusInteriorExteriorSpatialFunction
41  : public InteriorExteriorSpatialFunction<VDimension, TInput>
42 {
43 public:
44  ITK_DISALLOW_COPY_AND_MOVE(TorusInteriorExteriorSpatialFunction);
45 
51 
53  itkOverrideGetNameOfClassMacro(TorusInteriorExteriorSpatialFunction);
54 
56  itkNewMacro(Self);
57 
59  using typename Superclass::InputType;
60 
62  using typename Superclass::OutputType;
63 
66  Evaluate(const InputType & position) const override;
67 
70  itkGetConstMacro(Origin, InputType);
71  itkSetMacro(Origin, InputType);
75  itkGetConstMacro(MajorRadius, double);
76  itkSetMacro(MajorRadius, double);
80  itkGetConstMacro(MinorRadius, double);
81  itkSetMacro(MinorRadius, double);
84 protected:
86  ~TorusInteriorExteriorSpatialFunction() override = default;
87  void
88  PrintSelf(std::ostream & os, Indent indent) const override;
89 
90 private:
91  InputType m_Origin{};
92  double m_MajorRadius{ 3.0 };
93  double m_MinorRadius{ 1.0 };
94 };
95 } // end namespace itk
96 
97 #ifndef ITK_MANUAL_INSTANTIATION
98 # include "itkTorusInteriorExteriorSpatialFunction.hxx"
99 #endif
100 
101 #endif
itkCovariantVector.h
itk::InteriorExteriorSpatialFunction
Returns whether or not a location is "inside" or "outside" a function.
Definition: itkInteriorExteriorSpatialFunction.h:49
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::FunctionBase< TInput, bool >::OutputType
bool OutputType
Definition: itkFunctionBase.h:62
itk::SpatialFunction< bool, VDimension, TInput >
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itkInteriorExteriorSpatialFunction.h
itk::FunctionBase< TInput, bool >::InputType
TInput InputType
Definition: itkFunctionBase.h:59
itk::TorusInteriorExteriorSpatialFunction
Spatial function implementation of torus symmetric about the z-axis in 3D.
Definition: itkTorusInteriorExteriorSpatialFunction.h:40