ITK  5.3.0
Insight Toolkit
itkImageSpatialObject.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  * http://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 itkImageSpatialObject_h
19 #define itkImageSpatialObject_h
20 
21 #include "itkImage.h"
22 #include "itkContinuousIndex.h"
23 #include "itkSpatialObject.h"
25 
26 namespace itk
27 {
39 template <unsigned int TDimension = 3, typename TPixelType = unsigned char>
40 class ITK_TEMPLATE_EXPORT ImageSpatialObject : public SpatialObject<TDimension>
41 {
42 public:
43  ITK_DISALLOW_COPY_AND_MOVE(ImageSpatialObject);
44 
45  using ScalarType = double;
50 
52  using PixelType = TPixelType;
55  using IndexType = typename ImageType::IndexType;
56  using typename Superclass::PointType;
58 
60 
61  static constexpr unsigned int ObjectDimension = TDimension;
62 
64  itkNewMacro(Self);
65 
67  itkTypeMacro(ImageSpatialObject, SpatialObject);
68 
71  void
72  Clear() override;
73 
75  void
76  SetImage(const ImageType * image);
77 
79  const ImageType *
80  GetImage() const;
81 
83  bool
84  IsInsideInObjectSpace(const PointType & point) const override;
85 
86  /* Avoid hiding the overload that supports depth and name arguments */
87  using Superclass::IsInsideInObjectSpace;
88 
91  bool
92  ValueAtInObjectSpace(const PointType & point,
93  double & value,
94  unsigned int depth = 0,
95  const std::string & name = "") const override;
96 
99  GetMTime() const override;
100 
102  itkSetMacro(SliceNumber, IndexType);
103  void
104  SetSliceNumber(unsigned int dimension, int position);
106 
108  itkGetConstMacro(SliceNumber, IndexType);
109  int
110  GetSliceNumber(unsigned int dimension)
111  {
112  return m_SliceNumber[dimension];
113  }
115 
116 #if !defined(ITK_LEGACY_REMOVE)
117  itkLegacyMacro(const char * GetPixelTypeName()) { return m_PixelType.c_str(); }
118 #endif
119 
121  void
122  SetInterpolator(InterpolatorType * interpolator);
123  itkGetConstMacro(Interpolator, InterpolatorType *);
125 
126 protected:
128  void
129  ComputeMyBoundingBox() override;
130 
131  ImageSpatialObject();
132  ~ImageSpatialObject() override;
133 
134  void
135  PrintSelf(std::ostream & os, Indent indent) const override;
136 
137  typename LightObject::Pointer
138  InternalClone() const override;
139 
140 private:
142 
144 
145 #if !defined(ITK_LEGACY_REMOVE)
146  std::string m_PixelType;
147 #endif
148 
150 
151 #if !defined(ITK_LEGACY_REMOVE)
152  template <typename T>
153  void
154  SetPixelTypeName(const T *)
155  {
156  itkWarningMacro("itk::ImageSpatialObject() : PixelType not recognized");
157  }
158 
159  void
160  SetPixelTypeName(const short *)
161  {
162  m_PixelType = "short";
163  }
164 
165  void
166  SetPixelTypeName(const unsigned char *)
167  {
168  m_PixelType = "unsigned char";
169  }
170 
171  void
172  SetPixelTypeName(const unsigned short *)
173  {
174  m_PixelType = "unsigned short";
175  }
176 
177  void
178  SetPixelTypeName(const float *)
179  {
180  m_PixelType = "float";
181  }
182 
183  void
184  SetPixelTypeName(const double *)
185  {
186  m_PixelType = "double";
187  }
188 #endif
189 };
190 } // end of namespace itk
191 
192 #ifndef ITK_MANUAL_INSTANTIATION
193 # include "itkImageSpatialObject.hxx"
194 #endif
195 
196 #endif // itkImageSpatialObject_h
itk::ImageSpatialObject< TDimension, TPixel >::ScalarType
double ScalarType
Definition: itkImageSpatialObject.h:45
itk::ImageSpatialObject::m_Interpolator
InterpolatorType::Pointer m_Interpolator
Definition: itkImageSpatialObject.h:149
itk::ImageSpatialObject::m_SliceNumber
IndexType m_SliceNumber
Definition: itkImageSpatialObject.h:143
itkContinuousIndex.h
itk::ModifiedTimeType
SizeValueType ModifiedTimeType
Definition: itkIntTypes.h:102
itkSpatialObject.h
itk::GTest::TypedefsAndConstructors::Dimension2::PointType
ImageBaseType::PointType PointType
Definition: itkGTestTypedefsAndConstructors.h:51
itk::LightObject::Pointer
SmartPointer< Self > Pointer
Definition: itkLightObject.h:66
itkImage.h
itk::SmartPointer< Self >
itk::ImageSpatialObject
Implementation of an image as spatial object.
Definition: itkImageSpatialObject.h:40
itk::ImageSpatialObject::GetSliceNumber
int GetSliceNumber(unsigned int dimension)
Definition: itkImageSpatialObject.h:110
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
itk::ImageSpatialObject< TDimension, TPixel >::ImagePointer
typename ImageType::ConstPointer ImagePointer
Definition: itkImageSpatialObject.h:54
itk::SpatialObject
Implementation of the composite pattern.
Definition: itkSpatialObject.h:57
itk::ImageSpatialObject< TDimension, TPixel >::PixelType
TPixel PixelType
Definition: itkImageSpatialObject.h:52
itkNearestNeighborInterpolateImageFunction.h
itk::ImageSpatialObject< TDimension, TPixel >::IndexType
typename ImageType::IndexType IndexType
Definition: itkImageSpatialObject.h:55
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ContinuousIndex
A templated class holding a point in n-Dimensional image space.
Definition: itkContinuousIndex.h:46
itk::ImageSpatialObject::m_Image
ImagePointer m_Image
Definition: itkImageSpatialObject.h:141
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:62
itk::Point
A templated class holding a geometric point in n-Dimensional space.
Definition: itkPoint.h:53
itk::Image
Templated n-dimensional image class.
Definition: itkImage.h:88
itk::NearestNeighborInterpolateImageFunction
Nearest neighbor interpolation of a scalar image.
Definition: itkNearestNeighborInterpolateImageFunction.h:39
itk::InterpolateImageFunction
Base class for all image interpolators.
Definition: itkInterpolateImageFunction.h:45
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293