File: RLERegionOfInterestImageFilter.h

package info (click to toggle)
itksnap 3.6.0-5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 22,132 kB
  • sloc: cpp: 91,089; ansic: 1,994; sh: 327; makefile: 16
file content (282 lines) | stat: -rw-r--r-- 12,391 bytes parent folder | download | duplicates (2)
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
#ifndef RLERegionOfInterestImageFilter_h
#define RLERegionOfInterestImageFilter_h

#include "itkImageToImageFilter.h"
#include "itkSmartPointer.h"
#include "itkRegionOfInterestImageFilter.h"
#include "RLEImage.h"

namespace itk
{
/** \class RegionOfInterestImageFilter
 * \brief Extract a region of interest from the input image
 * or convert between itk::Image and RLEImage (a custom region can be used).
 *
 *  This filter produces an output image of the same dimension as the input
 *  image. The user specifies the region of the input image that will be
 *  contained in the output image. The origin coordinates of the output images
 *  will be computed in such a way that if mapped to physical space, the output
 *  image will overlay the input image with perfect registration. In other
 *  words, a registration process between the output image and the input image
 *  will return an identity transform.
 *
 *  The region to extract is set using the method SetRegionOfInterest.
 */
template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class RegionOfInterestImageFilter<RLEImage<TPixel, VImageDimension, CounterType>, RLEImage<TPixel, VImageDimension, CounterType> >:
  public ImageToImageFilter< RLEImage<TPixel, VImageDimension, CounterType>, RLEImage<TPixel, VImageDimension, CounterType> >
{
public:
  /** Standard class typedefs. */
  typedef RegionOfInterestImageFilter                      Self;
  typedef RLEImage<TPixel, VImageDimension, CounterType>   RLEImageType;
  typedef RLEImageType                                     ImageType;
  typedef ImageToImageFilter< RLEImageType, RLEImageType > Superclass;
  typedef SmartPointer< Self >                             Pointer;
  typedef SmartPointer< const Self >                       ConstPointer;
  typedef typename Superclass::InputImageRegionType        InputImageRegionType;

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

  /** Run-time type information (and related methods). */
  itkTypeMacro(RegionOfInterestImageFilter, ImageToImageFilter);

  /** Typedef to describe the input image region types. */
  typedef typename RLEImageType::RegionType RegionType;
  typedef typename RLEImageType::IndexType  IndexType;
  typedef typename RLEImageType::SizeType   SizeType;

  /** Typedef to describe the type of pixel. */
  typedef typename RLEImageType::PixelType OutputImagePixelType;
  typedef typename RLEImageType::PixelType InputImagePixelType;

  /** Set/Get the output image region. */
  itkSetMacro(RegionOfInterest, RegionType);
  itkGetConstMacro(RegionOfInterest, RegionType);

  /** ImageDimension enumeration */
  itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int, VImageDimension);

#ifdef ITK_USE_CONCEPT_CHECKING
  // Begin concept checking
  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< ImageDimension, OutputImageDimension > ) );
  itkConceptMacro( InputConvertibleToOutputCheck,
                   ( Concept::Convertible< InputImagePixelType, OutputImagePixelType > ) );
  // End concept checking
#endif

protected:
  RegionOfInterestImageFilter() {}
  ~RegionOfInterestImageFilter() {}
  void PrintSelf(std::ostream & os, Indent indent) const;

  virtual void GenerateInputRequestedRegion();

  virtual void EnlargeOutputRequestedRegion(DataObject *output);

  /** RegionOfInterestImageFilter can produce an image which is a different
   * size than its input image.  As such, RegionOfInterestImageFilter
   * needs to provide an implementation for
   * GenerateOutputInformation() in order to inform the pipeline
   * execution model.  The original documentation of this method is
   * below.
   *
   * \sa ProcessObject::GenerateOutputInformaton()  */
  virtual void GenerateOutputInformation();

  /** RegionOfInterestImageFilter can be implemented as a multithreaded filter.
   * Therefore, this implementation provides a ThreadedGenerateData()
   * routine which is called for each processing thread. The output
   * image data is allocated automatically by the superclass prior to
   * calling ThreadedGenerateData().  ThreadedGenerateData can only
   * write to the portion of the output image specified by the
   * parameter "outputRegionForThread"
   * \sa ImageToImageFilter::ThreadedGenerateData(),
   *     ImageToImageFilter::GenerateData()  */
  void ThreadedGenerateData(const RegionType & outputRegionForThread,
                            ThreadIdType threadId);

