ITK  5.4.0
Insight Toolkit
itkTubeSpatialObject.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 itkTubeSpatialObject_h
19 #define itkTubeSpatialObject_h
20 
21 #include <list>
22 
25 
26 namespace itk
27 {
41 template <unsigned int TDimension = 3, class TSpatialObjectPointType = TubeSpatialObjectPoint<TDimension>>
42 class ITK_TEMPLATE_EXPORT TubeSpatialObject : public PointBasedSpatialObject<TDimension, TSpatialObjectPointType>
43 {
44 public:
45  ITK_DISALLOW_COPY_AND_MOVE(TubeSpatialObject);
46 
51 
52  using ScalarType = double;
53 
54  using TubePointType = TSpatialObjectPointType;
55  using TubePointListType = std::vector<TubePointType>;
56 
57  using typename Superclass::PointType;
58  using typename Superclass::TransformType;
59  using typename Superclass::SpatialObjectPointType;
62  using typename Superclass::VectorType;
63  using typename Superclass::CovariantVectorType;
64  using typename Superclass::BoundingBoxType;
65 
67  itkNewMacro(Self);
68 
70  itkOverrideGetNameOfClassMacro(TubeSpatialObject);
71 
74  void
75  Clear() override;
76 
78  itkSetMacro(EndRounded, bool);
79  itkGetConstMacro(EndRounded, bool);
80  itkBooleanMacro(EndRounded);
84  bool
85  ComputeTangentsAndNormals();
86 
87 #if !defined(ITK_LEGACY_REMOVE)
88 
89  itkLegacyMacro(bool ComputeTangentAndNormals()) { return ComputeTangentsAndNormals(); }
90 #endif
91 
93  unsigned int
94  RemoveDuplicatePointsInObjectSpace(double minSpacingInObjectSpace = 0);
95 
98  itkSetMacro(ParentPoint, int);
99 
102  itkGetConstMacro(ParentPoint, int);
103 
106  itkSetMacro(Root, bool);
107 
110  itkGetConstMacro(Root, bool);
111 
112  itkBooleanMacro(Root);
113 
119  bool
120  IsInsideInObjectSpace(const PointType & point) const override;
121 
122  /* Avoid hiding the overload that supports depth and name arguments */
123  using Superclass::IsInsideInObjectSpace;
124 
126  void
127  CopyInformation(const DataObject * data) override;
128 
129 protected:
131  void
132  ComputeMyBoundingBox() override;
133 
135  ~TubeSpatialObject() override = default;
136 
138  void
139  PrintSelf(std::ostream & os, Indent indent) const override;
140 
141  virtual typename LightObject::Pointer
142  InternalClone() const override;
143 
144 private:
145  int m_ParentPoint{};
146  bool m_EndRounded{};
147  bool m_Root{};
148 };
149 
150 } // end namespace itk
151 
152 #ifndef ITK_MANUAL_INSTANTIATION
153 # include "itkTubeSpatialObject.hxx"
154 #endif
155 
156 #endif // itkTubeSpatialObject_h
itk::DTITubeSpatialObjectPoint
Point used for a tube definition.
Definition: itkDTITubeSpatialObjectPoint.h:61
itk::PointBasedSpatialObject
This class serves as the base class for point-based spatial objects.
Definition: itkPointBasedSpatialObject.h:37
itk::PointBasedSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >::ScalarType
double ScalarType
Definition: itkPointBasedSpatialObject.h:47
itk::TubeSpatialObject
Representation of a tube based on the spatial object classes.
Definition: itkTubeSpatialObject.h:42
itk::GTest::TypedefsAndConstructors::Dimension2::VectorType
ImageBaseType::SpacingType VectorType
Definition: itkGTestTypedefsAndConstructors.h:53
itk::GTest::TypedefsAndConstructors::Dimension2::PointType
ImageBaseType::PointType PointType
Definition: itkGTestTypedefsAndConstructors.h:51
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >::TubePointListType
std::vector< TubePointType > TubePointListType
Definition: itkTubeSpatialObject.h:55
itk::point
*par Constraints *The filter requires an image with at least two dimensions and a vector *length of at least The theory supports extension to scalar but *the implementation of the itk vector classes do not **The template parameter TRealType must be floating point(float or double) or *a user-defined "real" numerical type with arithmetic operations defined *sufficient to compute derivatives. **\par Performance *This filter will automatically multithread if run with *SetUsePrincipleComponents
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itkTubeSpatialObjectPoint.h
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:61
itkPointBasedSpatialObject.h
itk::VectorContainer
Define a front-end to the STL "vector" container that conforms to the IndexedContainerInterface.
Definition: itkVectorContainer.h:48
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293