ITK  5.4.0
Insight Toolkit
itkMeshSpatialObject.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 itkMeshSpatialObject_h
19 #define itkMeshSpatialObject_h
20 
21 #include "itkMesh.h"
22 #include "itkSpatialObject.h"
23 
24 namespace itk
25 {
37 template <typename TMesh = Mesh<int>>
38 class ITK_TEMPLATE_EXPORT MeshSpatialObject : public SpatialObject<TMesh::PointDimension>
39 {
40 public:
41  using ScalarType = double;
43 
44  static constexpr unsigned int Dimension = TMesh::PointDimension;
45 
49 
50  using MeshType = TMesh;
51  using MeshPointer = typename MeshType::Pointer;
52  using typename Superclass::TransformType;
53  using typename Superclass::PointType;
54  using typename Superclass::BoundingBoxType;
55 
58 
60  itkNewMacro(Self);
61 
63  itkOverrideGetNameOfClassMacro(MeshSpatialObject);
64 
67  void
68  Clear() override;
69 
71  void
72  SetMesh(MeshType * mesh);
73 
75  MeshType *
76  GetMesh();
77  const MeshType *
78  GetMesh() const;
88  bool
89  IsInsideInObjectSpace(const PointType & point) const override;
90 
91  /* Avoid hiding the overload that supports depth and name arguments */
92  using Superclass::IsInsideInObjectSpace;
93 
96  GetMTime() const override;
97 
98 #if !defined(ITK_LEGACY_REMOVE)
99 
100  itkLegacyMacro(const char * GetPixelTypeName()) { return m_PixelType.c_str(); }
101 #endif
102 
109  itkSetMacro(IsInsidePrecisionInObjectSpace, double);
110  itkGetConstMacro(IsInsidePrecisionInObjectSpace, double);
113 protected:
115  void
116  ComputeMyBoundingBox() override;
117 
119  ~MeshSpatialObject() override = default;
120 
121  void
122  PrintSelf(std::ostream & os, Indent indent) const override;
123 
124  typename LightObject::Pointer
125  InternalClone() const override;
126 
127 private:
128  MeshPointer m_Mesh{};
129 #if !defined(ITK_LEGACY_REMOVE)
130  std::string m_PixelType{};
131 #endif
132  double m_IsInsidePrecisionInObjectSpace{};
133 };
134 
135 } // end namespace itk
136 
137 #ifndef ITK_MANUAL_INSTANTIATION
138 # include "itkMeshSpatialObject.hxx"
139 #endif
140 
141 #endif // itkMeshSpatialObject_h
itk::MeshSpatialObject::PointContainerPointer
typename PointContainerType::Pointer PointContainerPointer
Definition: itkMeshSpatialObject.h:57
Pointer
SmartPointer< Self > Pointer
Definition: itkAddImageFilter.h:93
itk::MeshSpatialObject
Implementation of an Mesh as spatial object.
Definition: itkMeshSpatialObject.h:38
itk::ModifiedTimeType
SizeValueType ModifiedTimeType
Definition: itkIntTypes.h:102
itkSpatialObject.h
itk::MeshSpatialObject::MeshPointer
typename MeshType::Pointer MeshPointer
Definition: itkMeshSpatialObject.h:51
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::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
itkMesh.h
itk::SpatialObject
Implementation of the composite pattern.
Definition: itkSpatialObject.h:58
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:61
itk::Point
A templated class holding a geometric point in n-Dimensional space.
Definition: itkPoint.h:53
itk::MeshSpatialObject::MeshType
TMesh MeshType
Definition: itkMeshSpatialObject.h:50
itk::GTest::TypedefsAndConstructors::Dimension2::Dimension
constexpr unsigned int Dimension
Definition: itkGTestTypedefsAndConstructors.h:44
itk::MeshSpatialObject::ScalarType
double ScalarType
Definition: itkMeshSpatialObject.h:41
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