private:
  RegionOfInterestImageFilter(const Self &); //purposely not implemented
  void operator=(const Self &);              //purposely not implemented

  RegionType m_RegionOfInterest;
};

template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class RegionOfInterestImageFilter<Image<TPixel, VImageDimension>, RLEImage<TPixel, VImageDimension, CounterType> > :
    public ImageToImageFilter< Image<TPixel, VImageDimension>, RLEImage<TPixel, VImageDimension, CounterType> >
{
public:
    /** Standard class typedefs. */
    typedef RegionOfInterestImageFilter                    Self;
    typedef RLEImage<TPixel, VImageDimension, CounterType> RLEImageType;
    typedef Image<TPixel, VImageDimension>                 ImageType;
    typedef ImageToImageFilter< ImageType, RLEImageType >  Superclass;
    typedef SmartPointer< Self >                           Pointer;
    typedef SmartPointer< const Self >                     ConstPointer;
    typedef typename Superclass::InputImageRegionType      InputImageRegionType;

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

    /** Run-time type information (and related methods). */
    itkTypeMacro(RegionOfInterestImageFilter, ImageToImageFilter);

    /** Typedef to describe the input image region types. */
    typedef typename RLEImageType::RegionType RegionType;
    typedef typename RLEImageType::IndexType  IndexType;
    typedef typename RLEImageType::SizeType   SizeType;

    /** Typedef to describe the type of pixel. */
    typedef typename RLEImageType::PixelType OutputImagePixelType;
    typedef typename RLEImageType::PixelType InputImagePixelType;

    /** Set/Get the output image region. */
    itkSetMacro(RegionOfInterest, RegionType);
    itkGetConstMacro(RegionOfInterest, RegionType);

    /** ImageDimension enumeration */
    itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
    itkStaticConstMacro(OutputImageDimension, unsigned int, VImageDimension);

#ifdef ITK_USE_CONCEPT_CHECKING
    // Begin concept checking
    itkConceptMacro(SameDimensionCheck,
        (Concept::SameDimension< ImageDimension, OutputImageDimension >));
    itkConceptMacro(InputConvertibleToOutputCheck,
        (Concept::Convertible< InputImagePixelType, OutputImagePixelType >));
    // End concept checking
#endif

protected:
    RegionOfInterestImageFilter() {}
    ~RegionOfInterestImageFilter() {}
    void PrintSelf(std::ostream & os, Indent indent) const;

    virtual void GenerateInputRequestedRegion();

    virtual void EnlargeOutputRequestedRegion(DataObject *output);

    /** RegionOfInterestImageFilter can produce an image which is a different
    * size than its input image.  As such, RegionOfInterestImageFilter
    * needs to provide an implementation for
    * GenerateOutputInformation() in order to inform the pipeline
    * execution model.  The original documentation of this method is
    * below.
    *
    * \sa ProcessObject::GenerateOutputInformaton()  */
    virtual void GenerateOutputInformation();

    /** RegionOfInterestImageFilter can be implemented as a multithreaded filter.
    * Therefore, this implementation provides a ThreadedGenerateData()
    * routine which is called for each processing thread. The output
    * image data is allocated automatically by the superclass prior to
    * calling ThreadedGenerateData().  ThreadedGenerateData can only
    * write to the portion of the output image specified by the
    * parameter "outputRegionForThread"
    * \sa ImageToImageFilter::ThreadedGenerateData(),
    *     ImageToImageFilter::GenerateData()  */
    void ThreadedGenerateData(const RegionType & outputRegionForThread,
        ThreadIdType threadId);

private:
    RegionOfInterestImageFilter(const Self &); //purposely not implemented
    void operator=(const Self &);              //purposely not implemented

    RegionType m_RegionOfInterest;
};

