File: itkImageSpatialObject.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (205 lines) | stat: -rw-r--r-- 5,623 bytes parent folder | download
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*=========================================================================
 *
 *  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 itkImageSpatialObject_h
#define itkImageSpatialObject_h

#include "itkImage.h"
#include "itkContinuousIndex.h"
#include "itkSpatialObject.h"
#include "itkNearestNeighborInterpolateImageFunction.h"

namespace itk
{
/**
 * \class ImageSpatialObject
 * \brief Implementation of an image as spatial object.
 *
 * This class combines functionalities from a spatial object,
 * and an image.
 *
 * \sa SpatialObject CompositeSpatialObject
 * \ingroup ITKSpatialObjects
 */

template <unsigned int TDimension = 3, typename TPixelType = unsigned char>
class ITK_TEMPLATE_EXPORT ImageSpatialObject : public SpatialObject<TDimension>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageSpatialObject);

  using ScalarType = double;
  using Self = ImageSpatialObject<TDimension, TPixelType>;
  using Superclass = SpatialObject<TDimension>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  using ContinuousIndexType = ContinuousIndex<double, TDimension>;
  using PixelType = TPixelType;
  using ImageType = Image<PixelType, TDimension>;
  using ImagePointer = typename ImageType::ConstPointer;
  using IndexType = typename ImageType::IndexType;
  using typename Superclass::PointType;
  using InterpolatorType = InterpolateImageFunction<ImageType>;

  using NNInterpolatorType = NearestNeighborInterpolateImageFunction<ImageType>;

  static constexpr unsigned int ObjectDimension = TDimension;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(ImageSpatialObject);

  /** Reset the spatial object to its initial condition, yet preserves
   *   Id, Parent, and Child information */
  void
  Clear() override;

  /** Set the image. */
  void
  SetImage(const ImageType * image);

  /** Get a pointer to the image currently attached to the object. */
  const ImageType *
  GetImage() const;

  /** Returns true if the point is inside, false otherwise. */
  bool
  IsInsideInObjectSpace(const PointType & point) const override;

  /* Avoid hiding the overload that supports depth and name arguments */
  using Superclass::IsInsideInObjectSpace;

  /** Returns the value of the image at the requested point.
   *
   * Returns true if that value is valid.
   *
   * The value returned is always of type double; for RGB Images the value returned is the value of the first channel.
   */
  bool
  ValueAtInObjectSpace(const PointType &   point,
                       double &            value,
                       unsigned int        depth = 0,
                       const std::string & name = "") const override;

  /** Returns the latest modified time of the object and its component. */
  ModifiedTimeType
  GetMTime() const override;

  /** Set the slice position */
  itkSetMacro(SliceNumber, IndexType);
  void
  SetSliceNumber(unsigned int dimension, int position);

  /** Get the slice position */
  itkGetConstMacro(SliceNumber, IndexType);
  int
  GetSliceNumber(unsigned int dimension)
  {
    return m_SliceNumber[dimension];
  }

#if !defined(ITK_LEGACY_REMOVE)
  itkLegacyMacro(const char * GetPixelTypeName()) { return m_PixelType.c_str(); }
#endif

  /** Set/Get the interpolator. */
  void
  SetInterpolator(InterpolatorType * interpolator);
  itkGetConstMacro(Interpolator, InterpolatorType *);

  /** Updates the regions of this spatial object in accordance with its current image, and calls its Superclass. */
  void
  Update() override;

protected:
  /** Compute the boundaries of the image spatial object. */
  void
  ComputeMyBoundingBox() override;

  ImageSpatialObject();
  ~ImageSpatialObject() override;

  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  typename LightObject::Pointer
  InternalClone() const override;

private:
  ImagePointer m_Image{};

  IndexType m_SliceNumber{};

#if !defined(ITK_LEGACY_REMOVE)
  std::string m_PixelType{};
#endif

  typename InterpolatorType::Pointer m_Interpolator{};

  /** Updates the regions of this spatial object in accordance with its current image. */
  void
  UpdateImageRegions();

#if !defined(ITK_LEGACY_REMOVE)
  template <typename T>
  void
  SetPixelTypeName(const T *)
  {
    itkWarningMacro("itk::ImageSpatialObject() : PixelType not recognized");
  }

  void
  SetPixelTypeName(const short *)
  {
    m_PixelType = "short";
  }

  void
  SetPixelTypeName(const unsigned char *)
  {
    m_PixelType = "unsigned char";
  }

  void
  SetPixelTypeName(const unsigned short *)
  {
    m_PixelType = "unsigned short";
  }

  void
  SetPixelTypeName(const float *)
  {
    m_PixelType = "float";
  }

  void
  SetPixelTypeName(const double *)
  {
    m_PixelType = "double";
  }
#endif
};
} // end of namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageSpatialObject.hxx"
#endif

#endif // itkImageSpatialObject_h