template< typename TPixel, unsigned int VImageDimension, typename CounterType >
class RegionOfInterestImageFilter< RLEImage<TPixel, VImageDimension, CounterType>, Image<TPixel, VImageDimension> > :
    public ImageToImageFilter< RLEImage<TPixel, VImageDimension, CounterType>, Image<TPixel, VImageDimension> >
{
public:
    /** Standard class typedefs. */
    typedef RegionOfInterestImageFilter                     Self;
    typedef RLEImage<TPixel, VImageDimension, CounterType>  RLEImageType;
    typedef Image<TPixel, VImageDimension>                  ImageType;
    typedef ImageToImageFilter< RLEImageType, ImageType >   Superclass;
    typedef SmartPointer< Self >                            Pointer;
    typedef SmartPointer< const Self >                      ConstPointer;
    typedef typename Superclass::InputImageRegionType       InputImageRegionType;

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

    /** Run-time type information (and related methods). */
    itkTypeMacro(RegionOfInterestImageFilter, ImageToImageFilter);

    /** Typedef to describe the input image region types. */
    typedef typename RLEImageType::RegionType RegionType;
    typedef typename RLEImageType::IndexType  IndexType;
    typedef typename RLEImageType::SizeType   SizeType;

    /** Typedef to describe the type of pixel. */
    typedef typename RLEImageType::PixelType OutputImagePixelType;
    typedef typename RLEImageType::PixelType InputImagePixelType;

    /** Set/Get the output image region. */
    itkSetMacro(RegionOfInterest, RegionType);
    itkGetConstMacro(RegionOfInterest, RegionType);

    /** ImageDimension enumeration */
    itkStaticConstMacro(ImageDimension, unsigned int, VImageDimension);
    itkStaticConstMacro(OutputImageDimension, unsigned int, VImageDimension);

#ifdef ITK_USE_CONCEPT_CHECKING
    // Begin concept checking
    itkConceptMacro(SameDimensionCheck,
        (Concept::SameDimension< ImageDimension, OutputImageDimension >));
    itkConceptMacro(InputConvertibleToOutputCheck,
        (Concept::Convertible< InputImagePixelType, OutputImagePixelType >));
    // End concept checking
#endif

protected:
    RegionOfInterestImageFilter() {}
    ~RegionOfInterestImageFilter() {}
    void PrintSelf(std::ostream & os, Indent indent) const;

    virtual void GenerateInputRequestedRegion();

    virtual void EnlargeOutputRequestedRegion(DataObject *output);

    /** RegionOfInterestImageFilter can produce an image which is a different
    * size than its input image.  As such, RegionOfInterestImageFilter
    * needs to provide an implementation for
    * GenerateOutputInformation() in order to inform the pipeline
    * execution model.  The original documentation of this method is
    * below.
    *
    * \sa ProcessObject::GenerateOutputInformaton()  */
    virtual void GenerateOutputInformation();

    /** RegionOfInterestImageFilter can be implemented as a multithreaded filter.
    * Therefore, this implementation provides a ThreadedGenerateData()
    * routine which is called for each processing thread. The output
    * image data is allocated automatically by the superclass prior to
    * calling ThreadedGenerateData().  ThreadedGenerateData can only
    * write to the portion of the output image specified by the
    * parameter "outputRegionForThread"
    * \sa ImageToImageFilter::ThreadedGenerateData(),
    *     ImageToImageFilter::GenerateData()  */
    void ThreadedGenerateData(const RegionType & outputRegionForThread,
        ThreadIdType threadId);

private:
    RegionOfInterestImageFilter(const Self &); //purposely not implemented
    void operator=(const Self &);              //purposely not implemented

    RegionType m_RegionOfInterest;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "RLERegionOfInterestImageFilter.txx"
#endif

#endif //RLERegionOfInterestImageFilter_h